SoAlarmSensor(3)

💖 SoAlarmSensor(3) 💖

okay bestie, welcome to the Library Functions Manual page for SoAlarmSensor — yes, that's the manual name, we're in the Library Functions Manual section 3, and this whole thing is about one lil' class from Coin. sit down, grab a boba, let's go 🧋✨

---

✨ NAME ✨

SoAlarmSensor — the sensor class that triggers once, at a time you specify. one and done. it's giving one-hit wonder and we love that for it 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/sensors/SoAlarmSensor.h>

Inherits SoTimerQueueSensor.

🎀 Public Member Functions 🎀

SoAlarmSensor (void)
SoAlarmSensor (SoSensorCB *func, void *data)
virtual ~SoAlarmSensor (void)
void setTime (const SbTime &abstime)
void setTimeFromNow (const SbTime &reltime)
const SbTime & getTime (void) const
virtual void schedule (void)

💜 Public Member Functions inherited from SoTimerQueueSensor

SoTimerQueueSensor (void)
SoTimerQueueSensor (SoSensorCB *func, void *data)
virtual ~SoTimerQueueSensor (void)
const SbTime & getTriggerTime (void) const
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 SoSensor

static void initClass (void)

🌸 Protected Member Functions inherited from SoTimerQueueSensor

void setTriggerTime (const SbTime &time)

🌷 Protected Attributes inherited from SoTimerQueueSensor

SbBool scheduled

💫 Protected Attributes inherited from SoSensor

SoSensorCB * func
void * funcData

---

👑 Detailed Description 👑

The SoAlarmSensor class is a sensor which will trigger once at a specified time. no cap. 🕐

SoAlarmSensor provides a convenient way of setting up triggers for jobs which should be executed only once when they are scheduled. so if your thing is a "do it one time and never speak of it again" kinda job, this is literally the sensor for you, bestie 🫶

---

🧚 Constructor & Destructor Documentation 🧚

💖 SoAlarmSensor::SoAlarmSensor (void )

Default constructor. the blank-slate era, the pre-glow-up moment ✨

💖 SoAlarmSensor::SoAlarmSensor (SoSensorCB * func, void * data)

Constructor taking as parameters the sensor callback function and the userdata which will be passed the callback. you hand it a function and a lil' bag of data, and it holds onto both for you 💅

See also: setFunction(), setData()

💖 SoAlarmSensor::~SoAlarmSensor (void ) [virtual]

Destructor. say bye bye 👋

---

🔥 Member Function Documentation 🔥

🌟 void SoAlarmSensor::setTime (const SbTime & abstime)

Set the time at which the sensor will trigger. absolute time, iconic, straightforward 🌈

⚠️ Note that you must manually schedule() the sensor after calling this method. setting the time does not schedule it for you, bestie, that's on you 😭

See also: setTimeFromNow(), getTime()

🌟 void SoAlarmSensor::setTimeFromNow (const SbTime & reltime)

Set the alarm to be at a specified offset from the current time. so like, "in 5 seconds", "in 3 minutes", whatever — relative vibes only 🕰️

⚠️ Note that you must manually schedule() the sensor after calling this method. again. yes. still. schedule() is your problem 😤

See also: setTime(), getTime()

🌟 const SbTime & SoAlarmSensor::getTime (void ) const

Returns the trigger time for the alarm as an absolute value from 1970-01-01 00:00:00. yes we're doing Unix epoch hours, it's giving time traveler energy ⏳

See also: setTime(), setTimeFromNow()

🌟 void SoAlarmSensor::schedule (void ) [virtual]

Put the sensor in the global timer queue. now it's officially on the clock, main character energy 👑

See also: unschedule(), isScheduled()

Reimplemented from SoTimerQueueSensor.

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. the robots wrote this one, not me, I just added the sparkle ✨🤖

---

aaaand that's the whole page, bestie!! 🎀 this manual page for Coin, Version 3.1.3, on the SoAlarmSensor(3) page — slay, you read the entire thing, obsessed with you fr fr 💖🦋🌸