Navigation and Viewing Framework
Configurable navigation and viewing setups for various display types in the VR lab
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lib-server.Platform.Platform Class Reference

Internal representation of a platform which is controlled by an input device. More...

Inheritance diagram for lib-server.Platform.Platform:

Public Member Functions

def __init__
 Default constructor. More...
 
def my_constructor
 Custom constructor. More...
 
def display_left_border
 Toggles visibility of left platform border. More...
 
def display_right_border
 Toggles visibility of right platform border. More...
 
def display_front_border
 Toggles visibility of front platform border. More...
 
def display_back_border
 Toggles visibility of back platform border. More...
 
def sf_scale_values_changed
 Scales the platform scale transform node when the scaling changes in the inputmapping. More...
 
def create_coupling_plane
 Creates a plane in front of the user used for displaying coupling messages. More...
 
def create_coupling_status_overview
 Creates an overview of the user's current couplings in his or her field of view. More...
 
def update_coupling_status_overview
 Updates the Transform fields of coupling_status_node's children. More...
 
def handle_message_plane_node
 Correctly places and appends the message plane node in and to the scenegraph. More...
 
def handle_coupling_status_attributes
 Handles all the specialized settings for the coupling status overview. More...
 
def show_coupling_plane
 Displays the coupling plane with the "Coupling" texture. More...
 
def hide_coupling_plane
 Hides the coupling plane. More...
 
def display_coupling
 Displays coupling status notifiers for all navigations in COUPLED_NAVIGATION_LIST. More...
 
def update_nettrans_node
 Updates the nettrans node. More...
 
def remove_from_coupling_display
 Removes a platform indicator from the coupling display and shows a message to all other platforms. More...
 
def evaluate
 Evaluated every frame. More...
 

Public Attributes

 start_clients
 Debug flag saying if client processes should be started. More...
 
 start_time
 Time when a decoupling notifier was displayed. More...
 
 screens
 List of ScreenNode instances which are appended to this platform. More...
 
 NET_TRANS_NODE
 Reference to the net matrix node in the scenegraph for distribution. More...
 
 platform_id
 The id number of this platform, starting from 0. More...
 
 INPUT_MAPPING_INSTANCE
 Reference to an InputMapping which accumulates the device inputs for this platform. More...
 
 width
 Physical width of the platform in meters. More...
 
 depth
 Physical depth of the platform in meters. More...
 
 transmitter_offset
 The transmitter offset to be applied. More...
 
 no_tracking_mat
 The matrix to be applied when no tracking information is available for users. More...
 
 displays
 List of names of the displays that belong to this navigation. More...
 
 avatar_type
 A string that determines what kind of avatar representation is to be used. More...
 
 slot_list
 A list of Slot instances that are associated to this platform. More...
 
 avatar_material
 String containing the material to be used for avatars of this platform. More...
 
 platform_transform_node
 Scenegraph node representing this platform's transformation. More...
 
 platform_scale_transform_node
 
 left_border
 Geometry scenegraph node of the platform's left border. More...
 
 right_border
 Geometry scenegraph node of the platform's left border. More...
 
 front_border
 Geometry scenegraph node of the platform's front border. More...
 
 back_border
 Geometry scenegraph node of the platform's back border. More...
 
 message_plane_node
 Transform node combining coupling and decoupling message geometry nodes. More...
 
 coupling_plane_node
 Geometry node representing a plane for displaying messages to users. More...
 
 decoupling_notifier
 Geometry node representing a plane showing the color of a navigation that was recently decoupled. More...
 
 coupling_status_node
 Scenegraph transformation node for coupling icons in the user's field of view. More...
 
 own_color_geometry
 Plane visible to the user indictating his or her own avatar color. More...
 
 start_trans
 Translation of the first coupling status notifier (own color). More...
 
 start_scale
 Scaling of the first coupling status notifier (own color). More...
 
 y_increment
 Y offset for all coupling status notifiers after the own color. More...
 

Static Public Attributes

tuple sf_abs_mat = avango.gua.SFMatrix4()
 Matrix representing the current translation and rotation of the platform in the scene. More...
 
