vrecko
virtual reality framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
vrecko::CollisionParams__ver1 Class Reference

Parameters for the SP_SceneInterface::getCollisions() method. More...

#include <SP_CommonDefs.h>

Public Member Functions

 CollisionParams__ver1 ()
 
virtual bool isSame (const CollisionParams__ver1 *other) const
 

Public Attributes

unsigned long dwStructureVersion
 version of this structure. It is filled automatically in the constructor. More...
 
int preferredSceneInterface
 which scene partitioning interface to use (is set to PARTITIONING_INTERFACE_DEFAULT in constructor) More...
 
int preferredObjectInterface
 which object partitioning interface to use (is set to PARTITIONING_INTERFACE_DEFAULT in constructor) More...
 
unsigned long dwFlags
 
float maxCollisionDistance
 
osg::Vec3 rayStart
 
osg::Vec3 rayEnd
 
DynamicArray< unsigned long > ignoredObjects
 Objects that are ignored during the collision tests (if they are not enforced in getCollisions() parameters [limitToEO1] or [limitToEO2]) More...
 
unsigned int bgThreadAffinityMask
 
unsigned long debugGlobalUpdatesCounter
 debug variable to count the number of global updates More...
 
SP_SceneInterfacescIntPtr
 internal usage (cache): Pointer to the scene interface retrieved using the [preferrefSceneInterface] id. More...
 
SP_ObjectInterfaceobjIntPtr
 internal usage (cache): Pointer to the object interface retrieved using the [preferrefObjectInterface] id. More...
 

Detailed Description

Parameters for the SP_SceneInterface::getCollisions() method.

Constructor & Destructor Documentation

vrecko::CollisionParams__ver1::CollisionParams__ver1 ( )
inline

Member Function Documentation

COLL_VRECKO_EXPORT bool vrecko::CollisionParams__ver1::isSame ( const CollisionParams__ver1 other) const
virtual

Member Data Documentation

unsigned int vrecko::CollisionParams__ver1::bgThreadAffinityMask

Optional and only useful if COLLISION_FLAGS_RUN_IN_BACKGROUND is specified in [dwFlags]. Can set the affinity of the background thread, thus forcing it to run on the specified processor(s). By default it can run on any processor and can switch processors as needed (will be decided by the operating system).

unsigned long vrecko::CollisionParams__ver1::debugGlobalUpdatesCounter

debug variable to count the number of global updates

unsigned long vrecko::CollisionParams__ver1::dwFlags

A combination of COLLISION_FLAGS_* constants. Defines the behaviour of the getCollisions() method

unsigned long vrecko::CollisionParams__ver1::dwStructureVersion

version of this structure. It is filled automatically in the constructor.

DynamicArray<unsigned long> vrecko::CollisionParams__ver1::ignoredObjects

Objects that are ignored during the collision tests (if they are not enforced in getCollisions() parameters [limitToEO1] or [limitToEO2])

float vrecko::CollisionParams__ver1::maxCollisionDistance

If == 0.0 then only contact points are returned. If > 0.0 then also soon-to-be collisions are included in the output. If == FLT_MAX then meaning is similar to > 0.0, but also no distance tests are made. (i.e. it is assumed that any pair can satisfy this condition)

SP_ObjectInterface* vrecko::CollisionParams__ver1::objIntPtr

internal usage (cache): Pointer to the object interface retrieved using the [preferrefObjectInterface] id.

int vrecko::CollisionParams__ver1::preferredObjectInterface

which object partitioning interface to use (is set to PARTITIONING_INTERFACE_DEFAULT in constructor)

int vrecko::CollisionParams__ver1::preferredSceneInterface

which scene partitioning interface to use (is set to PARTITIONING_INTERFACE_DEFAULT in constructor)

osg::Vec3 vrecko::CollisionParams__ver1::rayEnd
osg::Vec3 vrecko::CollisionParams__ver1::rayStart

If dwFlags includes COLLISION_FLAGS_RAYCASTING then these variables specify the ray start and end positions. (The ray is not infinite, it ends in the [rayEnd])

SP_SceneInterface* vrecko::CollisionParams__ver1::scIntPtr

internal usage (cache): Pointer to the scene interface retrieved using the [preferrefSceneInterface] id.


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