SoFieldSensor(3)

💖 SoFieldSensor 💖

okay bestie, so this is a page from the Library Functions Manual, and today's main character is SoFieldSensor — the class whose whole job is noticing when a field changes. it's giving surveillance but make it cute. 🕵️♀️✨

---

✨ NAME ✨

SoFieldSensor — the class that detects changes to a field. that's it, that's the vibe. 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/sensors/SoFieldSensor.h>

Inherits SoDataSensor. yes queen, it's part of a whole family tree, and we're gonna meet the whole fam. 🫶

💫 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. no cap.

Attach a field to a sensor of this type to put it under surveillance, so you can act upon changes to the field. lowkey it's like putting a little bell on your field that goes off every time the value moves. 🔔

---

✨ Constructor & Destructor Documentation ✨

🎀 SoFieldSensor::SoFieldSensor (void )

Constructor. the classic no-args entrance. 💅

🦋 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()

References SoSensor::func.

🌸 SoFieldSensor::~SoFieldSensor (void ) [virtual]

Destructor. it's time to say bye, and she cleans up after herself. 😭

References detach().

---

💫 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. obsessed with this for her fr fr.

A field sensor can be attached to only a single field at a time. When this method is invoked multiple times, each subsequent call will replace the field the sensor is monitoring with the new field. one field at a time bestie, she's loyal like that. 💖

See also: detach()

References SoField::addAuditor(), detach(), and SoField::evaluate().

Referenced by SoCenterballDragger::valueChangedCB(), SoDirectionalLightDragger::valueChangedCB(), SoDragPointDragger::valueChangedCB(), SoHandleBoxDragger::valueChangedCB(), SoJackDragger::valueChangedCB(), SoPointLightDragger::valueChangedCB(), SoRotateCylindricalDragger::valueChangedCB(), SoRotateDiscDragger::valueChangedCB(), SoRotateSphericalDragger::valueChangedCB(), SoScale1Dragger::valueChangedCB(), SoScale2Dragger::valueChangedCB(), SoScale2UniformDragger::valueChangedCB(), SoScaleUniformDragger::valueChangedCB(), SoSpotLightDragger::valueChangedCB(), SoTabBoxDragger::valueChangedCB(), SoTrackballDragger::valueChangedCB(), SoTransformBoxDragger::valueChangedCB(), SoTransformerDragger::valueChangedCB(), SoTranslate1Dragger::valueChangedCB(), and SoTranslate2Dragger::valueChangedCB().

💅 void SoFieldSensor::detach (void )

Detach sensor from field. As long as an SoFieldSensor is detached, it will never call its callback function. she's on do-not-disturb, and honestly? same. 🙈

See also: attach()

References SoDelayQueueSensor::isScheduled(), and SoDelayQueueSensor::unschedule().

Referenced by attach(), SoCenterballDragger::valueChangedCB(), SoDirectionalLightDragger::valueChangedCB(), SoDragPointDragger::valueChangedCB(), SoHandleBoxDragger::valueChangedCB(), SoJackDragger::valueChangedCB(), SoPointLightDragger::valueChangedCB(), SoRotateCylindricalDragger::valueChangedCB(), SoRotateDiscDragger::valueChangedCB(), SoRotateSphericalDragger::valueChangedCB(), SoScale1Dragger::valueChangedCB(), SoScale2Dragger::valueChangedCB(), SoScale2UniformDragger::valueChangedCB(), SoScaleUniformDragger::valueChangedCB(), SoSpotLightDragger::valueChangedCB(), SoTabBoxDragger::valueChangedCB(), SoTrackballDragger::valueChangedCB(), SoTransformBoxDragger::valueChangedCB(), SoTransformerDragger::valueChangedCB(), SoTranslate1Dragger::valueChangedCB(), SoTranslate2Dragger::valueChangedCB(), and ~SoFieldSensor().

🔥 SoField * SoFieldSensor::getAttachedField (void ) const

Returns a pointer to the field connected to the sensor. like "who's your field bestie?" and she tells you. 💖

See also: attach(), detach()

👑 void SoFieldSensor::trigger (void ) [virtual]

Trigger the sensor's callback function. she said it's my moment and she ate. 🔥

Reimplemented from SoDataSensor.

References SoField::evaluate(), and SoDataSensor::trigger().

---

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. not a human author, just a little robot doing its thing. 🤖✨

---

and that's the whole page, bestie — every last flag, signature and reference accounted for, periodt. 💅

this was Coin, Version 2.5.0, serving SoFieldSensor(3) realness. mwah, take care of your fields. 🎀💖🌸