Open Inventor Reference
Public Member Functions | List of all members
SoNotList Class Reference

Holds a list of SoNotRec notification records. More...

#include <Inventor/misc/SoNotification.h>

Public Member Functions

 SoNotList ()
 Constructor. More...
 
 SoNotList (const SoNotList *copyFrom)
 Copy constructor. More...
 
void append (SoNotRec *rec)
 Appends given non-field record to end of list. More...
 
void append (SoNotRec *rec, SoField *field)
 Appends given (container) field record to end of list. More...
 
void setLastType (SoNotRec::Type t)
 Sets the type of the last (current) record in the list. More...
 
SoNotRec * getFirstRec () const
 Returns first and last records in list. More...
 
SoNotRec * getLastRec () const
 
SoNotRec * getFirstRecAtNode () const
 Returns first record in list that has a node base in the current chain of node-to-node notification. More...
 
SoField * getLastField () const
 Returns last field set by notification (or NULL if notification did not originate at or propagate through a field) More...
 
SbNodeIdType getTimeStamp () const
 Returns the time stamp so nodes can check if notification has already been handled. More...
 
void print (FILE *fp) const
 Prints a notification list for debugging. More...
 

Detailed Description

Points to the first and last records in the list. The records are linked backwards by "previous" pointers.

The list also points to the first notification record that involves a node. This info is used to determine which node actually notified sensors. There is also a pointer to the last field that changed, which is needed by field-specific sensors.

Definition at line 153 of file SoNotification.h.

Constructor & Destructor Documentation

◆ SoNotList() [1/2]

SoNotList::SoNotList ( )

◆ SoNotList() [2/2]

SoNotList::SoNotList ( const SoNotList *  copyFrom)
inline

Definition at line 160 of file SoNotification.h.

Member Function Documentation

◆ append() [1/2]

void SoNotList::append ( SoNotRec *  rec)

◆ append() [2/2]

void SoNotList::append ( SoNotRec *  rec,
SoField *  field 
)

We assume the base in the record is a node.

◆ getFirstRec()

SoNotRec* SoNotList::getFirstRec ( ) const
inline

Definition at line 180 of file SoNotification.h.

◆ getFirstRecAtNode()

SoNotRec* SoNotList::getFirstRecAtNode ( ) const
inline

This information is passed to sensor callbacks to indicate which node initiated notification in the graph.

Definition at line 187 of file SoNotification.h.

◆ getLastField()

SoField* SoNotList::getLastField ( ) const
inline

Definition at line 191 of file SoNotification.h.

◆ getLastRec()

SoNotRec* SoNotList::getLastRec ( ) const
inline

Definition at line 181 of file SoNotification.h.

◆ getTimeStamp()

SbNodeIdType SoNotList::getTimeStamp ( ) const
inline

Definition at line 195 of file SoNotification.h.

◆ print()

void SoNotList::print ( FILE *  fp) const

◆ setLastType()

void SoNotList::setLastType ( SoNotRec::Type  t)
inline

Reset firstAtNode pointer if we're going through field-to-field or engine-to-field connections.

Definition at line 170 of file SoNotification.h.

References SoNotRec::ENGINE, SoNotRec::FIELD, and SoNotRec::setType().

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