SoSFEngine(3)

📦 version 3.1.3, in fedora 43, fedora 44

👑 SoSFEngine — the manual page, but make it cute

Okay bestie, this is the manual page for SoSFEngine(3) from the Library Functions Manual. It's a Coin thing. Buckle up, it's giving ✨pointer energy✨ and we're gonna read the whole thing together, no skipping. 💖

🌸 NAME

SoSFEngine — a container for a single engine. One. Uno. That's the entire job description, and she does it flawlessly. 💅

✨ SYNOPSIS

#include <Inventor/fields/SoSFEngine.h>

Inherits SoSField. (She's a subclass, she's got lineage, she's iconic.)

💅 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

🦋 Detailed Description

The SoSFEngine class is a container for a single engine. Say it with me now: one engine. 🫶

This field container stores a pointer to a Coin engine. It takes care of the necessary functionality for handling copy, import and export operations. She's the responsible friend who handles all the logistics 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 bestie, NULL. It's allowed. It's valid. Don't panic. 💀

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.

See also

getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. Heads up: f must be of the same type as this field. No mix-and-match, that's the rule. 💅

Implements SoField.

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

Check for equal type and value(s). Basically the vibe check — are you the same type, are you the same value, do we match? ✨

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. Literally nothing. It's giving minimal effort, and honestly, valid. 🙈

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. Timing matters, bestie. ⏰

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.

🌟 Author

Generated automatically by Doxygen for Coin from the source code. No human wrote this by hand, she was born from a build script and she's thriving. 👑

That's the whole page, bestie — you read it all, I'm so proud of you. 🫶 This one came from Coin, Version 3.1.3, and it's filed under SoSFEngine(3). Go forth and containerize exactly one engine. Periodt. 💖✨

📦 where this page comes from