H3D API  2.4.1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
H3D::CollisionOptions Class Reference

Options related to collision in H3DAPI. More...

#include <H3D/CollisionOptions.h>

Inheritance diagram for H3D::CollisionOptions:
Inheritance graph

Public Member Functions

 CollisionOptions (Inst< SFNode > _metadata=0, Inst< SFBool > _avatarCollision=0, Inst< SFBool > _sensorCollideToggleGraphicsOff=0, Inst< SFBool > _sensorCollideCollisionFalse=0)
 Constructor.
 
- Public Member Functions inherited from H3D::H3DOptionNode
 H3DOptionNode (Inst< SFNode > _metadata=0)
 Constructor.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
- Public Member Functions inherited from H3D::X3DNode
 X3DNode (Inst< SFNode > _metadata=0)
 Constructor.
 
X3DMetadataObjectgetMetadataByName (const string &_name)
 Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More...
 
- Public Member Functions inherited from H3D::Node
 Node ()
 Constructor.
 
virtual Nodeclone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
 Returns a new instance of this node type with the same state as this one. More...
 
virtual ~Node ()
 Destructor.
 
X3DPrototypeInstancegetProtoInstanceParent ()
 If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...
 
void setProtoInstanceParent (X3DPrototypeInstance *p)
 Set the X3DPrototypeInstance this node is the the root node if applicaple.
 
virtual void render ()
 the render() function is used for the depth-first rendering traversal of the scene-graph. More...
 
virtual void traverseSG (TraverseInfo &ti)
 traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More...
 
virtual bool lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
 Detect intersection between a line segment and the Node. More...
 
virtual void closestPoint (const Vec3f &p, NodeIntersectResult &result)
 Find closest point on Node to p. More...
 
virtual bool movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
 Detect collision between a moving sphere and the Node. More...
 
virtual FieldgetField (const string &_name) const
 return a pointer to the field specified by name within this instance
 
int addDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 
int removeDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 

Public Attributes

H3DUniquePtr< SFBoolavatarCollision
 The avatarCollision field specifies whether collision between the avatar and the world should be done. More...
 
H3DUniquePtr< SFBoolsensorCollideToggleGraphicsOff
 The sensorCollideInvisible field specifies whether X3DPointingDeviceSensors should consider ToggleGroups with graphicsOn set to false. More...
 
H3DUniquePtr< SFBoolsensorCollideCollisionFalse
 The sensorCollideCollisionFalse field specifies whether X3DPointingDeviceSensors should consider Collision nodes with enabled set to false. More...
 
- Public Attributes inherited from H3D::H3DOptionNode
H3DUniquePtr< FieldupdateOption
 Field to collect update event from every option parameters, all inherited Option Node should route its option parameter fields to it.
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. More...
 

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 
- Static Public Attributes inherited from H3D::X3DNode
static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 

Additional Inherited Members

- Public Types inherited from H3D::Node
typedef std::map< Node *, Node * > DeepCopyMap
 A map type used during a deep copy clone() to map from original nodes to cloned nodes.
 
- Static Public Member Functions inherited from H3D::Node
static unsigned int nrNodesAlive ()
 Returns the nr of nodes currently alive, i.e. nodes created but not destructed.
 
static int nrNodesCreated ()
 Returns the number of nodes created in total since the start of the program.
 
- Protected Member Functions inherited from H3D::Node
void cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for the clone() method. More...
 
- Static Protected Member Functions inherited from H3D::Node
static NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

Options related to collision in H3DAPI.

Collision may refer to collision between the avatar in the scene or actions by the users such as trying to select objects with a pointing device sensor.

Examples:

Member Data Documentation

◆ avatarCollision

H3DUniquePtr< SFBool > H3D::CollisionOptions::avatarCollision

The avatarCollision field specifies whether collision between the avatar and the world should be done.

If false then it is possible to always navigate through every object in the scene. Setting this option to false will increase rendering performance but will also shut off the functionality of the Collision node (at least at the moment).

Default value: true
Access type: inputOutput

Referenced by CollisionOptions(), and H3D::H3DWindowNode::render().

◆ sensorCollideCollisionFalse

H3DUniquePtr< SFBool > H3D::CollisionOptions::sensorCollideCollisionFalse

The sensorCollideCollisionFalse field specifies whether X3DPointingDeviceSensors should consider Collision nodes with enabled set to false.

The default value is true for the behaviour to be backwards compatible.

Default value: true
Access type: inputOutput

Referenced by CollisionOptions(), and H3D::X3DPointingDeviceSensorNode::updateX3DPointingDeviceSensors().

◆ sensorCollideToggleGraphicsOff

H3DUniquePtr< SFBool > H3D::CollisionOptions::sensorCollideToggleGraphicsOff

The sensorCollideInvisible field specifies whether X3DPointingDeviceSensors should consider ToggleGroups with graphicsOn set to false.

The default value is true for the behaviour to be backwards compatible.

Default value: true
Access type: inputOutput

Referenced by CollisionOptions(), and H3D::X3DPointingDeviceSensorNode::updateX3DPointingDeviceSensors().


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