lib-server.User.User Class Reference

Internal representation of a user. More...

Inheritance diagram for lib-server.User.User:

Public Member Functions
def	__init__
	Default constructor. More...
def	my_constructor
	Custom constructor. More...
def	evaluate
	Evaluated every frame. More...
def	toggle_user_activity
	Sets the user's active flag. More...
def	set_user_location
	Changes the user's current platform. More...
def	append_to_platform
	Appends a node to the children of a platform in the scenegraph. More...
def	remove_from_platform
	Removes a node from the children of a platform in the scenegraph. More...
def	create_avatar_representation
	Creates a basic "joseph" avatar for this user. More...

Public Attributes
	is_vip
	Boolean indicating if this user has vip status. More...
	is_active
	Boolean indicating if this user is currently active. More...
	APPLICATION_MANAGER
	Reference to the ApplicationManager instance from which the user is created. More...
	id
	Identification number of the user, starting from 0. More...
	platform_id
	ID of the platform the user is belonging to. More...
	platform
	Instance of the platform the user is belonging to. More...
	current_display
	Display instance on which the user physically is currently looking at. More...
	transmitter_offset
	The transmitter offset to be applied. More...
	no_tracking_mat
	The matrix to be applied when no tracking is available. More...
	avatar_material
	Material of the user's avatar. More...
	headtracking_target_name
	Name of the headtracking station as registered in daemon. More...
	glasses_id
	ID of the shutter glasses worn by the user. More...
	headtracking_reader
	Instance of a child class of TrackingReader to supply translation input. More...
	head_avatar
	Scenegraph node representing the geometry and transformation of the basic avatar's head. More...
	body_avatar
	Scenegraph node representing the geometry and transformation of the basic avatar's body. More...

Detailed Description

Internal representation of a user.

Upon construction, this class appends the necessary nodes to the scenegraph, creates eyes and initializes the headtracking.

Constructor & Destructor Documentation

def lib-server.User.User.__init__

(

self

)

Default constructor.

Member Function Documentation

def lib-server.User.User.append_to_platform	(		self,
			NODE
	)

Appends a node to the children of a platform in the scenegraph.

Parameters

NODE	The node to be appended to the platform node.

def lib-server.User.User.create_avatar_representation	(		self,
			SF_AVATAR_HEAD_MATRIX,
			SF_AVATAR_BODY_MATRIX
	)

Creates a basic "joseph" avatar for this user.

Parameters

SF_AVATAR_HEAD_MATRIX	Field containing the transformation matrix for the avatar's head on the platform.
SF_AVATAR_BODY_MATRIX	Field containing the transformation matrix for the avatar's body on the platform.

def lib-server.User.User.evaluate

(

self

)

Evaluated every frame.

def lib-server.User.User.my_constructor	(		self,
			APPLICATION_MANAGER,
			USER_ID,
			VIP,
			GLASSES_ID,
			HEADTRACKING_TARGET_NAME,
			PLATFORM_ID,
			AVATAR_MATERIAL
	)

Custom constructor.

Parameters

APPLICATION_MANAGER	Reference to the ApplicationManager instance from which this user is created.
USER_ID	Global user ID to be applied.
VIP	Boolean indicating if the user to be created is a vip.
GLASSES_ID	ID of the shutter glasses worn by the user.
HEADTRACKING_TARGET_NAME	Name of the headtracking station as registered in daemon.
PLATFORM_ID	Platform ID to which this user should be appended to.
AVATAR_MATERIAL	The material string for the user avatar to be created.

def lib-server.User.User.remove_from_platform	(		self,
			NODE
	)

Removes a node from the children of a platform in the scenegraph.

Parameters

NODE	The node to be removed from the platform node.

def lib-server.User.User.set_user_location	(		self,
			PLATFORM_ID,
			RESEND_CONFIG
	)

Changes the user's current platform.

Parameters

PLATFORM_ID	The new platform id to be set.
RESEND_CONFIG	Boolean indicating if the shutter configuration should be directly resent.

def lib-server.User.User.toggle_user_activity	(		self,
			ACTIVE,
			RESEND_CONFIG
	)

Sets the user's active flag.

Parameters

ACTIVE	Boolean to which the active flag should be set.
RESEND_CONFIG	Boolean indicating if the shutter configuration should be directly resent.

Member Data Documentation

lib-server.User.User.APPLICATION_MANAGER

Reference to the ApplicationManager instance from which the user is created.

lib-server.User.User.avatar_material

Material of the user's avatar.

lib-server.User.User.body_avatar

Scenegraph node representing the geometry and transformation of the basic avatar's body.

lib-server.User.User.current_display

Display instance on which the user physically is currently looking at.

lib-server.User.User.glasses_id

ID of the shutter glasses worn by the user.

Used for frequency updates.

lib-server.User.User.head_avatar

Scenegraph node representing the geometry and transformation of the basic avatar's head.

lib-server.User.User.headtracking_reader

Instance of a child class of TrackingReader to supply translation input.

lib-server.User.User.headtracking_target_name

Name of the headtracking station as registered in daemon.

lib-server.User.User.id

Identification number of the user, starting from 0.

lib-server.User.User.is_active

Boolean indicating if this user is currently active.

lib-server.User.User.is_vip

Boolean indicating if this user has vip status.

lib-server.User.User.no_tracking_mat

The matrix to be applied when no tracking is available.

lib-server.User.User.platform

Instance of the platform the user is belonging to.

lib-server.User.User.platform_id

ID of the platform the user is belonging to.

lib-server.User.User.transmitter_offset

The transmitter offset to be applied.

---

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

• lib-server/User.py