SoMFEngine(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 NAME 💖

SoMFEngine — the Coin manual's class that's literally a container for engines. no cap, it holds them all. periodt. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoMFEngine.h>

Inherits SoMField.

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoMFEngine & operator= (const SoMFEngine &field)
  • virtual SbBool isSame (const SoField &field) const
  • SoEngine * operator[] (const int idx) const
  • const SoEngine ** getValues (const int start) const
  • int find (SoEngine *value, SbBool addifnotfound=FALSE)
  • void setValues (const int start, const int num, const SoEngine **newvals)
  • void set1Value (const int idx, SoEngine *value)
  • void setValue (SoEngine *value)
  • SoEngine * operator= (SoEngine *val)
  • SbBool operator== (const SoMFEngine &field) const
  • SbBool operator!= (const SoMFEngine &field) const
  • SoEngine ** startEditing (void)
  • void finishEditing (void)
  • virtual void fixCopy (SbBool copyconnections)
  • virtual SbBool referencesCopy (void) const
  • virtual void deleteValues (int start, int num=-1)
  • virtual void insertSpace (int start, int num)

✨ Public Member Functions inherited from SoMField ✨

  • virtual ~SoMField () — inherited from SoMField
  • int getNum (void) const — inherited from SoMField
  • void setNum (const int num) — inherited from SoMField
  • SbBool set1 (const int index, const char *const valuestring) — inherited from SoMField
  • void get1 (const int index, SbString &valuestring) — inherited from SoMField
  • virtual void enableDeleteValues (void) — inherited from SoMField
  • virtual SbBool isDeleteValuesEnabled (void) const — inherited from SoMField

✨ Public Member Functions inherited from SoField ✨

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

✨ Static Public Member Functions ✨

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

✨ Static Public Member Functions inherited from SoMField ✨

  • static SoType getClassTypeId (void) — inherited from SoMField
  • static void atexit_cleanup (void) — inherited from SoMField
  • static void initClass (void) — inherited from SoMField

✨ Static Public Member Functions inherited from SoField ✨

  • static void initClass (void) — inherited from SoField
  • static void initClasses (void) — inherited from SoField
  • static void cleanupClass (void) — inherited from SoField
  • static SoType getClassTypeId (void) — inherited from SoField

✨ Protected Member Functions ✨

  • virtual void deleteAllValues (void)
  • virtual void copyValue (int to, int from)
  • virtual int fieldSizeof (void) const
  • virtual void * valuesPtr (void)
  • virtual void setValuesPtr (void *ptr)
  • virtual void allocValues (int num)

✨ Protected Member Functions inherited from SoMField ✨

  • SoMField (void) — inherited from SoMField
  • virtual void makeRoom (int newnum) — inherited from SoMField
  • virtual SoNotRec createNotRec (SoBase *container) — inherited from SoMField
  • void setChangedIndex (const int chgidx) — inherited from SoMField
  • void setChangedIndices (const int chgidx=-1, const int numchgind=0) — inherited from SoMField

✨ Protected Member Functions inherited from SoField ✨

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

✨ Protected Attributes ✨

  • SoEngine ** values

✨ Protected Attributes inherited from SoMField ✨

  • int num — inherited from SoMField
  • int maxNum — inherited from SoMField
  • SbBool userDataIsUsed — inherited from SoMField

✨ Additional Inherited Members ✨

Public Types inherited from SoField

  • enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD, EVENTOUT_FIELD, EXPOSED_FIELD } — inherited from SoField

✨ Detailed Description ✨

SoMFEngine is a container for engines. that's the whole mood. 💅

This field container stores an array of pointers to engines. it takes care of the necessary functionality for handling copy, import and export operations. so you don't have to, bestie. 🫶

Note that engine pointers stored in field instances of this type may be NULL pointers. yes, NULL. it's valid.

See also: SoEngine, SoSFEngine — go give them a read, iykyk. ✨

💅 Member Function Documentation 💅

💅 void * SoMFEngine::createInstance (void ) [static] 💅

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

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

💅 SoType SoMFEngine::getClassTypeId (void ) [static] 💅

This static method returns the SoType object associated with objects of this class.

💅 SoType SoMFEngine::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.

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

Copy value(s) from f into this field. f must be of the same type as this field.

Implements SoField.

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

Check for equal type and value(s).

Implements SoField.

💅 virtual void SoMFEngine::deleteAllValues (void ) [protected], [virtual] 💅

Implements SoMField.

💅 virtual void SoMFEngine::copyValue (int to, int from) [protected], [virtual] 💅

Implements SoMField.

💅 const SoEngine ** SoMFEngine::getValues (const int start) const [inline] 💅

Returns a pointer to the values array.

💅 void SoMFEngine::initClass (void ) [static] 💅

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

💅 void SoMFEngine::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.

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 SoMFEngine::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.

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.

💅 virtual void SoMFEngine::deleteValues (int start, int numarg = -1) [virtual] 💅

Remove value elements from index start up to and including index start + num - 1.

Elements with indices larger than the last deleted element will be moved downwards in the value array.

If num equals -1, delete from index start and to the end of the array.

Reimplemented from SoMField.

💅 virtual void SoMFEngine::insertSpace (int start, int numarg) [virtual] 💅

Insert num "slots" for new value elements from start. The elements already present from start will be moved "upward" in the extended array.

Reimplemented from SoMField.

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code. slay. ✨

Version 4.0.10 — Thu Jun 25 2026 00:00:00 — SoMFEngine(3). that's the tea, bestie. stay iconic. 💖🦋🌸

📦 where this page comes from