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

BooleanToggle stores a boolean value for toggling on/off. More...

#include <H3D/BooleanToggle.h>

Inheritance diagram for H3D::BooleanToggle:

Inheritance graph

List of all members.

Classes

class  SetBoolean
 The SetBoolean class is specialize to negate the value of the toggle field if a true event is given. More...

Public Member Functions

 BooleanToggle (Inst< SFNode > _metadata=0, Inst< SetBoolean > _set_boolean=0, Inst< SFBool > _toggle=0)
 Constructor.

Public Attributes

auto_ptr< SetBooleanset_boolean
 Negates the value of the toggle field.
auto_ptr< SFBooltoggle
 The boolean field to toggle.

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodedatabase for this node.


Detailed Description

BooleanToggle stores a boolean value for toggling on/off.

When a set_boolean TRUE event is received, the BooleanToggle negates the value of the toggle field and generates the corresponding toggle field output event. set_boolean FALSE events are ignored. The BooleanToggle can be reset to a specific state by directly setting the value of the inputOutput toggle field.

Internal routes:
BooleanToggle.dot

Member Data Documentation

Negates the value of the toggle field.

Access type: inputOnly

BooleanToggle_set_boolean.dot

The boolean field to toggle.

Access type: inputOutput
Default value: FALSE

BooleanToggle_toggle.dot

Referenced by BooleanToggle().


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

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