SoMFPlane(3)

📦 version 3.1.3, in fedora 43, fedora 44

💅 SoMFPlane 💅

okay bestie, buckle up, because this is a page straight out of the Library Functions Manual and it's literally all about SoMFPlane(3). she's a container, she's a field, she's giving very much "I hold many planes" energy. let's get into it 🛫✨

🌸 NAME 🌸

SoMFPlane — the SoMFPlane class is a container for SbPlane values. periodt. 💖

✨ SYNOPSIS ✨

#include <Inventor/fields/SoMFPlane.h>

Inherits SoMField. (yes, she has a whole family tree, we'll get to that 🫶)

🎀 Public Member Functions 🎀

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoMFPlane & operator= (const SoMFPlane &field)
  • virtual SbBool isSame (const SoField &field) const
  • const SbPlane & operator[] (const int idx) const
  • const SbPlane * getValues (const int start) const
  • int find (const SbPlane &value, SbBool addifnotfound=FALSE)
  • void setValues (const int start, const int num, const SbPlane *newvals)
  • void set1Value (const int idx, const SbPlane &value)
  • void setValue (const SbPlane &value)
  • const SbPlane & operator= (const SbPlane &val)
  • SbBool operator== (const SoMFPlane &field) const
  • SbBool operator!= (const SoMFPlane &field) const
  • SbPlane * startEditing (void)
  • void finishEditing (void)

🌈 Public Member Functions inherited from SoMField 🌈

  • virtual ~SoMField ()
  • int getNum (void) const
  • void setNum (const int num)
  • virtual void deleteValues (int start, int num=-1)
  • virtual void insertSpace (int start, int num)
  • SbBool set1 (const int index, const char *const valuestring)
  • void get1 (const int index, SbString &valuestring)
  • virtual void enableDeleteValues (void)
  • virtual SbBool isDeleteValuesEnabled (void) const

🦋 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
  • 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 SoMField 💜

  • static SoType getClassTypeId (void)
  • static void atexit_cleanup (void)
  • static void initClass (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 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)
  • virtual void makeRoom (int newnum)

🌟 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

👑 Protected Attributes 👑

  • SbPlane * values

🎀 Protected Attributes inherited from SoMField 🎀

  • int num
  • int maxNum
  • SbBool userDataIsUsed

🌈 Additional Inherited Members 🌈

  • Public Types inherited from SoField:
enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD, EVENTOUT_FIELD,
    EXPOSED_FIELD }

💖 Detailed Description 💖

The SoMFPlane class is a container for SbPlane values.

This field is used where nodes, engines or other field containers needs to store multiple 3D plane definitions. like, she's the friend who holds everyone's plane tickets, no cap 🛫💅

See also

  • SoSFPlane

🔥 Member Function Documentation 🔥

⭐ SoType SoMFPlane::getTypeId (void ) const [virtual] ⭐

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's her ID card bestie, she never leaves home without it 🪪✨

See also

  • getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. f must be of the same type as this field. (mismatched types? not on her watch, that's a no 🙈)

Implements SoField.

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

Check for equal type and value(s). vibe check, but make it type-checked fr fr

Implements SoField.

🧚 void SoMFPlane::deleteAllValues (void ) [protected], [virtual] 🧚

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (iykyk, she's private-ish, don't text her 💀)

Implements SoMField.

🍓 void SoMFPlane::copyValue (int to, int from) [protected], [virtual] 🍓

This method is used for moving values around internally within a multivalue field. It needs to be overridden in each field so it automatically takes care of running copy contructors where necessary. (yes, "contructors" — that's the original spelling, we don't fix, we respect ✋😌)

Implements SoMField.

🌟 const SbPlane * SoMFPlane::getValues (const int start) const [inline] 🌟

Returns a pointer to the values array. hand her the keys to the whole plane garage 🔑✈️

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code. (the bots did that, she's just the messenger 💅)

okay bestie that's the whole page, no details skipped, we ate and left no crumbs 👑✨

Coin · Version 3.1.3 · SoMFPlane(3) — mwah, go write some fields 💖🦋🎀

📦 where this page comes from