Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
SoSFTrigger Class Reference
Field Classes

The SoSFTrigger class is the "void" class used for detecting field changes. More...

#include <Inventor/fields/SoSFTrigger.h>

Inheritance diagram for SoSFTrigger:
SoSField SoField

Public Member Functions

virtual void copyFrom (const SoField &field)
 
virtual SoType getTypeId (void) const
 
void getValue (void) const
 
virtual SbBool isSame (const SoField &field) const
 
virtual void notify (SoNotList *l)
 
int operator!= (const SoSFTrigger &trigger) const
 
const SoSFTrigger & operator= (const SoSFTrigger &field)
 
int operator== (const SoSFTrigger &trigger) const
 
void setValue (void)
 
virtual void startNotify (void)
 
virtual void touch (void)
 
- Public Member Functions inherited from SoSField
virtual ~SoSField ()
 
- Public Member Functions inherited from SoField
virtual ~SoField ()
 
void addAuditor (void *f, SoNotRec::Type type)
 
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
 
SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
 
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)
 
SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)
 
virtual void connectionStatusChanged (int numconnections)
 
void copyConnection (const SoField *fromfield)
 
virtual void countWriteRefs (SoOutput *out) const
 
void disconnect (SoEngineOutput *engineoutput)
 
void disconnect (SoField *field)
 
void disconnect (void)
 
void enableConnection (SbBool flag)
 
SbBool enableNotify (SbBool on)
 
void evaluate (void) const
 
virtual void fixCopy (SbBool copyconnections)
 
void get (SbString &valuestring)
 
SbBool getConnectedEngine (SoEngineOutput *&master) const
 
SbBool getConnectedField (SoField *&master) const
 
int getConnections (SoFieldList &masterlist) const
 
SoFieldContainer * getContainer (void) const
 
SbBool getDirty (void) const
 
int getFieldType (void) const
 
int getForwardConnections (SoFieldList &slavelist) const
 
int getNumConnections (void) const
 
SbBool isConnected (void) const
 
SbBool isConnectedFromEngine (void) const
 
SbBool isConnectedFromField (void) const
 
SbBool isConnectionEnabled (void) const
 
SbBool isDefault (void) const
 
SbBool isIgnored (void) const
 
SbBool isNotifyEnabled (void) const
 
SbBool isOfType (const SoType type) const
 
SbBool isReadOnly (void) const
 
int operator!= (const SoField &f) const
 
int operator== (const SoField &f) const
 
virtual SbBool read (SoInput *input, const SbName &name)
 
virtual SbBool referencesCopy (void) const
 
void removeAuditor (void *f, SoNotRec::Type type)
 
SbBool set (const char *valuestring)
 
void setContainer (SoFieldContainer *cont)
 
void setDefault (SbBool defaultVal)
 
void setDirty (SbBool dirty)
 
void setFieldType (int type)
 
void setIgnored (SbBool ignore)
 
SbBool shouldWrite (void) const
 
virtual void write (SoOutput *out, const SbName &name) const
 

Static Public Member Functions

static void * createInstance (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoSField
static void atexit_cleanup (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoField
static void cleanupClass (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
static void initClasses (void)
 

Additional Inherited Members

- Public Types inherited from SoField
enum  FieldType { NORMAL_FIELD = 0 , EVENTIN_FIELD , EVENTOUT_FIELD , EXPOSED_FIELD }
 
- Protected Member Functions inherited from SoSField
 SoSField (void)
 
- Protected Member Functions inherited from SoField
 SoField (void)
 
virtual SoNotRec createNotRec (SoBase *cont)
 
virtual void evaluateConnection (void) const
 
SbBool isDestructing (void) const
 
virtual SbBool readConnection (SoInput *in)
 
void valueChanged (SbBool resetdefault=TRUE)
 
virtual void writeConnection (SoOutput *out) const
 

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

Member Function Documentation

◆ copyFrom()

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.

◆ createInstance()

void * SoSFTrigger::createInstance ( void )
static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

◆ getClassTypeId()

SoType SoSFTrigger::getClassTypeId ( void )
static

This static method returns the SoType object associated with objects of this class.

◆ getTypeId()

SoType SoSFTrigger::getTypeId ( void ) const
virtual

Returns the type identification of an object derived from a class inheriting SoField. This is used for runtime type checking and "downward" casting.

Implements SoField.

◆ getValue()

void SoSFTrigger::getValue ( void ) const

Field doesn't contain any value, so this method does nothing.

◆ initClass()

void SoSFTrigger::initClass ( void )
static

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

◆ isSame()

SbBool SoSFTrigger::isSame ( const SoField & f) const
virtual

Check for equal type and value(s).

Implements SoField.

◆ notify()

void SoSFTrigger::notify ( SoNotList * nlist)
virtual

Notify auditors that this field has changed.

Reimplemented from SoField.

◆ operator!=()

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.

◆ operator==()

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.

◆ setValue()

void SoSFTrigger::setValue ( void )

This field class does not actually contain any value, so we just trigger an update by calling touch() within this method.

◆ startNotify()

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.

◆ touch()

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.

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