SoAlarmSensor(3)

✨ SoAlarmSensor ✨ (NAME)

okay so bestie, welcome to SoAlarmSensor 💖 — the Coin sensor that fires exactly once at a time you pick. One and done. It's giving "set it and forget it", no cap. 🎀

---

🌸 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

---

💖 DESCRIPTION 💖 (Detailed Description)

okay so listen: SoAlarmSensor is the sensor that will trigger once at a specified time. just once. that's the whole vibe. ✨

it's literally the convenient way to set up triggers for jobs that should be executed only once when they are scheduled. one-shot queen behavior, periodt. 👑

---

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

🌸 SoAlarmSensor::SoAlarmSensor (void )

Default constructor. classic. nothing fancy, just vibes. 💅

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

Constructor taking as parameters the sensor callback function and the userdata which will be passed to the callback. iykyk — you hand it your func and your data and it handles the rest. 🫶

See also setFunction(), setData()

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

Destructor. she's done, she's logging off. 😭

---

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

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

Set the time at which the sensor will trigger. pick your moment bestie. ⏰

note: you must manually schedule() the sensor after calling this method. don't forget or she simply will not go off. no cap.

See also setTimeFromNow(), getTime()

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

Set the alarm to be triggered at a specified offset from the current time. like "in 5 seconds" energy instead of "at 3:47pm" energy. 🦋

note: again — you must manually schedule() the sensor after calling this method. that part is not optional fr fr.

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. that's the epoch, bestie, the origin story, the main character timeline. 🌈

See also setTime(), setTimeFromNow()

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

Put the sensor in the global timer queue. she's in the lineup now. 🔥

See also unschedule(), isScheduled()

Reimplemented from SoTimerQueueSensor.

---

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. the robot wrote it, i just added the sparkle. ✨

---

and that's the whole page, bestie 🫶 — Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, signing off like the icon she is. SoAlarmSensor(3) ate and left no crumbs. 💖🎀