SoNodeSensor(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

✨ SoNodeSensor β€” the vibe-check sensor for your nodes ✨

okay bestie, welcome to the SoNodeSensor page from the Library Functions Manual πŸ’– this is the class that literally watches your nodes for you. No cap.


🌸 NAME 🌸

SoNodeSensor β€” the class that detects changes to nodes. periodt.


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/sensors/SoNodeSensor.h>

Inherits SoDataSensor. πŸ’…

πŸ‘‘ Public Member Functions πŸ‘‘

SoNodeSensor (void)
SoNodeSensor (SoSensorCB *func, void *data)
virtual ~SoNodeSensor (void)
void attach (SoNode *node)
void detach (void)
SoNode * getAttachedNode (void) const

🫢 Public Member Functions inherited from SoDataSensor 🫢

SoDataSensor (void)
SoDataSensor (SoSensorCB *func, void *data)
virtual ~SoDataSensor (void)
void setDeleteCallback (SoSensorCB *function, void *data=NULL)
SoNode * getTriggerNode (void) const
SoField * getTriggerField (void) const
SoPath * getTriggerPath (void) const
void setTriggerPathFlag (SbBool flag)
SbBool getTriggerPathFlag (void) const
virtual void trigger (void)
virtual void notify (SoNotList *l)

πŸŽ€ Public Member Functions inherited from SoDelayQueueSensor πŸŽ€

SoDelayQueueSensor (void)
SoDelayQueueSensor (SoSensorCB *func, void *data)
virtual ~SoDelayQueueSensor (void)
void setPriority (uint32_t pri)
uint32_t getPriority (void) const
virtual void schedule (void)
virtual void unschedule (void)
virtual SbBool isScheduled (void) const
virtual SbBool isIdleOnly (void) const

⭐ Public Member Functions inherited from SoSensor ⭐

SoSensor (void)
SoSensor (SoSensorCB *func, void *data)
virtual ~SoSensor (void)
void setFunction (SoSensorCB *callbackfunction)
SoSensorCBPtr getFunction (void) const
void setData (void *callbackdata)
void * getData (void) const
void setNextInQueue (SoSensor *next)
SoSensor * getNextInQueue (void) const

🌈 Additional Inherited Members 🌈

Static Public Member Functions inherited from SoDelayQueueSensor

static uint32_t getDefaultPriority (void)

Static Public Member Functions inherited from SoSensor

static void initClass (void)

Protected Member Functions inherited from SoDataSensor

void invokeDeleteCallback (void)

Protected Attributes inherited from SoDelayQueueSensor

SbBool scheduled

Protected Attributes inherited from SoSensor

SoSensorCB * func
void * funcData

πŸ’œ Detailed Description πŸ’œ

The SoNodeSensor class detects changes to nodes. that's it, that's the whole job, and it ate.

Attach a node to a sensor of this type to put it under surveillance πŸ‘€ so you can act upon changes to the node.

Any modification to the node's fields will trigger the sensor, as will changes to node's children (if any), including if nodes are added or removed as children below the node in the subgraph. fr fr, it's watching the whole little family tree.

An SoNodeSensor can also act for delete-callback purposes alone and does not need a regular notification-based callback. πŸ’…


🧚 Constructor & Destructor Documentation 🧚

SoNodeSensor::SoNodeSensor (void )

Default constructor. the classic no-args entrance, main character energy ✨

SoNodeSensor::SoNodeSensor (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()

SoNodeSensor::~SoNodeSensor (void ) [virtual]

Destructor. saying bye bye, gracefully, as one does 🫢


🌸 Member Function Documentation 🌸

void SoNodeSensor::attach (SoNode * node)

Attach sensor to a node. Whenever any data in the node (or its children, if it's an SoGroup or SoGroup derived node) changes, the sensor will be triggered and call the callback function. πŸ”₯

Attaching a node sensor to a node will not increase the node's reference count (and conversely, detach()'ing the node sensor will not decrease the reference count, either). important!! it's not taking custody, it's just keeping an eye out bestie

When the attached node is deleted, the sensor will be automatically detach()ed. 😭 it knows when to let go

See also detach()

void SoNodeSensor::detach (void )

Detach sensor from node. As long as an SoNodeSensor is detached, it will never call its callback function. silent era. no thoughts, no callbacks.

See also attach()

SoNode * SoNodeSensor::getAttachedNode (void ) const

Returns a pointer to the node connected to the sensor. πŸ‘‘

See also attach(), detach()


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Coin from the source code. yes the robots wrote this one, we just gave it a glow-up πŸ’…


and that's the whole page, bestie β€” go forth and sensor responsibly πŸ’–βœ¨

This was brought to you by Coin, Version 3.1.3, page SoNodeSensor(3). πŸŽ€ bye pookie 🫢

πŸ“¦ where this page comes from