Field used to trigger engines or connection networks. More...
#include <Inventor/fields/SoSFTrigger.h>
Public Member Functions | |
| void | setValue () |
| Starts the notification process; this is equivalent to calling touch(). | |
| void | getValue () const |
| Forces any connected engines or fields to evaluate themselves. | |
| virtual void | touch () |
| Start notification. | |
| int | operator== (const SoSFTrigger &t) const |
| All trigger fields are equal; these methods always return TRUE and FALSE, respectively. | |
| int | operator!= (const SoSFTrigger &t) const |
| All trigger fields are equal; these methods always return TRUE and FALSE, respectively. | |
| virtual void | startNotify () |
| Notification can flow through a trigger, but can't start at a trigger. | |
| virtual void | notify (SoNotList *list) |
| Override notify to always evaluate (after passing on notification) to clear upstream dirty bits. | |
Static Public Member Functions | |
| static void | initClass () |
Detailed Description
This class can be used to start or to synchronize a network of field connections. It is the "null" field em 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
Definition at line 88 of file SoSFTrigger.h.
Member Function Documentation
| void SoSFTrigger::getValue | ( | ) | const [inline] |
Definition at line 100 of file SoSFTrigger.h.
| static void SoSFTrigger::initClass | ( | ) | [static] |
Reimplemented from SoSField.
| int SoSFTrigger::operator!= | ( | const SoSFTrigger & | t | ) | const |
| int SoSFTrigger::operator== | ( | const SoSFTrigger & | t | ) | const |
| void SoSFTrigger::setValue | ( | ) | [inline] |
Definition at line 97 of file SoSFTrigger.h.
References SoField::touch().
| virtual void SoSFTrigger::startNotify | ( | ) | [virtual] |
| virtual void SoSFTrigger::touch | ( | ) | [virtual] |
Reimplemented from SoField.
The documentation for this class was generated from the following file:
- MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/fields/SoSFTrigger.h
