SoIdleSensor(3)

okay bestie, buckle up 💖 you've landed in the Coin manual, and today's main character is SoIdleSensor — the sensor that literally waits for the vibes to go quiet before it does anything. iconic behavior honestly.

---

✨ NAME ✨

SoIdleSensor — bestie, this is the sensor class that will trigger as soon as the application is idle. like, the second everything calms down. no cap.

---

🦋 SYNOPSIS 🦋

#include <Inventor/sensors/SoIdleSensor.h>

Inherits SoDelayQueueSensor. yes she's got ancestors, she's a nepo baby and we love her for it 👑

💅 Public Member Functions

• SoIdleSensor (void)
• SoIdleSensor (SoSensorCB *func, void *data)
• virtual ~SoIdleSensor (void)

🌈 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 void trigger (void)

🌸 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 Attributes inherited from SoDelayQueueSensor

• SbBool scheduled

🔒 Protected Attributes inherited from SoSensor

• SoSensorCB * func
• void * funcData

---

💫 Detailed Description 💫

So the whole thing about SoIdleSensor is that it's a sensor which will trigger as soon as the application is idle. that's the entire personality. she waits for the room to go quiet and then she speaks. periodt.

okay but here's the tea that actually matters, bestie — an SoIdleSensor differs from an SoOneShotSensor in that it will not trigger if the delay queue processing is occurring due to the delay queue timeout, but only when the application is idle. so like, if the queue is churning because of a timeout? she is NOT getting up for that. she only moves when the app is genuinely, truly idle. highkey a whole different energy from SoOneShotSensor 🫶

See also: SoDB::setDelaySensorTimeout()

---

🔥 Constructor & Destructor Documentation 🔥

SoIdleSensor::SoIdleSensor (void )

Default constructor. just a lil baby sensor, freshly born, no callback, no data, pure potential ✨

SoIdleSensor::SoIdleSensor (SoSensorCB * func, void * data)

Constructor taking as parameters the sensor callback function and the userdata which will be passed to the callback. so you hand her func and you hand her data, and she'll pass that data right along to your callback when the time comes. she's a courier. she's reliable. she ate 💅

See also: setFunction(), setData()

SoIdleSensor::~SoIdleSensor (void ) [virtual]

Destructor. she's leaving the group chat. it's virtual, so she bows out gracefully 🌸

---

🧚 Author 🧚

Generated automatically by Doxygen for Coin from the source code. so like, no human author to thank here, it's giving robot poetry, and honestly? iconic 🤖

---

and that's the whole page, bestie 🎀 this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00 — go forth and idle-sense responsibly 💖✨🦋