tuple timer = avango.nodes.TimeSensor()
 A timer instance to get the current time in seconds. More...
 
tuple sf_scale = avango.SFFloat()
 The current scaling factor of this platform. More...
 
list hosts_visited = []
 List of hostnames on which a client daemon was already launched. More...
 

Detailed Description

Internal representation of a platform which is controlled by an input device.

Users can stick themselves to a platform and explore the scene on it.

Constructor & Destructor Documentation

def lib-server.Platform.Platform.__init__ (   self)

Default constructor.

Member Function Documentation

def lib-server.Platform.Platform.create_coupling_plane (   self)

Creates a plane in front of the user used for displaying coupling messages.

def lib-server.Platform.Platform.create_coupling_status_overview (   self)

Creates an overview of the user's current couplings in his or her field of view.

def lib-server.Platform.Platform.display_back_border (   self,
  VISIBLE 
)

Toggles visibility of back platform border.

Parameters
VISIBLEA boolean value if the border should be set visible or not.
def lib-server.Platform.Platform.display_coupling (   self,
  COUPLED_NAVIGATION_LIST 
)

Displays coupling status notifiers for all navigations in COUPLED_NAVIGATION_LIST.

Parameters
COUPLED_NAVIGATION_LISTList of Navigation instances that are now coupled.
def lib-server.Platform.Platform.display_front_border (   self,
  VISIBLE 
)

Toggles visibility of front platform border.

Parameters
VISIBLEA boolean value if the border should be set visible or not.
def lib-server.Platform.Platform.display_left_border (   self,
  VISIBLE 
)

Toggles visibility of left platform border.

Parameters
VISIBLEA boolean value if the border should be set visible or not.
def lib-server.Platform.Platform.display_right_border (   self,
  VISIBLE 
)

Toggles visibility of right platform border.

Parameters
VISIBLEA boolean value if the border should be set visible or not.
def lib-server.Platform.Platform.evaluate (   self)

Evaluated every frame.

def lib-server.Platform.Platform.handle_coupling_status_attributes (   self)

Handles all the specialized settings for the coupling status overview.

def lib-server.Platform.Platform.handle_message_plane_node (   self)

Correctly places and appends the message plane node in and to the scenegraph.

def lib-server.Platform.Platform.hide_coupling_plane (   self)

Hides the coupling plane.

def lib-server.Platform.Platform.my_constructor (   self,
  NET_TRANS_NODE,
  SCENEGRAPH,
  PLATFORM_SIZE,
  INPUT_MAPPING_INSTANCE,
  PLATFORM_ID,
  TRANSMITTER_OFFSET,
  NO_TRACKING_MAT,
  DISPLAYS,
  AVATAR_TYPE,
  SLOT_MANAGER,
  CONFIG_FILE,
  AVATAR_MATERIAL 
)

Custom constructor.

Parameters
NET_TRANS_NODEReference to the net matrix node in the scenegraph for distribution.
SCENEGRAPHReference to the scenegraph.
PLATFORM_SIZEPhysical size of the platform in meters. Passed in an two-element list: [width, depth]
INPUT_MAPPING_INSTANCEAn instance of InputMapping which accumulates the device inputs for this platform.
PLATFORM_IDThe id number assigned to this platform, starting from 0.
TRANSMITTER_OFFSETThe matrix offset that is applied to the values delivered by the tracking system.
NO_TRACKING_MATMatrix which should be applied if no tracking is available.
DISPLAYSThe names of the displays that belong to this navigation.
AVATAR_TYPEA string that determines what kind of avatar representation is to be used ["joseph", "joseph_table", "kinect"].
SLOT_MANAGERReference to the one and only SlotManager instance in the setup.
CONFIG_FILEThe path to the config file that is used.
AVATAR_MATERIALString containing the material to be used for avatars of this platform.
def lib-server.Platform.Platform.remove_from_coupling_display (   self,
  NAVIGATION,
  SHOW_NOTIFICATION 
)

Removes a platform indicator from the coupling display and shows a message to all other platforms.

Parameters
NAVIGATIONThe Navigation instance to be removed from all couplings.
SHOW_NOTIFICATIONBoolean saying if a notification should be displayed to all other platforms involved.
def lib-server.Platform.Platform.sf_scale_values_changed (   self)

Scales the platform scale transform node when the scaling changes in the inputmapping.

def lib-server.Platform.Platform.show_coupling_plane (   self)

Displays the coupling plane with the "Coupling" texture.

def lib-server.Platform.Platform.update_coupling_status_overview (   self)

Updates the Transform fields of coupling_status_node's children.

Can only be called after create_coupling_status_overview()

def lib-server.Platform.Platform.update_nettrans_node (   self,
  NET_TRANS_NODE 
)

Updates the nettrans node.

Used to replace pseudo nettrans.

Parameters
NET_TRANS_NODEThe new nettrans node to be set.

Member Data Documentation

lib-server.Platform.Platform.avatar_material

String containing the material to be used for avatars of this platform.

lib-server.Platform.Platform.avatar_type

A string that determines what kind of avatar representation is to be used.

lib-server.Platform.Platform.back_border

Geometry scenegraph node of the platform's back border.

lib-server.Platform.Platform.coupling_plane_node

Geometry node representing a plane for displaying messages to users.

Visibility will be toggled by StatusManager.

lib-server.Platform.Platform.coupling_status_node

Scenegraph transformation node for coupling icons in the user's field of view.

lib-server.Platform.Platform.decoupling_notifier

Geometry node representing a plane showing the color of a navigation that was recently decoupled.

Actual material and visibility will be toggled by StatusManager.

lib-server.Platform.Platform.depth

Physical depth of the platform in meters.

lib-server.Platform.Platform.displays

List of names of the displays that belong to this navigation.

lib-server.Platform.Platform.front_border

Geometry scenegraph node of the platform's front border.

lib-server.Platform.Platform.hosts_visited = []
static

List of hostnames on which a client daemon was already launched.

Used to avoid double launching.

lib-server.Platform.Platform.INPUT_MAPPING_INSTANCE

Reference to an InputMapping which accumulates the device inputs for this platform.

lib-server.Platform.Platform.left_border

Geometry scenegraph node of the platform's left border.

lib-server.Platform.Platform.message_plane_node

Transform node combining coupling and decoupling message geometry nodes.

lib-server.Platform.Platform.NET_TRANS_NODE

Reference to the net matrix node in the scenegraph for distribution.

lib-server.Platform.Platform.no_tracking_mat

The matrix to be applied when no tracking information is available for users.

lib-server.Platform.Platform.own_color_geometry

Plane visible to the user indictating his or her own avatar color.

lib-server.Platform.Platform.platform_id

The id number of this platform, starting from 0.

lib-server.Platform.Platform.platform_scale_transform_node
lib-server.Platform.Platform.platform_transform_node

Scenegraph node representing this platform's transformation.

lib-server.Platform.Platform.right_border

Geometry scenegraph node of the platform's left border.

lib-server.Platform.Platform.screens

List of ScreenNode instances which are appended to this platform.

lib-server.Platform.Platform.sf_abs_mat = avango.gua.SFMatrix4()
static

Matrix representing the current translation and rotation of the platform in the scene.

lib-server.Platform.Platform.sf_scale = avango.SFFloat()
static

The current scaling factor of this platform.

lib-server.Platform.Platform.slot_list

A list of Slot instances that are associated to this platform.

lib-server.Platform.Platform.start_clients

Debug flag saying if client processes should be started.

lib-server.Platform.Platform.start_scale

Scaling of the first coupling status notifier (own color).

lib-server.Platform.Platform.start_time

Time when a decoupling notifier was displayed.

lib-server.Platform.Platform.start_trans

Translation of the first coupling status notifier (own color).

lib-server.Platform.Platform.timer = avango.nodes.TimeSensor()
static

A timer instance to get the current time in seconds.

lib-server.Platform.Platform.transmitter_offset

The transmitter offset to be applied.

lib-server.Platform.Platform.width

Physical width of the platform in meters.

lib-server.Platform.Platform.y_increment

Y offset for all coupling status notifiers after the own color.


The documentation for this class was generated from the following file: