SoFieldSensor(3)

💖 hey bestie, welcome to SoFieldSensor(3) 💖

okay so this little cutie lives in the Library Functions Manual, and honestly? she's giving main character energy for anyone who wants to know when a field changes. let's get into it 🫶

---

✨ NAME ✨

SoFieldSensor — the class that detects changes to a field. that's it, that's the whole job, and she ate 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/sensors/SoFieldSensor.h>

Inherits SoDataSensor.

🎀 Public Member Functions 🎀

SoFieldSensor (void)
SoFieldSensor (SoSensorCB *func, void *data)
virtual ~SoFieldSensor (void)
void attach (SoField *field)
void detach (void)
SoField * getAttachedField (void) const
virtual void trigger (void)

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

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 SoFieldSensor class detects changes to a field.

ok so here's the tea ☕ — you attach a field to a sensor of this type and boom, that field is now under surveillance 👀. so whenever it changes, you get to act on it. it's giving watchdog but make it cute.

and ngl, an SoFieldSensor can also act for delete-callback purposes alone — she does not need a regular notification-based callback to be valid. lowkey iconic that she's flexible like that ✨

---

💜 Constructor & Destructor Documentation 💜

SoFieldSensor::SoFieldSensor (void )

Constructor. 🍼 she's born.

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

SoFieldSensor::~SoFieldSensor (void ) [virtual]

Destructor. 💀 she's gone, periodt.

---

🔥 Member Function Documentation 🔥

void SoFieldSensor::attach (SoField * field)

Attach sensor to a field. Whenever the field's value changes, the sensor will be triggered and call the callback function.

real talk: a field sensor can be attached to only a single field at a time. if you invoke this method multiple times, each subsequent call will replace the field the sensor is monitoring with the new field. no polyamory here bestie, one field only 😭

when the given field is deleted, the sensor will automatically be detached. she handles her own breakup, we love a self-sufficient queen 👑

See also: detach()

void SoFieldSensor::detach (void )

Detach sensor from field. As long as an SoFieldSensor is detached, it will never call its callback function.

See also: attach()

SoField * SoFieldSensor::getAttachedField (void ) const

Returns a pointer to the field connected to the sensor.

See also: attach(), detach()

void SoFieldSensor::trigger (void ) [virtual]

Trigger the sensor's callback function.

Reimplemented from SoDataSensor.

---

⭐ Author ⭐

Generated automatically by Doxygen for Coin from the source code. 🤖 (yes bestie, a robot wrote this and she still served 💅)

---

and that's the whole page fr fr 🎀 this was Coin, version 3.1.3, sliding into your terminal with SoFieldSensor(3) — go forth and sense those fields, you absolute icon 👑