SoOneShotSensor(3)

💖 SoOneShotSensor(3) 💖

okay bestie, welcome to the manual page for SoOneShotSensor — it lives in the Library Functions Manual, section 3, and it is literally the "do the thing exactly one time" sensor. one shot. that's the whole vibe. 🎯

---

✨ NAME ✨

SoOneShotSensor — the SoOneShotSensor class is a sensor which will trigger once. periodt. no repeats, no encores, it does its little callback and it's done. 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/sensors/SoOneShotSensor.h>

Inherits SoDelayQueueSensor.

🦋 Public Member Functions

• SoOneShotSensor(void)
• SoOneShotSensor(SoSensorCB *func, void *data)
• virtual ~SoOneShotSensor(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 SbBool isIdleOnly(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 SoOneShotSensor class is a sensor which will trigger once.

Since SoOneShotSensor is a subclass of SoDelayQueueSensor, it will trigger as soon as either the run-time system is idle, or — if it is continually busy — it will trigger within a fixed amount of time. that fixed amount is by default 1/12th of a second, and you can peek at SoSensorManager::setDelaySensorTimeout() for the deets. 🕐✨

not me being the sensor that refuses to be ignored — even when the system is drowning in work, bestie still shows up within that fixed window. iconic behaviour fr fr. 🔥

---

💅 Constructor & Destructor Documentation 💅

🧚 SoOneShotSensor::SoOneShotSensor (void )

Constructor. that's it, that's the whole thing. makes you a fresh little one-shot sensor. ✨

🧚 SoOneShotSensor::SoOneShotSensor (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()

🧚 SoOneShotSensor::~SoOneShotSensor (void ) [virtual]

Destructor. bye bestie, it was one shot and one shot only. 💀🫶

---

📝 Author 📝

Generated automatically by Doxygen for Coin from the source code. (not a human author, just doxygen doing its little automatic thing, slay i guess 🤖✨)

---

and that's the whole page, bestie!! this was Coin, Version 3.1.3, and the manual page is SoOneShotSensor(3) — thanks for reading, mwah 💖🎀🦋