SoSFTrigger(3)

🎀 NAME 🎀

SoSFTrigger — the "void" class, aka the one whose entire job is noticing that field changes happened. That's it. That's the whole personality. 💅

Oh and hi bestie, this is a page from the Library Functions Manual — welcome to the SoSFTrigger(3) glow-up. ✨

---

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFTrigger.h>

Inherits SoSField.

🫶 Public Member Functions

virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoSFTrigger & operator= (const SoSFTrigger &field)
virtual SbBool isSame (const SoField &field) const
void setValue (void)
void getValue (void) const
int operator== (const SoSFTrigger &trigger) const
int operator!= (const SoSFTrigger &trigger) const
virtual void startNotify (void)
virtual void notify (SoNotList *l)
virtual void touch (void)

🦋 Public Member Functions inherited from SoSField

virtual ~SoSField ()

💜 Public Member Functions inherited from SoField

virtual ~SoField ()
void setIgnored (SbBool ignore)
SbBool isIgnored (void) const
void setDefault (SbBool defaultVal)
SbBool isDefault (void) const
SbBool isOfType (const SoType type) const
void enableConnection (SbBool flag)
SbBool isConnectionEnabled (void) const
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE,
    SbBool append=FALSE)
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
void disconnect (SoEngineOutput *engineoutput)
SbBool isConnectedFromEngine (void) const
SbBool getConnectedEngine (SoEngineOutput *&master) const
SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool
    append=FALSE)
SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
void disconnect (SoField *field)
SbBool isConnectedFromField (void) const
SbBool getConnectedField (SoField *&master) const
int getNumConnections (void) const
int getForwardConnections (SoFieldList &slavelist) const
int getConnections (SoFieldList &masterlist) const
void disconnect (void)
SbBool isConnected (void) const
void setContainer (SoFieldContainer *cont)
SoFieldContainer * getContainer (void) const
SbBool set (const char *valuestring)
void get (SbString &valuestring)
SbBool shouldWrite (void) const
SbBool enableNotify (SbBool on)
SbBool isNotifyEnabled (void) const
void addAuditor (void *f, SoNotRec::Type type)
void removeAuditor (void *f, SoNotRec::Type type)
int operator== (const SoField &f) const
int operator!= (const SoField &f) const
virtual void connectionStatusChanged (int numconnections)
SbBool isReadOnly (void) const
virtual void fixCopy (SbBool copyconnections)
virtual SbBool referencesCopy (void) const
void copyConnection (const SoField *fromfield)
virtual SbBool read (SoInput *input, const SbName &name)
virtual void write (SoOutput *out, const SbName &name) const
virtual void countWriteRefs (SoOutput *out) const
void setFieldType (int type)
int getFieldType (void) const
SbBool getDirty (void) const
void setDirty (SbBool dirty)
void evaluate (void) const

⭐ Static Public Member Functions

static void * createInstance (void)
static SoType getClassTypeId (void)
static void initClass (void)

🌈 Static Public Member Functions inherited from SoSField

static void initClass (void)
static SoType getClassTypeId (void)
static void atexit_cleanup (void)

💖 Static Public Member Functions inherited from SoField

static void initClass (void)
static void initClasses (void)
static void cleanupClass (void)
static SoType getClassTypeId (void)

🧚 Additional Inherited Members

Public Types inherited from SoField:

enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD, EVENTOUT_FIELD,
    EXPOSED_FIELD }

Protected Member Functions inherited from SoSField:

SoSField (void)

Protected Member Functions inherited from SoField:

SoField (void)
void valueChanged (SbBool resetdefault=TRUE)
virtual void evaluateConnection (void) const
virtual SbBool readConnection (SoInput *in)
virtual void writeConnection (SoOutput *out) const
SbBool isDestructing (void) const

---

🔥 Detailed Description 🔥

So like. The SoSFTrigger class is the "void" class — its whole entire thing is detecting field changes. No value, no drama, just vibes and vigilance. 👑

Connect this field to a master field (or an engine output) and it will clock the moment the master field changes its value. No cap.

This is highkey useful when you want to automatically trigger an update from the node or engine (or any other field container) this field is part of, every single time another field changes — and honestly? You do not care about the actual value of the master field. Not even a little. 🙈

👀 See also

• SoFieldSensor

---

💅 Member Function Documentation 💅

SoType SoSFTrigger::getTypeId (void ) const [virtual]

Hands you back the type identification instance that uniquely identifies the Coin field class this object belongs to. It's giving ✨identity✨.

See also

• getClassTypeId(), SoType

Implements SoField.

void SoSFTrigger::copyFrom (const SoField & f) [virtual]

Copies the value(s) from f into this field. Heads up bestie: f must be the same type as this field, no substitutions.

Implements SoField.

SbBool SoSFTrigger::isSame (const SoField & f) const [virtual]

Checks for equal type and value(s). Comparison era. 🫶

Implements SoField.

void SoSFTrigger::setValue (void )

So this field class doesn't actually contain any value (iconic, honestly), which means we just trigger an update by calling touch() inside this method. That's the whole move. 💅

void SoSFTrigger::getValue (void ) const

The field doesn't contain any value, so this method does absolutely nothing. It's literally just there. Respect the commitment. 💀

int SoSFTrigger::operator== (const SoSFTrigger & trigger) const

Since SoSFTrigger fields don't have any value, they are all equal. So this method always returns TRUE. Periodt. 👑

int SoSFTrigger::operator!= (const SoSFTrigger & trigger) const

Same deal — no value means they're all equal, so this one always returns FALSE. Not one single difference to be found. 😌

void SoSFTrigger::startNotify (void ) [virtual]

Triggers a notification sequence. 🌊

At the end of a notification sequence, all "immediate" sensors (i.e. sensors set up with a zero priority) are triggered. Mark that down, iykyk.

Reimplemented from SoField.

void SoSFTrigger::notify (SoNotList * nlist) [virtual]

Notifies the auditors that this field has changed. Gossip chain, but make it valid. 📣

Reimplemented from SoField.

void SoSFTrigger::touch (void ) [virtual]

Notifies the field as well as the field's owner / container that it has been changed. Double text, basically. 📱

Touching a field which is part of any component (engine or node) in a scene graph will lead to a forced redraw. Super handy if you've been doing several updates to the field wrapped in a pair of enableNotify() calls, and now you need to notify the field's auditors that its value has changed.

See also

• setValue(), enableNotify()

Reimplemented from SoField.

---

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. (Not a human, just a very efficient little robot. 🤖💖)

---

And that's the whole page, bestie! This little beauty came to you from Coin, Version 3.1.3, filed under SoSFTrigger(3). Go forth and trigger something. 🎀✨🦋