SoSFEngine(3)

🦋 SoSFEngine — the Coin manual, section 3 🦋

okay bestie, buckle up, we're reading a manpage together and honestly? it's giving iconic. 💅

---

🌸 NAME 🌸

SoSFEngine — it's a container. For a single engine. That's the vibe. One field, one engine pointer, zero drama. ✨

---

✨ SYNOPSIS ✨

#include <Inventor/fields/SoSFEngine.h>

Inherits SoSField. (So it's got the whole SoField family tree behind it, iykyk. 👑)

🫶 Public Member Functions

virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoSFEngine & operator= (const SoSFEngine &field)
virtual SbBool isSame (const SoField &field) const
SoEngine * getValue (void) const
void setValue (SoEngine *newvalue)
SoEngine * operator= (SoEngine *newvalue)
int operator== (const SoSFEngine &field) const
int operator!= (const SoSFEngine &field) const
virtual void fixCopy (SbBool copyconnections)
virtual SbBool referencesCopy (void) const

👑 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
virtual void touch (void)
virtual void startNotify (void)
virtual void notify (SoNotList *nlist)
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
void copyConnection (const SoField *fromfield)
virtual SbBool read (SoInput *input, const SbName &name)
virtual void write (SoOutput *out, const SbName &name) 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)

🙈 Protected Attributes

SoEngine * value

🧚 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
virtual SoNotRec createNotRec (SoBase *cont)

---

💖 Detailed Description 💖

okay so SoSFEngine is a container for a single engine. one. uno. that's the whole assignment and it ate. 🔥

This field container stores a pointer to a Coin engine. It takes care of the necessary functionality for handling copy, import and export operations. bestie it's doing the emotional labor so you don't have to. 🫶

🚨 note that the engine pointer stored in a field instance of this type may be a NULL pointer. yes, fr fr, it can just be null. it's fine. it's fine!! 😭

See also

• SoEngine
• SoMFEngine

---

📚 Member Function Documentation 📚

void * SoSFEngine::createInstance (void ) [static]

ngl this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like, don't touch it unless you're built different. 💅

Creates a new instance of the class type corresponding to the SoType object.

SoType SoSFEngine::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. it's literally the class's little ID card. 🎀

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

Returns the type identification of an object derived from a class inheriting SoField. This is used for runtime type checking and "downward" casting.

Implements SoField. (yes queen, fulfill that contract. 👑)

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

Copy value(s) from f into this field. f must be of the same type as this field. no mixing, no matching, we're not doing that today. 🚫

Implements SoField.

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

Check for equal type and value(s). vibe check but make it type-safe. ✨

Implements SoField.

void SoSFEngine::initClass (void ) [static]

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system. behind-the-scenes queen behavior, we love her. 💅

void SoSFEngine::fixCopy (SbBool copyconnections) [virtual]

This method is internally called after SoField::copyFrom() during scene graph copies, and should do the operations necessary for fixing up the field instance after it has gotten a new value.

The default method in the SoField superclass does nothing. (she's off the clock bestie. 😌)

The application programmer should normally not need to consider this method, unless he constructs a complex field type which contains new references to container instances (i.e. nodes or engines). Overriding this method is then necessary to update the reference pointers, as they could have been duplicated during the copy operation.

Reimplemented from SoField.

SbBool SoSFEngine::referencesCopy (void ) const [virtual]

Returns TRUE if this field has references to any containers in the scene graph which are also duplicated during the copy operation.

⚠️ note that this method only is valid to call during copy operations. do not call it at a random time. do not pass go. 😤

See also the note about the relevance of the fixCopy() method for application programmers, as it is applicable on this method as well.

Reimplemented from SoField.

---

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code. (she was written by a robot and she's still slaying, iconic. 🤖✨)

---

and that's the whole page bestie!! this one's from Coin, version 4.0.10, dated Thu Jun 25 2026 00:00:00 — so you know exactly which era of the timeline you're reading. go forth and hold exactly one engine pointer at a time. periodt. 💖🦋🌸