H3D::BooleanFilter Class Reference
[X3D node classes.]

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:

Inheritance graph

List of all members.

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 Attributes

auto_ptr< SetBooleanset_boolean
 The boolean field to filter.
auto_ptr< SFBoolinputFalse
 Generates an FALSE event if the set_boolean value is set to FALSE.
auto_ptr< NegateSFBoolinputNegate
 This field contains the negation of the set_boolean field.
auto_ptr< SFBoolinputTrue
 Generates an TRUE event if the set_boolean value is set to TRUE.

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodedatabase for this node.


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.

Internal routes:
BooleanFilter.dot

Member Data Documentation

Generates an FALSE event if the set_boolean value is set to FALSE.

Access type: outputOnly

BooleanFilter_inputFalse.dot

Referenced by H3D::BooleanFilter::SetBoolean::setValue(), and H3D::BooleanFilter::SetBoolean::update().

This field contains the negation of the set_boolean field.

Access type: outputOnly

BooleanFilter_inputNegate.dot

Referenced by BooleanFilter().

Generates an TRUE event if the set_boolean value is set to TRUE.

Access type: outputOnly

BooleanFilter_inputTrue.dot

Referenced by H3D::BooleanFilter::SetBoolean::setValue(), and H3D::BooleanFilter::SetBoolean::update().

The boolean field to filter.

Access type: inputOnly

BooleanFilter_set_boolean.dot

Referenced by BooleanFilter().


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

Generated on Fri Nov 7 10:29:20 2008 for H3D API by  doxygen 1.5.7