SOPATHSENSOR(3iv)

✨ SoPathSensor — the vibe 💅

okay so bestie, welcome to SoPathSensor(3IV) — yes that's the manual name, we're being fancy today 🎀

---

👑 NAME

SoPathSensor — a sensor class that can be attached to Inventor paths. she's a watcher. a girl who keeps tabs. 🦋

---

🌸 INHERITS FROM

SoSensor > SoDelayQueueSensor > SoDataSensor > SoPathSensor

so basically she got her whole entire personality from her ancestors and she is not ashamed of it 💖

---

✨ SYNOPSIS

#include <Inventor/sensors/SoPathSensor.h>

Methods from class SoPathSensor:

                     SoPathSensor()
                     SoPathSensor(SoSensorCB *func, void *data)
                     ~SoPathSensor()
void                attach(SoPath *path)
void                detach()
SoPath *            getAttachedPath() const

Methods from class SoDataSensor:

void                setDeleteCallback(SoSensorCB *function, void *data)
SoNode *            getTriggerNode() const
SoField *           getTriggerField() const
SoPath *            getTriggerPath() const
void                setTriggerPathFlag(SbBool flag)
SbBool              getTriggerPathFlag() const

Methods from class SoDelayQueueSensor:

void                setPriority(uint32_t pri)
uint32_t            getPriority()
static uint32_t     getDefaultPriority()
virtual void        schedule()
virtual void        unschedule()
virtual SbBool      isScheduled()

Methods from class SoSensor:

void                setFunction(SoSensorCB *callbackFunction)
SoSensorCB *        getFunction() const
void                setData(void *callbackData)
void *              getData() const

---

💜 DESCRIPTION

okay so picture this: path sensors detect changes to paths. like, they call a callback function whenever the path — or any node in the path — changes. 🔥

and "in the path" means the exact same thing it means when you apply an action to the path. so like, any node that could possibly affect the node at the end of the path chain counts as being in the path. it's giving "everyone who ever influenced her shows up to the party" energy 💅

if you want the full lore on paths, go read the SoPath manual page. iykyk ✨

---

🎀 METHODS

🌈 Constructors

                     SoPathSensor()
                     SoPathSensor(SoSensorCB *func, void *data)

Creation methods, bestie. the second one takes the callback function and the data to be called when the sensor is triggered. so she knows who to text when something goes down 📱

💀 Destructor

                     ~SoPathSensor()

Destroys the sensor, freeing up any memory associated with it — but only after unscheduling it. she cleans up her room and then she leaves. iconic behavior honestly 🫶

🦋 Attaching and detaching

void                attach(SoPath *path)
void                detach()
SoPath *            getAttachedPath() const

• the attach() method makes this sensor detect changes to the given path. she's locked in. 🔒
• the detach() method unschedules this sensor (if it is scheduled) and makes it ignore changes to the scene graph. she's in her no-contact era 🙈
• the getAttachedPath() method returns the path that this sensor is sensing, or NULL if it is not attached to any path. no path, no problem, she just says NULL 💀

---

👀 SEE ALSO

• SoNodeSensor
• SoPathSensor
• SoDataSensor

---

no cap: this page lives at SoPathSensor(3IV)() — that's the header AND the footer, she's matching her own outfit, and honestly? slay 💅

later bestie, go attach a sensor and have a day as gorgeous as you 🌸💖✨