SoProfile(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoProfile(3) 💖 — Library Functions Manual 🎀

okay bestie, welcome to SoProfile(3), she's a whole icon in the Library Functions Manual and we're gonna get you so acquainted 🫶

✨ NAME ✨

SoProfile — bestie, this is the abstract superclass for profile definitions. she's not out here doing the work herself, she's the blueprint that all the profile girlies inherit from 💅

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoProfile.h>

She inherits SoNode. 💫

She's inherited by SoLinearProfile, and SoNurbsProfile. (her daughters, obsessed with them 🌈)

🎀 Public Types 🎀

  • enum Profile — { START_FIRST = SoProfileElement::START_FIRST, START_NEW = SoProfileElement::START_NEW, ADD_TO_CURRENT = SoProfileElement::ADD_TO_CURRENT }

🦋 Public Types inherited from SoNode 🦋

  • enum NodeType — { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000 }

🌟 Public Member Functions 🌟

  • virtual SoType getTypeId (void) const — tells you what type she is, iykyk
  • virtual void doAction (SoAction *action) — the action-handling moment
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void getTrimCurve (SoState *state, int32_t &numpoints, float *&points, int &floatspervec, int32_t &numknots, float *&knotvector)=0 — note the =0 bestie, she's pure virtual, so you literally cannot skip this one 😭
  • virtual void getVertices (SoState *state, int32_t &numvertices, SbVec2f *&vertices)=0 — also =0, also mandatory, no skipping 💀

💜 Public Member Functions inherited from SoNode 💜

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=0) const
  • virtual SbBool affectsState (void) const
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • uint32_t getNodeId (void) const
  • virtual SoChildList * getChildren (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • virtual SoFieldContainer * copyThroughConnection (void) const

🍓 Public Member Functions inherited from SoFieldContainer 🍓

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (const SbName &name) const
  • SbBool getFieldName (const SoField *const field, SbName &name) const
  • SbBool enableNotify (const SbBool flag)
  • SbBool isNotifyEnabled (void) const
  • SbBool set (const char *fielddata, SoInput *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn (void) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

🧚 Public Member Functions inherited from SoBase 🧚

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • SbBool isOfType (SoType type) const
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

⭐ Static Public Member Functions ⭐

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

🌈 Static Public Member Functions inherited from SoNode 🌈

  • static uint32_t getCompatibilityTypes (const SoType &nodetype)
  • static SoType getClassTypeId (void)
  • static SoNode * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoNodeList &l)
  • static void initClass (void)
  • static void initClasses (void)
  • static uint32_t getNextNodeId (void)
  • static int getActionMethodIndex (const SoType type)
  • static void getBoundingBoxS (SoAction *action, SoNode *node)
  • static void GLRenderS (SoAction *action, SoNode *node)
  • static void callbackS (SoAction *action, SoNode *node)
  • static void getMatrixS (SoAction *action, SoNode *node)
  • static void handleEventS (SoAction *action, SoNode *node)
  • static void pickS (SoAction *action, SoNode *node)
  • static void rayPickS (SoAction *action, SoNode *node)
  • static void searchS (SoAction *action, SoNode *node)
  • static void writeS (SoAction *action, SoNode *node)
  • static void audioRenderS (SoAction *action, SoNode *node)
  • static void getPrimitiveCountS (SoAction *action, SoNode *node)

💫 Static Public Member Functions inherited from SoFieldContainer 💫

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone (void)

🎀 Static Public Member Functions inherited from SoBase 🎀

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *in)

🫶 Public Attributes 🫶

  • SoMFInt32 index
  • SoSFEnum linkage

🌸 Protected Member Functions 🌸

  • virtual const SoFieldData * getFieldData (void) const
  • SoProfile (void) — protected, so you don't get to just make one directly bestie
  • virtual ~SoProfile () — also protected

🦋 Protected Member Functions inherited from SoNode 🦋

  • SoNode (void)
  • virtual ~SoNode ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

💜 Protected Member Functions inherited from SoFieldContainer 💜

  • SoFieldContainer (void)
  • ~SoFieldContainer ()

🍓 Protected Member Functions inherited from SoBase 🍓

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const

⭐ Static Protected Member Functions ⭐

  • static const SoFieldData ** getFieldDataPtr (void)

🌈 Static Protected Member Functions inherited from SoNode 🌈

  • static const SoFieldData ** getFieldDataPtr (void)
  • static void setNextActionMethodIndex (int index)
  • static int getNextActionMethodIndex (void)
  • static void incNextActionMethodIndex (void)
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

🧚 Static Protected Member Functions inherited from SoBase 🧚

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

✨ Additional Inherited Members ✨

Protected Types inherited from SoBase:

  • enum BaseFlags — { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Protected Attributes inherited from SoNode:

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer:

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode:

  • static uint32_t nextUniqueId = 0
  • static int nextActionMethodIndex = 0

💅 Detailed Description 💅

The SoProfile class is the abstract superclass for profile definitions. like we said, she's the blueprint, the origin story, the moment before the moment 🎀

Node subclasses of SoProfile specifies profiles for extruded 3D text and nurbs surface data. so basically if you're out here doing extruded 3D text or nurbs surface stuff, this is your girl 🌸

🎀 Member Enumeration Documentation 🎀

🌟 enum SoProfile::Profile 🌟

Enumeration of various choices of how to link together multiple profiles. the whole "how do we glue these profiles together" situation 💫

Enumerator:

  • START_FIRST — Replace the current profile state set with this profile alone. so it clears the vibes and puts this one front and center, periodt 👑
  • START_NEW — Append this profile to the state as a new profile. new profile just dropped ✨
  • ADD_TO_CURRENT — Append indices of this node to the last profile. she's joining the existing group chat, not starting a new one 🫶

🌈 Constructor & Destructor Documentation 🌈

💖 SoProfile::SoProfile (void ) [protected] 💖

Constructor.

References ADD_TO_CURRENT, index, linkage, SoProfile(), START_FIRST, and START_NEW.

Referenced by getFieldData(), getVertices(), and SoProfile().

🦋 SoProfile::~SoProfile () [protected], [virtual] 🦋

Destructor. she's leaving the building but doing it properly 💅

🦋 Member Function Documentation 🦋

okay bestie, this is where the actual functions live. every single one of them. no skipping. 💅

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

the identity check function ✨ — it hands you back the type identification of an object derived from a class that inherits SoBase. this is what powers run-time type checking and those "downward" casts everyone's always whispering about. 👑

Usage example, literally copied so you can't mess it up:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

so if you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. no exceptions, bestie, it's giving mandatory. 🙈

you typically do that as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. the macros are lowkey doing the most so you don't have to. 🫶

for more info on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. ✨

  • Implements SoBase.
  • Reimplemented in SoLinearProfile, and SoNurbsProfile.

const SoFieldData * SoProfile::getFieldData (void ) const [protected], [virtual]

gives you a pointer to the class-wide field data storage object for this instance. that's it, that's the whole vibe. 💖

if no fields are present, it returns NULL. NULL. nothing. empty. ghosted. 😭

  • Reimplemented from SoFieldContainer.
  • Reimplemented in SoLinearProfile, and SoNurbsProfile.
  • References SoProfile().

void SoProfile::doAction (SoAction * action) [virtual]

this one performs the typical operation of a node for any action. the all-rounder. the main character of action-handling. 👑

  • Reimplemented from SoNode.
  • References SoAction::getState().
  • Referenced by callback(), getBoundingBox(), getPrimitiveCount(), GLRender(), and pick().

void SoProfile::callback (SoCallbackAction * action) [virtual]

action method for SoCallbackAction. 🎀

basically it just updates the state according to how the node behaves for the render action, so you the application programmer can use SoCallbackAction for extracting information about the scene graph. it's giving "just here to keep the state cute". 💅

  • Reimplemented from SoNode.
  • References doAction().

void SoProfile::GLRender (SoGLRenderAction * action) [virtual]

action method for the SoGLRenderAction. 🔥

this gets called during rendering traversals. any node that influences the rendering state in any way, or who wants to throw geometry primitives at OpenGL, overrides this method. so like, if your node is a diva about how things get drawn, this is where it says so. ✨

  • Reimplemented from SoNode.
  • References doAction().

void SoProfile::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

action method for the SoGetBoundingBoxAction. 🌸

calculates bounding box and center coordinates for the node, and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. it's literally recentering the whole situation. 🧚

nodes that influence how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

  • Reimplemented from SoNode.
  • References doAction().

void SoProfile::pick (SoPickAction * action) [virtual]

action method for SoPickAction. 🍓

does the common processing for SoPickAction action instances. shared responsibilities, we love to see it.

  • Reimplemented from SoNode.
  • References doAction().

void SoProfile::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

action method for the SoGetPrimitiveCountAction. ⭐

calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. math girlies rise. 💜

nodes that influence how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

  • Reimplemented from SoNode.
  • References doAction().

virtual void SoProfile::getTrimCurve (SoState * state, int32_t & numpoints, float *& points, int & floatspervec, int32_t & numknots, float *& knotvector) [pure virtual]

returns points and knotvector of the state. short and sweet, as it should be. 🎀

  • Implemented in SoLinearProfile, and SoNurbsProfile.

virtual void SoProfile::getVertices (SoState * state, int32_t & numvertices, SbVec2f *& vertices) [pure virtual]

returns the vertex set of the state. the vertices. the moment. the geometry. ✨

  • Implemented in SoLinearProfile, and SoNurbsProfile.
  • References SoProfile().
  • Referenced by SoText3::computeBBox().

💖 Member Data Documentation 💖

SoMFInt32 SoProfile::index

profile coordinate indices. 🦋

these must match what is available from previous SoProfileCoordinate2 and SoProfileCoordinate3 nodes in the traversal. no cap, if they don't match it's a whole thing. 💀

  • Referenced by SoLinearProfile::getTrimCurve(), SoNurbsProfile::getTrimCurve(), SoLinearProfile::getVertices(), and SoProfile().

SoSFEnum SoProfile::linkage

how the indices of this profile node should be combined with the current profile index set of the traversal state. the "how do these two vibes merge" setting. 🌈

default value is SoProfile::START_FIRST. 👑

  • Referenced by SoProfile().

👑 Author 👑

generated automatically by Doxygen for Coin from the source code. yeah, the robots wrote it, and honestly? they ate. 💅

and that's a wrap on SoProfile(3), bestie!! this page is from Coin, Version 2.5.0, dated SoProfile(3) — go forth and profile your little heart out. mwah. 💖✨🎀
📦 where this page comes from