Base class for the representation of an input device supplying multiple degrees of freedom. More...

Inheritance diagram for lib-server.Device.MultiDofDevice:

Public Member Functions
def	__init__
	Default constructor. More...

def	init_station_tracking
	Initializes a tracking reader for the device's position and rotation. More...

def	filter_channel
	Map an input value to a certain interval. More...

def	set_input_channel_parameters
	Sets given values as input channel filtering parameters. More...

def	add_input_binding
	Adds an input binding to the list of bindings for this device. More...

def	frame_callback
	Callback: evaluated every frame. More...

def	set_x
	Filters and sets the x parameter. More...

def	set_y
	Filters and sets the y parameter. More...

def	set_z
	Filters and sets the z parameter. More...

def	set_rx
	Filters and sets the rx parameter. More...

def	set_ry
	Filters and sets the ry parameter. More...

def	set_rz
	Filters and sets the rz parameter. More...

def	set_w
	Filters and sets the w parameter. More...

def	set_reset_trigger
	Sets the reset trigger. More...

def	set_coupling_trigger
	Sets the coupling trigger. More...

def	set_dof_trigger
	Sets the dof trigger. More...

Public Attributes
	input_bindings
	List of bindings between input values / button values and events. More...

	dofs
	Temporary list of degrees of freedom used for storage before setting mf_dof. More...

	x_parameters
	Filer channel parameters for x. More...

	y_parameters
	Filer channel parameters for y. More...

	z_parameters
	Filer channel parameters for z. More...

	rx_parameters
	Filer channel parameters for rx. More...

	ry_parameters
	Filer channel parameters for ry. More...

	rz_parameters
	Filer channel parameters for rz. More...

	w_parameters
	Filer channel parameters for w. More...

	translation_factor
	Factor to modify the device's translation input. More...

	rotation_factor
	Factor to modify the device's rotation input. More...

	frame_trigger
	Triggers framewise evaluation of frame_callback method. More...

	tracking_reader
	Tracking Reader to process the tracking input of the device. More...

Static Public Attributes
tuple	mf_dof = avango.MFFloat()
	The input values of the input device. More...

tuple	sf_reset_trigger = avango.SFBool()
	Boolean indicating if a reset of the platform is to be triggered. More...

tuple	sf_coupling_trigger = avango.SFBool()
	Boolean indicating if a coupling with other platforms is to be triggered. More...

tuple	sf_dof_trigger = avango.SFBool()
	Boolean indicating if a change of dof mode is to be triggered. More...

tuple	sf_station_mat = avango.gua.SFMatrix4()
	Tracking position and rotation. More...

Detailed Description

Base class for the representation of an input device supplying multiple degrees of freedom.

This class should not be instantiated, but concrete device reading classed will inherit from this one.

Constructor & Destructor Documentation

def lib-server.Device.MultiDofDevice.__init__ ( self )

Default constructor.

Member Function Documentation

def lib-server.Device.MultiDofDevice.add_input_binding	(	self,
		INSTRUCTION
	)

Adds an input binding to the list of bindings for this device.

Parameters

INSTRUCTION The binding in code form to be set.

def lib-server.Device.MultiDofDevice.filter_channel	(	self,
		VALUE,
		OFFSET,
		MIN,
		MAX,
		NEG_THRESHOLD,
		POS_THRESHOLD
	)

Map an input value to a certain interval.

Parameters

VALUE	The value to be mapped.
OFFSET	The offset to be applied to VALUE, MIN and MAX.
MIN	The minimum value of the old interval.
MAX	The maximum value of the old interval.
NEG_THRESHOLD	The negative threshold to be used.
POS_THRESHOLD	The positive threshold to be used.

def lib-server.Device.MultiDofDevice.frame_callback ( self )

Callback: evaluated every frame.

def lib-server.Device.MultiDofDevice.init_station_tracking	(	self,
		TRACKING_TARGET_NAME,
		NO_TRACKING_MAT
	)

Initializes a tracking reader for the device's position and rotation.

Parameters

TRACKING_TARGET_NAME	The tracking name as chosen in daemon, None if no tracking is available.
NO_TRACKING_MAT	Tracking matrix to be used if no tracking is available.

def lib-server.Device.MultiDofDevice.set_coupling_trigger	(	self,
		VALUE
	)

