SoNotList(3) Coin SoNotList(3)NAME
SoNotList -
The SoNotList class is a list of SoNotRec notification records.
SYNOPSIS
#include <Inventor/misc/SoNotification.h>
Public Member Functions
SoNotList (void)
SoNotList (const SoNotList *nl)
void append (SoNotRec *const rec)
void append (SoNotRec *const rec, SoField *const field)
void append (SoNotRec *const rec, SoEngineOutput *const engineout)
void setLastType (const SoNotRec::Type type)
SoNotRec * getFirstRec (void) const
SoNotRec * getLastRec (void) const
SoNotRec * getFirstRecAtNode (void) const
SoField * getLastField (void) const
SoEngineOutput * getLastEngineOutput (void) const
uint32_t getTimeStamp (void) const
void print (FILE *const file=stdout) const
Detailed Description
The SoNotList class is a list of SoNotRec notification records.
Constructor &; Destructor Documentation
SoNotList::SoNotList (void)
Initialize list.
SoNotList::SoNotList (const SoNotList *nl)
Copy constructor. Does a bitwise copy of the nl object (no duplication of list elements).
Member Function Documentation
void SoNotList::append (SoNotRec *constrec)
Append rec notification source to the list.
void SoNotList::append (SoNotRec *constrec, SoField *constfield)
Append rec notification source to the list, setting field as the last field having been influenced by the notification process.
void SoNotList::append (SoNotRec *constrec, SoEngineOutput *constengineout)
Append rec notification source to the list, setting engineout as the last engine output field having been influenced by the notification
process.
void SoNotList::setLastType (const SoNotRec::Typetype)
Set the type of the last notification record in the list.
SoNotRec * SoNotList::getFirstRec (void) const
Returns the first record in the list.
SoNotRec * SoNotList::getLastRec (void) const
Returns the last record in the list.
SoNotRec * SoNotList::getFirstRecAtNode (void) const
Returns the first record in the list which is derived from SoBase.
SoField * SoNotList::getLastField (void) const
Returns the last field touched by notification.
SoEngineOutput * SoNotList::getLastEngineOutput (void) const
Returns the last engine output field touched by notification.
uint32_t SoNotList::getTimeStamp (void) const
Returns the time stamp when the notification started.
void SoNotList::print (FILE *constfile = stdout) const
Dump contents of list from tail record and backwards. Only available if compiled with debug information on.
Author
Generated automatically by Doxygen for Coin from the source code.
Version 3.1.3 Wed May 23 2012 SoNotList(3)
Check Out this Related Man Page
SoPathSensor(3) Coin SoPathSensor(3)NAME
SoPathSensor -
The SoPathSensor class detects changes to paths.
If you need to know when a path changes (i.e. nodes in the path has been removed, or new nodes is added), use this sensor to get a
notification.
SYNOPSIS
#include <Inventor/sensors/SoPathSensor.h>
Inherits SoDataSensor.
Public Types
enum TriggerFilter { PATH = 0x1, NODES = 0x2, PATH_AND_NODES = 0x3 }
Public Member Functions
SoPathSensor (void)
SoPathSensor (SoSensorCB *func, void *data)
virtual ~SoPathSensor (void)
void setTriggerFilter (const TriggerFilter type)
TriggerFilter getTriggerFilter (void) const
void attach (SoPath *path)
void detach (void)
SoPath * getAttachedPath (void) const
Protected Member Functions
virtual void notify (SoNotList *l)
Detailed Description
The SoPathSensor class detects changes to paths.
If you need to know when a path changes (i.e. nodes in the path has been removed, or new nodes is added), use this sensor to get a
notification.
You can also use this sensor to detect when some node in the path is changed.
An SoPathSensor can also act for delete-callback purposes alone and does not need a regular notification-based callback. The delete
callback will be invoked for when the SoPath instance is deleted, not for anything you would be monitoring in a path.
Member Enumeration Documentation
enum SoPathSensor::TriggerFilter
Trigger filter, which decides if the sensor should trigger on path changes, changes on nodes in the path, or both.
Enumerator:
PATH Trigger on path changes only.
NODES Trigger on node changes only. This can be nodes in the path, or nodes affecting the nodes in the path (nodes that updates the state
and are left of the node in the path).
PATH_AND_NODES
Trigger on both path changes and node changes.
Constructor &; Destructor Documentation
SoPathSensor::SoPathSensor (void)
Default constructor. Use setFunction() to set up a callback function later.
SoPathSensor::SoPathSensor (SoSensorCB *func, void *data)
Constructor taking as parameters the sensor callback function and the userdata which will be passed the callback.
See also:
setFunction(), setData()
SoPathSensor::~SoPathSensor (void) [virtual]
Destructor.
Member Function Documentation
void SoPathSensor::setTriggerFilter (const TriggerFilterfilter)
Set the TriggerFilter for this sensor.
The default is PATH_AND_NODES.
Since:
Coin 2.0
SoPathSensor::TriggerFilter SoPathSensor::getTriggerFilter (void) const
Return the TriggerFilter for this sensor.
Since:
Coin 2.0
void SoPathSensor::attach (SoPath *path)
Attach sensor to a path. Whenever the path changes, the sensor will be triggered and call the callback function.
When the SoPath instance is deleted, the sensor will automatically be detached.
See also:
detach()
void SoPathSensor::detach (void)
Detach sensor from path. As long as an SoPathSensor is detached, it will never invoke its callback function.
See also:
attach()
SoPath * SoPathSensor::getAttachedPath (void) const
Returns a pointer to the path connected to the sensor.
See also:
attach(), detach()
void SoPathSensor::notify (SoNotList *l) [protected], [virtual]
Called from entity we are monitoring when it changes.
If this is an immediate sensor, the field and node (if any) causing the change will be stored and can be fetched by getTriggerField() and
getTriggerNode(). If the triggerpath flag has been set, the path down to the node is also found and stored for later retrieval by
getTriggerPath().
See also:
setTriggerPathFlag()
Reimplemented from SoDataSensor.
Author
Generated automatically by Doxygen for Coin from the source code.
Version 3.1.3 Wed May 23 2012 SoPathSensor(3)