SoIdleSensor(3)

💖 SoIdleSensor(3) 💖

okay bestie, welcome to the Library Functions Manual entry for SoIdleSensor — yes it's a C++ class, yes it's from Coin, and yes we're gonna make it make sense. 🫶

---

✨ NAME ✨

SoIdleSensor — the sensor class that triggers the second your app goes idle. literally the moment your program has nothing better to do, this thing wakes up. 💅

---

🦋 SYNOPSIS 🦋

#include <Inventor/sensors/SoIdleSensor.h>

Inherits SoDelayQueueSensor.

🌸 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 SoIdleSensor is a sensor which will trigger as soon as the application is idle. that's the whole vibe. no cap. 🔥

Here's the tea though, because this is the part that actually matters: 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 — it only fires when the application is idle. so it's not just "whenever the queue gets poked", it's specifically "when you're actually chillin'". 🧚

See also

• SoDB::setDelaySensorTimeout()

---

💅 Constructor & Destructor Documentation 💅

SoIdleSensor::SoIdleSensor (void )

Default constructor. that's it, that's the whole thing. ✨

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

Constructor taking as parameters the sensor callback function and the userdata which will be passed the callback. so you hand it func and data and it handles the rest. 🍓

See also

• setFunction(), setData()

References SoSensor::func.

SoIdleSensor::~SoIdleSensor (void ) [virtual]

Destructor. bye babe, we love a clean teardown. 😭💜

---

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. (not a human, not a girlie, just a doc generator doing its best 🫶)

---

and that's the whole page, bestie!! this one came from Coin, Version 2.5.0, SoIdleSensor(3) — k thanks bye, go schedule something idle, ily 💖✨🎀