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

Records one step in the path taken by notification. More...

#include <Inventor/misc/SoNotification.h>

Public Types

enum  Type {
  CONTAINER , PARENT , SENSOR , FIELD ,
  ENGINE
}
 Notification types (what receives notification). More...
 

Public Member Functions

 SoNotRec (SoBase *b)
 Constructor - passed the base pointer.
 
void setType (SoNotRec::Type t)
 Sets notification type.
 
SoBase * getBase () const
 Returns base pointer, type, or previous record in list.
 
SoNotRec::Type getType () const
 
const SoNotRec * getPrevious () const
 
void setPrevious (SoNotRec *prev)
 Sets previous record pointer.
 
void print (FILE *fp) const
 Prints a notification record for debugging.
 

Detailed Description

Instances of this class are typically allocated on the stack as automatic variables.

There is an SoBase pointer in the record that points to the base (node, path, or engine) from which the notification is being propagated. The contents of this pointer depend on the type of the notification. The type also indicates the nature of the notification. These are the possible types: 

CONTAINER:  A field has changed value and is notifying its
            container node or engine. The base is the container.

PARENT:     A child of a group has changed and is notifying
            its parent. The base is the child.

SENSOR:     A node or path is notifying a sensor of a change.
            The base is the thing to which the sensor is attached.

FIELD:      A field in a node or engine is notifying the
            field to which it is connected. The base is the
            container of the source field.

ENGINE:     An engine is notifying a field to which it is
            connected. The base is the engine.

Definition at line 97 of file SoNotification.h.

Member Enumeration Documentation

◆ Type

enum SoNotRec::Type

Note that these are also used for maintaining lists of auditors in SoBase instances. Each auditor uses one of these types to indicate how it is auditing the instance. This is then propagated to the auditors in the notification records.

Enumerator
CONTAINER 

Field notifying container.

PARENT 

Child node notifying parent.

SENSOR 

Some base notifying sensor.

FIELD 

Field notifying connected field.

ENGINE 

Engine notifying connected field.

Definition at line 106 of file SoNotification.h.

Constructor & Destructor Documentation

◆ SoNotRec()

SoNotRec::SoNotRec ( SoBase *  b)
inline

Definition at line 115 of file SoNotification.h.

Member Function Documentation

◆ getBase()

SoBase * SoNotRec::getBase ( ) const
inline

Definition at line 121 of file SoNotification.h.

◆ getPrevious()

const SoNotRec * SoNotRec::getPrevious ( ) const
inline

Definition at line 123 of file SoNotification.h.

◆ getType()

SoNotRec::Type SoNotRec::getType ( ) const
inline

Definition at line 122 of file SoNotification.h.

◆ print()

void SoNotRec::print ( FILE *  fp) const

◆ setPrevious()

void SoNotRec::setPrevious ( SoNotRec *  prev)
inline

Definition at line 126 of file SoNotification.h.

◆ setType()

void SoNotRec::setType ( SoNotRec::Type  t)
inline

Definition at line 118 of file SoNotification.h.

Referenced by SoNotList::setLastType().

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