SoSFEngine(3)

📦 version 2.5.0, in fedora 43, fedora 44

🌸 SoSFEngine 🌸

okay so welcome to the SoSFEngine(3) page bestie 💖 it lives in the Library Functions Manual and it is genuinely so iconic, no cap.

✨ NAME ✨

SoSFEngine — the class that is literally just a container for a single engine. one engine. that's the whole vibe. 🎀

✨ SYNOPSIS ✨

#include <Inventor/fields/SoSFEngine.h>

Inherits SoSField. 👑

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 def)
  • SbBool isDefault (void) const
  • SbBool isOfType (const SoType type) const
  • void enableConnection (SbBool flag)
  • SbBool isConnectionEnabled (void) const
  • SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=0, SbBool append=0)
  • SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=0)
  • void disconnect (SoEngineOutput *engineoutput)
  • SbBool isConnectedFromEngine (void) const
  • SbBool getConnectedEngine (SoEngineOutput *&master) const
  • SbBool connectFrom (SoField *master, SbBool notnotify=0, SbBool append=0)
  • SbBool appendConnection (SoField *master, SbBool notnotify=0)
  • 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 *in, 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 Public Member Functions inherited from SoField

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

Protected Attributes

  • SoEngine * value

Friends

  • class SoMFEngine

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=1)
  • virtual void evaluateConnection (void) const
  • virtual SbBool readConnection (SoInput *in)
  • virtual void writeConnection (SoOutput *out) const
  • SbBool isDestructing (void) const

💅 Detailed Description 💅

The SoSFEngine class is a container for a single engine. yes, that is the whole personality and honestly? slay. 🌈

This field container stores a pointer to a Coin engine. It takes care of the necessary functionality for handling copy, import and export operations. so like, all the annoying bookkeeping? handled. you're welcome. ✨

⚠️ bestie listen — note that the engine pointer stored in a field instance of this type may be a NULL pointer. so like, check before you dereference, fr fr. 💀

See also

  • SoEngine, SoMFEngine

🦋 Member Function Documentation 🦋

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's giving "who am I" but make it official. 💖

See also

  • getClassTypeId(), SoType

Implements SoField.

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. like, same type only, we don't do mismatches here. 🙈

Implements SoField.

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

Check for equal type and value(s). vibe check on both, basically. ✅

Implements SoField.

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. (iconic laziness honestly)

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. so like — unless you're out here building your own fancy field types, this is not your problem bestie. 🫶

Reimplemented from SoField.

References SoBase::assertAlive(), SoEngine::copy(), and SoFieldContainer::findCopy().

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. outside of that? undefined nonsense, do not.

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

Reimplemented from SoField.

References SoFieldContainer::checkCopy(), SoPath::getHead(), SoBase::isOfType(), and SoField::referencesCopy().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. 🤖 (not a human author, it's giving robot main character energy)

okay that's the whole page bestie, ily, go forth and contain exactly one engine 💜

Coin — Version 2.5.0 — SoSFEngine(3) 🦋✨ periodt.

📦 where this page comes from