Sets the coupling trigger.

Parameters

VALUE The value to be set.

def lib-server.Device.MultiDofDevice.set_dof_trigger	(	self,
		VALUE
	)

Sets the dof trigger.

Parameters

VALUE The value to be set.

def lib-server.Device.MultiDofDevice.set_input_channel_parameters	(	self,
		INPUT_CHANNEL_PARAMETERS,
		OFFSET,
		MIN,
		MAX,
		NEG_THRESHOLD,
		POS_THRESHOLD
	)

Sets given values as input channel filtering parameters.

Parameters

INPUT_CHANNEL_PARAMETERS	List on which the following values will be set.
OFFSET	The offset to be applied to VALUE, MIN and MAX.
MIN	The minimum value of the old interval.
MAX	The maximum value of the old interval.
NEG_THRESHOLD	The negative threshold to be used.
POS_THRESHOLD	The positive threshold to be used.

def lib-server.Device.MultiDofDevice.set_reset_trigger	(	self,
		VALUE
	)

Sets the reset trigger.

Parameters

VALUE The value to be set.

def lib-server.Device.MultiDofDevice.set_rx	(	self,
		VALUE
	)

Filters and sets the rx parameter.

Parameters

VALUE The value to be set.

def lib-server.Device.MultiDofDevice.set_ry	(	self,
		VALUE
	)

Filters and sets the ry parameter.

Parameters

VALUE The value to be set.

def lib-server.Device.MultiDofDevice.set_rz	(	self,
		VALUE
	)

Filters and sets the rz parameter.

Parameters

VALUE The value to be set.

def lib-server.Device.MultiDofDevice.set_w	(	self,
		VALUE
	)

Filters and sets the w parameter.

Parameters

VALUE The value to be set.

def lib-server.Device.MultiDofDevice.set_x	(	self,
		VALUE
	)

Filters and sets the x parameter.

Parameters

VALUE The value to be set.

def lib-server.Device.MultiDofDevice.set_y	(	self,
		VALUE
	)

Filters and sets the y parameter.

Parameters

VALUE The value to be set.

def lib-server.Device.MultiDofDevice.set_z	(	self,
		VALUE
	)

Filters and sets the z parameter.

Parameters

VALUE The value to be set.

Member Data Documentation

lib-server.Device.MultiDofDevice.dofs

Temporary list of degrees of freedom used for storage before setting mf_dof.

lib-server.Device.MultiDofDevice.frame_trigger

Triggers framewise evaluation of frame_callback method.

lib-server.Device.MultiDofDevice.input_bindings

List of bindings between input values / button values and events.

Code form.

lib-server.Device.MultiDofDevice.mf_dof = avango.MFFloat()

static

The input values of the input device.

lib-server.Device.MultiDofDevice.rotation_factor

Factor to modify the device's rotation input.

lib-server.Device.MultiDofDevice.rx_parameters

Filer channel parameters for rx.

lib-server.Device.MultiDofDevice.ry_parameters

Filer channel parameters for ry.

lib-server.Device.MultiDofDevice.rz_parameters

Filer channel parameters for rz.

lib-server.Device.MultiDofDevice.sf_coupling_trigger = avango.SFBool()

static

Boolean indicating if a coupling with other platforms is to be triggered.

lib-server.Device.MultiDofDevice.sf_dof_trigger = avango.SFBool()

static

Boolean indicating if a change of dof mode is to be triggered.

lib-server.Device.MultiDofDevice.sf_reset_trigger = avango.SFBool()

static

Boolean indicating if a reset of the platform is to be triggered.

lib-server.Device.MultiDofDevice.sf_station_mat = avango.gua.SFMatrix4()

static

Tracking position and rotation.

lib-server.Device.MultiDofDevice.tracking_reader

Tracking Reader to process the tracking input of the device.

lib-server.Device.MultiDofDevice.translation_factor

Factor to modify the device's translation input.

lib-server.Device.MultiDofDevice.w_parameters

Filer channel parameters for w.

lib-server.Device.MultiDofDevice.x_parameters

Filer channel parameters for x.

lib-server.Device.MultiDofDevice.y_parameters

Filer channel parameters for y.

lib-server.Device.MultiDofDevice.z_parameters

Filer channel parameters for z.

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

lib-server/Device.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation