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 | List of all members
lib-server.Display.Display Class Reference

Class representing a display. More...

Public Member Functions

def __init__
 Custom constructor. More...
 
def register_view
 Registers a new view at this display and returns the display string assigned to the new view. More...
 
def create_screen_node
 Creates the screen node of this display to be appended to the Platform transformation node. More...
 
def get_shutter_mode
 Returns the shutter mode according to the shutter timings set. More...
 
def create_screen_visualization
 Creates a visualization of the display's screen in the scene (white frame). More...
 

Public Attributes

 hostname
 The hostname to which this display is connected to. More...
 
 name
 A name to be associated to that display. More...
 
 resolution
 The display's resolution to be used. More...
 
 displaystrings
 A list of strings on which the windows for each user will pop up. More...
 
 shutter_timings
 A list of lists of opening and closing times of shutter glasses for each displaystring. More...
 
 shutter_values
 A list of lists of hexadecimal commands for shutter glasses associated with the timings for each displaystring. More...
 
 size
 A list of strings on which the windows for each user will pop up. More...
 
 transformation
 A matrix specifying the display's transformation with respect to the platform coordinate system. More...
 
 num_views
 Number of views which are already registered with this display. More...
 
 stereomode
 A string indicating the stereo mode that is used by this display. More...
 

Detailed Description

Class representing a display.

A display is a physical projection medium running on a host and having certain resolution, size and transformation. It supports a specific amount of users. In the Platform class, a screen node is associated for each display.

Constructor & Destructor Documentation

def lib-server.Display.Display.__init__ (   self,
  hostname,
  name = None,
  resolution = (2560, 1440,
  displaystrings = [":0.0"],
  shutter_timings = [],
  shutter_values = [],
  size = (0.595, 0.335,
  transformation = avango.gua.make_trans_mat(0.0, 1.2,
  stereomode = "ANAGLYPH_RED_CYAN" 
)

Custom constructor.

Parameters
hostnameThe hostname to which this display is connected to.
nameA name to be associated to that display. Will be used in XML configuration file.
resolutionThe display's resolution to be used.
displaystringsA list of strings on which the windows for each user will pop up.
shutter_timingsA list of lists of opening and closing times of shutter glasses for each displaystring.
shutter_valuesA list of lists of hexadecimal commands for shutter glasses associated with the timings for each displaystring.
sizePhysical size of the display medium in meters.
transformationA matrix specifying the display's transformation with respect to the platform coordinate system.
stereomodeA string indicating the stereo mode that is used by this display.

Member Function Documentation

def lib-server.Display.Display.create_screen_node (   self,
  name = "screen_node" 
)

Creates the screen node of this display to be appended to the Platform transformation node.

Parameters
nameThe name of the screen scenegraph node.
def lib-server.Display.Display.create_screen_visualization (   self)

Creates a visualization of the display's screen in the scene (white frame).

Returns the scenegraph geometry node.

def lib-server.Display.Display.get_shutter_mode (   self)

Returns the shutter mode according to the shutter timings set.

Can be ACTIVE_STEREO, PASSIVE_STEREO or NONE.

def lib-server.Display.Display.register_view (   self)

Registers a new view at this display and returns the display string assigned to the new view.

Member Data Documentation

lib-server.Display.Display.displaystrings

A list of strings on which the windows for each user will pop up.

lib-server.Display.Display.hostname

The hostname to which this display is connected to.

lib-server.Display.Display.name

A name to be associated to that display.

Will be used in XML configuration file.

lib-server.Display.Display.num_views

Number of views which are already registered with this display.

lib-server.Display.Display.resolution

The display's resolution to be used.

lib-server.Display.Display.shutter_timings

A list of lists of opening and closing times of shutter glasses for each displaystring.

lib-server.Display.Display.shutter_values

A list of lists of hexadecimal commands for shutter glasses associated with the timings for each displaystring.

lib-server.Display.Display.size

A list of strings on which the windows for each user will pop up.

lib-server.Display.Display.stereomode

A string indicating the stereo mode that is used by this display.

lib-server.Display.Display.transformation

A matrix specifying the display's transformation with respect to the platform coordinate system.


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