lib-server.GroundFollowing.GroundFollowing Class Reference

Class to realize a simple ground following method. More...

Inheritance diagram for lib-server.GroundFollowing.GroundFollowing:

Public Member Functions
def	__init__
	Default constructor. More...
def	my_constructor
	Custom constructor. More...
def	evaluate
	Evaluated every frame. More...
def	activate
	Activates the ground following algorithm. More...
def	deactivate
	Deactivates the ground following algorithm. More...

Public Attributes
	activated
	Indicates if the ground following algorithm is activated or deactivated. More...
	falling
	A boolean indicating if the user is currently falling. More...
	initial_fall_velocity
	The starting velocity when the user is falling in meters per frame. More...
	height_modification_factor
	Scaling factor used for the modification of up and down vectors. More...
	fall_velocity
	Speed when the user is falling in meters per frame. More...
	ground_pick_length
	Length of the ground following ray. More...
	ground_pick_direction
	Direction of the ground following ray (downwards). More...
	SCENEGRAPH
	Reference to the scenegraph to intersect the ground following ray with. More...
	ray_start_height
	Starting height of the ground following ray. More...
	ground_intersection
	Intersection class to determine the intersections of the ground following ray with the objects in the scenegraph. More...

Static Public Attributes
tuple	sf_abs_input_mat = avango.gua.SFMatrix4()
	The input matrix to be corrected by the ground following algorithm. More...
tuple	sf_abs_output_mat = avango.gua.SFMatrix4()
	The corrected matrix after the ground following algorithm was applied. More...
tuple	sf_gf_start_mat = avango.gua.SFMatrix4()
	The matrix representing the position where the sent ray to the ground starts. More...
tuple	sf_station_mat = avango.gua.SFMatrix4()
	The matrix representing the position of the device belonging to the platform. More...
tuple	sf_scale = avango.SFFloat()
tuple	mf_ground_pick_result = avango.gua.MFPickResult()
	Intersections of the ground following ray with the objects in the scene. More...

Detailed Description

Class to realize a simple ground following method.

This class takes a matrix as an input and corrects it with respect to gravity using the scenegraph. Therefore, a ray is shot from a specific start height downwards and the intersection point is compared to the position of the device belonging to the platform.

Constructor & Destructor Documentation

def lib-server.GroundFollowing.GroundFollowing.__init__

(

self

)

Default constructor.

Member Function Documentation

def lib-server.GroundFollowing.GroundFollowing.activate

(

self

)

Activates the ground following algorithm.

def lib-server.GroundFollowing.GroundFollowing.deactivate

(

self

)

Deactivates the ground following algorithm.

The input matrix is just passed through after calling this method.

def lib-server.GroundFollowing.GroundFollowing.evaluate

(

self

)

Evaluated every frame.

def lib-server.GroundFollowing.GroundFollowing.my_constructor	(		self,
			SCENEGRAPH,
			SF_STATION_MAT,
			RAY_START_HEIGHT
	)

Custom constructor.

Parameters

SCENEGRAPH	Reference to the scenegraph of the currently displayed scene.
SF_STATION_MAT	The field containing the current position of the device belonging to the platform.
RAY_START_HEIGHT	A height from which the ground following ray will originate.

Member Data Documentation

lib-server.GroundFollowing.GroundFollowing.activated

Indicates if the ground following algorithm is activated or deactivated.

In the last case, the input matrix is simply passed through.

lib-server.GroundFollowing.GroundFollowing.fall_velocity

Speed when the user is falling in meters per frame.

lib-server.GroundFollowing.GroundFollowing.falling

A boolean indicating if the user is currently falling.

Used for fall speed computations.

lib-server.GroundFollowing.GroundFollowing.ground_intersection

Intersection class to determine the intersections of the ground following ray with the objects in the scenegraph.

lib-server.GroundFollowing.GroundFollowing.ground_pick_direction

Direction of the ground following ray (downwards).

lib-server.GroundFollowing.GroundFollowing.ground_pick_length

Length of the ground following ray.

lib-server.GroundFollowing.GroundFollowing.height_modification_factor

Scaling factor used for the modification of up and down vectors.

lib-server.GroundFollowing.GroundFollowing.initial_fall_velocity

The starting velocity when the user is falling in meters per frame.

Is increased the longer the falling process goes on.

lib-server.GroundFollowing.GroundFollowing.mf_ground_pick_result = avango.gua.MFPickResult()

static

Intersections of the ground following ray with the objects in the scene.

lib-server.GroundFollowing.GroundFollowing.ray_start_height

Starting height of the ground following ray.

lib-server.GroundFollowing.GroundFollowing.SCENEGRAPH

Reference to the scenegraph to intersect the ground following ray with.

lib-server.GroundFollowing.GroundFollowing.sf_abs_input_mat = avango.gua.SFMatrix4()

static

The input matrix to be corrected by the ground following algorithm.

lib-server.GroundFollowing.GroundFollowing.sf_abs_output_mat = avango.gua.SFMatrix4()

static

The corrected matrix after the ground following algorithm was applied.

lib-server.GroundFollowing.GroundFollowing.sf_gf_start_mat = avango.gua.SFMatrix4()

static

The matrix representing the position where the sent ray to the ground starts.

tuple lib-server.GroundFollowing.GroundFollowing.sf_scale = avango.SFFloat()

static

lib-server.GroundFollowing.GroundFollowing.sf_station_mat = avango.gua.SFMatrix4()

static

The matrix representing the position of the device belonging to the platform.

---

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

• lib-server/GroundFollowing.py