SoSFTrigger Class Reference
[Fields]
Field used to trigger engines or connection networks. More...
#include <Inventor/fields/SoSFTrigger.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| const SoSFTrigger & | operator= (const SoSFTrigger &f) |
| SoSFTrigger () | |
| virtual | ~SoSFTrigger () |
| void | setValue () |
| void | getValue () const |
| virtual void | touch () |
| int | operator== (const SoSFTrigger &t) const |
| int | operator!= (const SoSFTrigger &t) const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Detailed Description
Field used to trigger engines or connection networks.
This class can be used to start or to synchronize a network of field connections. It is the "null" field - a field with no values. It is typically used as the "start button" for engines that change over time.
Triggers can be connected from any other type of field, and will notify any engines or nodes they are part of (or any other triggers they are connected to) whenever the value of the field is set (even if it is set to its current value) or the field is touch()'ed.
Since they have no value, SoSFTriggers are not written to file. A node or engine containing an SoSFTrigger field will write only the field's name.
SEE ALSO
Constructor & Destructor Documentation
| SoSFTrigger::SoSFTrigger | ( | ) |
Default constructor.
| virtual SoSFTrigger::~SoSFTrigger | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| static SoType SoSFTrigger::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoSField.
| virtual SoType SoSFTrigger::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoTypedObject.
| void SoSFTrigger::getValue | ( | ) | const [inline] |
Forces any connected engines or fields to evaluate themselves.
| int SoSFTrigger::operator!= | ( | const SoSFTrigger & | t | ) | const |
| const SoSFTrigger& SoSFTrigger::operator= | ( | const SoSFTrigger & | f | ) |
Copy from another field of same type.
| int SoSFTrigger::operator== | ( | const SoSFTrigger & | t | ) | const |
| void SoSFTrigger::setValue | ( | ) | [inline] |
Starts the notification process; this is equivalent to calling touch().
| virtual void SoSFTrigger::touch | ( | ) | [virtual] |
Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.
Calling touch() on an instance of a derived field class is equivalent to calling setValue(getValue()) using the derived class's methods, except that the field's isDefault() status remains unchanged.
Reimplemented from SoField.
The documentation for this class was generated from the following file:
- Inventor/fields/SoSFTrigger.h