sosftrigger(3)
NAME
SoSFTrigger
SYNOPSIS
#include <Inventor/fields/SoSFTrigger.h> Inherits SoSField.
Detailed Description
The SoSFTrigger class is the 'void' class used for detecting field
changes.
Connect this field to a master field (or engine output) to detect when
the master field changes its value.
This is useful if you want to automatically trigger an update from the
node or engine (or other field container) this field is part of
whenever another field changes -- and you are not particularly
interested in the actual value of the master field.
- See also:
- SoFieldSensor
- Public Member Functions
- virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field) const SoSFTrigger & operator= (const SoSFTrigger &field) virtual SbBool isSame (const SoField &field) const void setValue (void)
void getValue (void) const
int operator== (const SoSFTrigger &trigger) const int operator!= (const SoSFTrigger &trigger) const virtual void startNotify (void)
virtual void notify (SoNotList *l)
virtual void touch (void) - Static Public Member Functions
- static void * createInstance (void)
static SoType getClassTypeId (void) static void initClass (void)
Member Function Documentation
- SoType SoSFTrigger::getClassTypeId (void) [static]
- Returns a unique type identifier for this field class.
- See also:
getTypeId(), SoType
- Reimplemented from SoSField.
- SoType SoSFTrigger::getTypeId (void) const [virtual]
- Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.
- See also:
getClassTypeId(), SoType
- Implements SoField.
- void SoSFTrigger::copyFrom (const SoField & f) [virtual]
- Copy value(s) from f into this field. f must be of the same type as this field.
- Implements SoField.
- SbBool SoSFTrigger::isSame (const SoField & f) const [virtual]
- Check for equal type and value(s).
- Implements SoField.
- void SoSFTrigger::initClass (void) [static]
- Internal method called upon initialization of the library (from
SoDB::init()) to set up the type system. - Reimplemented from SoSField.
- Referenced by SoField::initClasses().
- void SoSFTrigger::setValue (void)
- This field class does not actually contain any value, so we just
triggers an update by calling touch() within this method. - References touch().
- void SoSFTrigger::getValue (void) const
- Field doesn't contain any value, so this method does nothing.
- int SoSFTrigger::operator== (const SoSFTrigger & trigger) const
- Since SoSFTrigger fields doesn't have any value, they are all equal. So this method always returns TRUE.
- int SoSFTrigger::operator!= (const SoSFTrigger & trigger) const
- Since SoSFTrigger fields doesn't have any value, they are all equal. So this method always returns FALSE.
- void SoSFTrigger::startNotify (void) [virtual]
- Trigger a notification sequence.
- At the end of a notification sequence, all 'immediate' sensors (i.e.
sensors set up with a zero priority) are triggered. - Reimplemented from SoField.
- References SoField::getContainer(), SoField::setContainer(), and
SoField::startNotify(). - void SoSFTrigger::notify (SoNotList * nlist) [virtual]
- Notify auditors that this field has changed.
- Reimplemented from SoField.
- References SoField::notify().
- void SoSFTrigger::touch (void) [virtual]
- Notify the field as well as the field's owner / container that it has
been changed. - Touching a field which is part of any component (engine or node) in a
scene graph will lead to a forced redraw. This is useful if you have
been doing several updates to the field wrapped in a pair of
enableNotify() calls to notify the field's auditors that its value has changed. - See also:
setValue(), enableNotify()
- Reimplemented from SoField.
- References SoField::startNotify().
- Referenced by setValue().
Author
- Generated automatically by Doxygen for Coin from the source code.