SoLinearProfile(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoLinearProfile(3) — Library Functions Manual, but make it cute 💖

okay so bestie, welcome to the glow-up of SoLinearProfile(3). This is the manual page for the SoLinearProfile node, and by the end of it you're gonna be so comfy with linear profile curves it's unreal. Let's go 🦋

✨ NAME ✨

SoLinearProfile — The SoLinearProfile class is a node for specifying linear profile curves. That's the whole vibe. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoLinearProfile.h>

Inherits SoProfile. (so it's got family, iykyk 🫶)

💜 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoLinearProfile (void)
  • virtual void getTrimCurve (SoState *state, int32_t &numpoints, float *&points, int &floatspervec, int32_t &numknots, float *&knotvector)
  • virtual void getVertices (SoState *state, int32_t &numvertices, SbVec2f *&vertices)

🫶 Public Member Functions inherited from SoProfile

these are the ones it gets from its parent, no cap:

  • virtual void doAction (SoAction *action)
  • 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)

🧚 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 SoProfile

  • 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)

🔒 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoLinearProfile ()

🔒 Protected Member Functions inherited from SoProfile

  • SoProfile (void)
  • virtual ~SoProfile ()

🔒 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 SoProfile

  • 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

Public Types inherited from SoProfile:

  • 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 Attributes inherited from SoProfile:

  • SoMFInt32 index
  • SoSFEnum linkage

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 SoLinearProfile class is a node for specifying linear profile curves. Iconic.

Use nodes of this type if you want to set up profiles that are simply straight lines connected by control points. That's it, that's the whole job — straight lines, control points, slay. ✨

FILE FORMAT/DEFAULTS:

LinearProfile {
    index 0
    linkage START_FIRST
}

🎀 Constructor & Destructor Documentation 🎀

💖 SoLinearProfile::SoLinearProfile (void )

Constructor.

References SoLinearProfile().

Referenced by getFieldData(), and SoLinearProfile().

💖 SoLinearProfile::~SoLinearProfile () [protected], [virtual]

Destructor.

bestie, note the [protected], [virtual] up there — that's not me being extra, that's literally what the page says. 👑

💖 Member Function Documentation 💖

✨ SoType SoLinearProfile::getTypeId (void ) const [virtual] ✨

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

okay bestie so this one hands you back the type identification of any object that descends from SoBase. what's it for? run-time type checking and "downward" casting, periodt. it's giving "who am i really" energy 💅

Usage example, no cap:

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
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others — listen up, this method needs to be overridden in all subclasses. fr fr. you literally cannot skip it. this is typically done 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 (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. 🫶

want more tea on writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. 📚

Reimplemented from SoProfile.

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

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

this cutie returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. that's it, that's the whole thing 💀 (and yes it's [protected] and [virtual], both, iconic behavior)

Reimplemented from SoProfile.

References SoLinearProfile().

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

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

short and sweet: return points and knotvector of the state. slay. ✨

Implements SoProfile.

References SbList< Type >::append(), SbList< Type >::getArrayPtr(), SoProfile::index, SoDebugError::postWarning(), and SbList< Type >::truncate().

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

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

and this one? return vertex set of state. chef's kiss, no notes 👑

Implements SoProfile.

References SbList< Type >::append(), SbList< Type >::getArrayPtr(), SoProfile::index, SoDebugError::postWarning(), and SbList< Type >::truncate().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page bestie, we ate and left absolutely no crumbs 💅 this little love letter to SoLinearProfile(3) came straight from Coin, Version 2.5.0 — go forth and profile your lines linearly, you main character 🎀✨🦋

📦 where this page comes from