BooleanFilter filters boolean events, allowing for selective routing of TRUE or FALSE values and negation. More...
#include <H3D/BooleanFilter.h>
Inheritance diagram for H3D::BooleanFilter:
Classes | |
| class | NegateSFBool |
| This field class takes as input SFBool fields and sets its value to the negated value of the input field. More... | |
| class | SetBoolean |
| The SetBoolean class is specialize to set the value of either the inputTrue or inputFalse field in the BooleanFilter node it resides in, depending on the value that is is given. More... | |
Public Member Functions | |
| BooleanFilter (Inst< SFNode > _metadata=0, Inst< SetBoolean > _set_boolean=0, Inst< SFBool > _inputFalse=0, Inst< NegateSFBool > _inputNegate=0, Inst< SFBool > _inputTrue=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. | |
| X3DMetadataObject * | getMetadataByName (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 Node * | clone (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. | |
| X3DPrototypeInstance * | getProtoInstanceParent () |
| 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 Field * | getField (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< SetBoolean > | set_boolean |
| The boolean field to filter. More... | |
| H3DUniquePtr< SFBool > | inputFalse |
| Generates an FALSE event if the set_boolean value is set to FALSE. More... | |
| H3DUniquePtr< NegateSFBool > | inputNegate |
| This field contains the negation of the set_boolean field. More... | |
| H3DUniquePtr< SFBool > | inputTrue |
| Generates an TRUE event if the set_boolean value is set to TRUE. More... | |
| Public Attributes inherited from H3D::X3DNode | |
| H3DUniquePtr< SFNode > | metadata |
| 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 Node * | getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for nodes that implement clone() More... | |
Detailed Description
BooleanFilter filters boolean events, allowing for selective routing of TRUE or FALSE values and negation.
When the set_boolean event is received, the BooleanFilter node generates two events: either inputTrue or inputFalse, based on the boolean value received; and inputNegate, which contains the negation of the value received.
Examples:
- Internal routes:
Member Data Documentation
◆ inputFalse
| H3DUniquePtr< SFBool > H3D::BooleanFilter::inputFalse |
Generates an FALSE event if the set_boolean value is set to FALSE.
Access type: outputOnly
Referenced by H3D::BooleanFilter::SetBoolean::setValue(), and H3D::BooleanFilter::SetBoolean::update().
◆ inputNegate
| H3DUniquePtr< NegateSFBool > H3D::BooleanFilter::inputNegate |
This field contains the negation of the set_boolean field.
Access type: outputOnly
Referenced by BooleanFilter().
◆ inputTrue
| H3DUniquePtr< SFBool > H3D::BooleanFilter::inputTrue |
Generates an TRUE event if the set_boolean value is set to TRUE.
Access type: outputOnly
Referenced by H3D::BooleanFilter::SetBoolean::setValue(), and H3D::BooleanFilter::SetBoolean::update().
◆ set_boolean
| H3DUniquePtr< SetBoolean > H3D::BooleanFilter::set_boolean |
The documentation for this class was generated from the following files:
