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

IntegerTrigger handles single field Boolean events to set an integer value for the output event. More...

#include <H3D/IntegerTrigger.h>

Inheritance diagram for H3D::IntegerTrigger:
Inheritance graph

Classes

class  SetTriggerValue
 The SetTriggerValue class is specialize to set the vaule of the triggerValue field to the value of the field integerKey. More...
 

Public Member Functions

 IntegerTrigger (Inst< SFNode > _metadata=0, Inst< SFBool > _set_boolean=0, Inst< SFInt32 > _integerKey=0, Inst< SetTriggerValue > _triggerValue=0)
 Constructor.
 
- Public Member Functions inherited from H3D::X3DTriggerNode
 X3DTriggerNode (Inst< SFNode > _metadata=0)
 Constructor.
 
- Public Member Functions inherited from H3D::X3DChildNode
 X3DChildNode (Inst< SFNode > _metadata=0)
 Constructor.
 
- 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 string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. 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< SFBoolset_boolean
 When an event is recieved generate triggerValue event with current value of integerKey. More...
 
H3DUniquePtr< SFInt32integerKey
 Contains the value triggerValue will be set to. More...
 
H3DUniquePtr< SetTriggerValuetriggerValue
 TriggerValue will be set if a set_boolean event is recieved. More...
 
- 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::X3DTriggerNode
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

IntegerTrigger handles single field Boolean events to set an integer value for the output event.

Upon receiving a set_boolean event, the IntegerTrigger node will generate a triggerValue event with the current value of integerKey. This is useful for connecting environmental events to the Switch node's whichChoice.

Examples:

Internal routes:

Member Data Documentation

◆ integerKey

H3DUniquePtr< SFInt32 > H3D::IntegerTrigger::integerKey

Contains the value triggerValue will be set to.

Access type: inputOutput

Referenced by IntegerTrigger().

◆ set_boolean

H3DUniquePtr< SFBool > H3D::IntegerTrigger::set_boolean

When an event is recieved generate triggerValue event with current value of integerKey.

Access type: inputOnly

Referenced by IntegerTrigger().

◆ triggerValue

H3DUniquePtr< SetTriggerValue > H3D::IntegerTrigger::triggerValue

TriggerValue will be set if a set_boolean event is recieved.

Access type: outputOnly

Referenced by IntegerTrigger().


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