Class to check whether users on a platform are close to platform borders. More...

Inheritance diagram for lib-server.BorderObserver.BorderObserver:

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

def	my_constructor
	Custom constructor. More...

def	add_user
	Adds a user to the list of observed ones. More...

def	evaluate
	Evaluated every frame. More...

Public Attributes
	PLATFORM_INSTANCE
	Reference to the platform on which the observed users stand. More...

	platform_width
	Physical width of the platform in meters. More...

	platform_depth
	Physical depth of the platform in meters. More...

	checked_borders
	A list of four booleans about which borders of the platform should be observed. More...

	user_list
	A list of users to be observed. More...

Static Public Attributes
float	warning_tolerance = 0.6
	Distance to a border when the warning plane should be displayed. More...

Detailed Description

Class to check whether users on a platform are close to platform borders.

If one of the observed users is close to a platform border, the corresponding border plane is made visible.

Constructor & Destructor Documentation

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

Default constructor.

def lib-server.BorderObserver.BorderObserver.add_user	(	self,
		USER_INSTANCE
	)

Adds a user to the list of observed ones.

Parameters

USER_INSTANCE The user to be added.

def lib-server.BorderObserver.BorderObserver.evaluate ( self )

Evaluated every frame.

def lib-server.BorderObserver.BorderObserver.my_constructor	(	self,
		CHECKED_BORDERS,
		USER_INSTANCE,
		PLATFORM_INSTANCE
	)

Custom constructor.

Parameters

CHECKED_BORDERS	A list of four booleans about which borders of the platform should be observed. [display_left_border, display_right_border, display_front_border, display_back_border]
USER_INSTANCE	The first user to be observed.
PLATFORM_INSTANCE	The platform on which the observed users are.

lib-server.BorderObserver.BorderObserver.checked_borders

A list of four booleans about which borders of the platform should be observed.

[left, right, front, back].

lib-server.BorderObserver.BorderObserver.platform_depth

Physical depth of the platform in meters.

lib-server.BorderObserver.BorderObserver.PLATFORM_INSTANCE

Reference to the platform on which the observed users stand.

lib-server.BorderObserver.BorderObserver.platform_width

Physical width of the platform in meters.

lib-server.BorderObserver.BorderObserver.user_list

A list of users to be observed.

lib-server.BorderObserver.BorderObserver.warning_tolerance = 0.6

static

Distance to a border when the warning plane should be displayed.

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