SoProfileCoordinate2(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 SoProfileCoordinate2 🎀

Bestie. Welcome to SoProfileCoordinate2(3) from the Library Functions Manual. Yes she's a C++ class, yes she lives in Coin/Inventor land, and yes she's about to be your new hyperfixation. Let's go 💖

🌸 NAME 🌸

SoProfileCoordinate2 — the class that is a node, and that node's whole thing is specifying a set of 2D coordinates for profiles. That's it. That's the assignment. Slay.

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoProfileCoordinate2.h>

Inherits SoNode. So she's got the whole SoNode bloodline behind her, and we're gonna list every single relative, no skipping, fr fr.

💅 Public Member Functions

virtual SoType getTypeId (void) const
SoProfileCoordinate2 (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *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=FALSE) 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=FALSE)
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 *input)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool getIsBuiltIn (void) const
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) 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 cleanupClass (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 *input, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *input)

🍓 Public Attributes

  • SoMFVec2f point — yeah, this is the whole point field. Literally. 💅

🎀 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
virtual ~SoProfileCoordinate2 ()

🎀 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)
virtual ~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

  • Public Types inherited from SoNode — an enum, and it's a long one, no cap:
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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }
  • 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 = 1, static int nextActionMethodIndex = 0

🔥 Detailed Description 🔥

So SoProfileCoordinate2 is a node, and that node specifies a set of 2D coordinates for profiles. Iconic behaviour, honestly.

Use nodes of this type to provide coordinates to profiles. That's the vibe. That's the whole gig.

⚠️ Heads up bestie, this one matters: an SoProfileCoordinate2 node will replace the profile coordinates already present in the state (if any). Not merge, not vibe-check, not negotiate — replace. So if there were coordinates chilling in the state already, they're gone. 💀

FILE FORMAT/DEFAULTS:

ProfileCoordinate2 {
    point 0 0
}

See also: SoProfile, SoProfileCoordinate3 — the sibling and the 3D cousin, go say hi 🫶

🔥 Constructor & Destructor Documentation 🔥

SoProfileCoordinate2::SoProfileCoordinate2 (void )

Constructor. She's born. 💖

SoProfileCoordinate2::~SoProfileCoordinate2 () [protected], [virtual]

Destructor. She's protected, she's virtual, she's leaving the group chat.

and there's more where that came from, bestie — part 2 is loading ⏳💅

💖 Member Function Documentation 💖

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

okay so bestie, this one hands you back the type identification of any object derived from a class that inherits SoBase. what's it for? run-time type checking and "downward" casting. that's it, that's the job. 🎀

Usage example, straight up:

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

see that comment? safe downward cast. because now you actually KNOW the type. no vibes-based casting here. 💅

now for the app programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else you're cooking up: this method needs to be overridden in all subclasses. no skipping it, it's not optional. this is typically done as part of setting up the full type system for extension classes, and it's usually accomplished by using the pre-defined macros available through, for instance:

  • Inventor/nodes/SoSubNode.h — with SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes
  • Inventor/engines/SoSubEngine.h — for engine classes
  • and so on 🌈

for more info on writing Coin extensions, go check the class documentation of the toplevel superclasses for the various class groups. the lore is there, i promise. 📚

Implements SoBase.

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

this one 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. short king of a function. 👑

Reimplemented from SoFieldContainer.

✨ void SoProfileCoordinate2::doAction (SoAction * action) [virtual] ✨

this function performs the typical operation of a node for any action. generic, does the thing, no notes. ✨

Reimplemented from SoNode.

✨ void SoProfileCoordinate2::GLRender (SoGLRenderAction * action) [virtual] ✨

action method for the SoGLRenderAction. 🎨

this is called during rendering traversals. nodes that influence the rendering state in any way, or who just wanna throw geometry primitives at OpenGL, override this method. that's the whole assignment bestie.

Reimplemented from SoNode.

✨ void SoProfileCoordinate2::callback (SoCallbackAction * action) [virtual] ✨

action method for SoCallbackAction.

it simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. giving you the tea about your own scene graph, iconic behavior honestly. 🫶

Reimplemented from SoNode.

✨ void SoProfileCoordinate2::pick (SoPickAction * action) [virtual] ✨

action method for SoPickAction.

does common processing for SoPickAction action instances. common processing!! the shared workload!! we love a collaborative queen. 💖

Reimplemented from SoNode.

✨ void SoProfileCoordinate2::getBoundingBox (SoGetBoundingBoxAction * action) [virtual] ✨

action method for the SoGetBoundingBoxAction. 📦

it calculates the 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. so it's not just reporting where it is, it's literally nudging the scene's center point toward itself. main character energy fr fr. 💅

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

Reimplemented from SoNode.

✨ void SoProfileCoordinate2::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual] ✨

action method for the SoGetPrimitiveCountAction. 🔢

it calculates the number of triangle, line segment and point primitives for the node, and adds these to the counters of the action. tallying it UP. 📈

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

Reimplemented from SoNode.

🎀 Member Data Documentation 🎀

✨ SoMFVec2f SoProfileCoordinate2::point ✨

pool of coordinate points for the traversal state. that's the data member, that's what it holds, no notes. 🦋

🌸 Author 🌸

generated automatically by Doxygen for Coin, straight from the source code. the robots wrote this one, i just gave it a glow-up. 💅✨

okay bestie that's the whole page!! this doc is for Coin Version 3.1.3, tagged as SoProfileCoordinate2(3) and dated accordingly — so if you're reading this on some other version, maybe double check, okay? 😭 go forth and coordinate those profiles, you absolute legend. 🫶💖🎀🦋🌸👑

📦 where this page comes from