SoIdleSensor(3)

✨ SoIdleSensor ✨

okay bestie, welcome to the SoIdleSensor(3) page 💖 this is a Library Functions Manual moment, and yes we're about to make sensors feel cute. sit down, hydrate, let's go 🫶

---

🌸 NAME 🌸

SoIdleSensor — the sensor class that triggers the second your app goes idle. like, the moment there's nothing left to do, she's up and at it 💅

---

🎀 SYNOPSIS 🎀

#include <Inventor/sensors/SoIdleSensor.h>

Inherits SoDelayQueueSensor. yes, she's part of a whole lineage, main character energy runs in the family 👑

💫 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 💜

The SoIdleSensor class is a sensor which will trigger as soon as the application is idle. literally the second your app has nothing better to do, she shows up 🌸

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 — only when the application is idle. so no, she's not gonna fire just because the delay queue ran out of patience, she waits for true idle. that's the whole vibe check, no cap 🧚

See also

• SoDB::setDelaySensorTimeout()

---

🛠 Constructor & Destructor Documentation 🛠

SoIdleSensor::SoIdleSensor (void )

Default constructor. the classic, no-arguments, just-vibes option 💖

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 her a function and some data, and she'll pass that data along when she fires, iconic behavior fr fr ✨

See also

• setFunction(), setData()

SoIdleSensor::~SoIdleSensor (void ) [virtual]

Destructor. she says bye 👋 and cleans up after herself, as she should.

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. not a human author moment, just the machine doing its thing 🤖💅

---

and that's the whole page, bestie!! this was Coin, Version 3.1.3 — thanks for reading all the way to the bottom, you're literally the best 🫶✨🎀