SoVRMLCoordinate(3)

💖 SoVRMLCoordinate — Library Functions Manual 💖

okay so bestie, you opened SoVRMLCoordinate(3) and honestly? iconic choice. this is the page for the SoVRMLCoordinate class, and it lives in the Library Functions Manual. sit down, grab a boba, we're doing this together 🧋✨

---

🌸 NAME 🌸

SoVRMLCoordinate — the class that's literally here to define 3D coordinates for shapes. that's it, that's the job. she defines coordinates and she does it well 💅

---

✨ SYNOPSIS ✨

first things first, you gotta pull her in:

#include <Inventor/VRMLnodes/SoVRMLCoordinate.h>

she Inherits SoNode. like, that's her whole lineage, no cap. 🦋

👑 Public Member Functions

virtual SoType getTypeId (void) const
SoVRMLCoordinate (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *action)

💜 Public Member Functions inherited from SoNode

the way she got ALL of these from her parent... nepotism but make it C++:

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 getPrimitiveCount (SoGetPrimitiveCountAction *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

the OG great-grandmother of the whole family tree:

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

the one and only public field, the moment we've all been waiting for:

SoMFVec3f point

🔒 Protected Member Functions

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

🙈 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

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

🍓 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 💅

okay so the SoVRMLCoordinate class is used to define 3D coordinates for shapes. that's the whole vibe, that's the whole purpose, she's a coordinate definer, periodt. ✨

ngl the detailed class documentation here is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). it is copyright The Web3D Consortium, and it's used by permission of the Consortium. so yeah, shoutout to them, we respect the source 🫶

here's the node definition, look at her:

Coordinate {
  exposedField MFVec3f point  []      # (-inf, inf)
}

so this node defines a set of 3D coordinates, and those coordinates get used in the coord field of vertex-based geometry nodes. which nodes, you ask? bestie I got you, it's these three:

• SoVRMLIndexedFaceSet
• SoVRMLIndexedLineSet
• SoVRMLPointSet

if you're doing vertex-based geometry, she's your girl. if you're not... well. 💀

---

🎀 Constructor & Destructor Documentation 🎀

🌸 SoVRMLCoordinate::SoVRMLCoordinate (void )

this is the Constructor. it does constructor things. she's born. 🌱

References point, and SoVRMLCoordinate().

Referenced by getFieldData(), and SoVRMLCoordinate().

🥀 SoVRMLCoordinate::~SoVRMLCoordinate () [protected], [virtual]

this is the Destructor. it's [protected] and [virtual], so don't go calling it yourself from outside, bestie, that's not your business. she says goodbye on her own terms. 😭

💅 MEMBER FUNCTION DOCUMENTATION 💅

okay bestie, this is the part where we meet all the actual functions. each one's got its own little job and honestly? they're all kind of iconic in their own way. let's go 🫶

---

✨ SoType SoVRMLCoordinate::getTypeId (void ) const — [virtual]

so this one hands you back the type identification of any object that's derived from a class inheriting SoBase. what's it for? run-time type checking, and "downward" casting. that's the vibe check of the C++ world, fr fr.

here's the usage example, verbatim, no notes:

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

see how it's checking the type before casting? that's the whole point. no guessing, no chaos, just clean type knowledge. 👑

now — important — if you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers or whatever else your heart desires: this method needs to be overridden in all subclasses. all of them. no skipping. periodt.

usually you do that as part of setting up the full type system for your extension classes, and the standard way is 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, you get the pattern

want more on writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. that's where the real lore lives. 📚

Implements SoBase.

---

🌈 const SoFieldData * SoVRMLCoordinate::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 literally no fields present? it returns NULL. empty. nothing. a void. 💀

• Reimplemented from SoFieldContainer.
• References SoVRMLCoordinate().

---

🎀 void SoVRMLCoordinate::doAction (SoAction * action) — [virtual]

this is the function that performs the typical operation of a node for any action. the all-rounder. the main character that shows up for everything. ✨

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

---

🔥 void SoVRMLCoordinate::GLRender (SoGLRenderAction * action) — [virtual]

action method for the SoGLRenderAction. this one gets called during rendering traversals, bestie.

any node that influences the rendering state in any way — or who just wants to throw geometry primitives at OpenGL — overrides this method. that's the assignment. 🦋

• Reimplemented from SoNode.
• References doAction(), SoAction::getState(), point, SoBase::staticDataLock(), and SoBase::staticDataUnlock().

---

⭐ void SoVRMLCoordinate::getBoundingBox (SoGetBoundingBoxAction * action) — [virtual]

action method for the SoGetBoundingBoxAction. and yes it does exactly what the name says:

it calculates bounding box and center coordinates for the node, then 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.

and if a node influences how geometry nodes calculate their bounding box? it also overrides this method to change the relevant state variables. keeping it consistent, as one does. 💅

• Reimplemented from SoNode.
• References doAction().

---

💜 void SoVRMLCoordinate::callback (SoCallbackAction * action) — [virtual]

action method for SoCallbackAction. it simply 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. handy. lowkey essential. 🍓

• Reimplemented from SoNode.
• References doAction().

---

🌸 void SoVRMLCoordinate::pick (SoPickAction * action) — [virtual]

action method for SoPickAction. it does the common processing for SoPickAction action instances. that's it, that's the whole job, and it does it beautifully. 🙈

• Reimplemented from SoNode.
• References doAction().

---

💖 MEMBER DATA DOCUMENTATION 💖

🧚 SoMFVec3f SoVRMLCoordinate::point

the coordinates. that's it. and it's empty by default, so don't come crying when there's nothing there until you fill it in. 😭

• Referenced by SoVRMLIndexedLine::computeBBox(), SoVRMLIndexedShape::computeBBox(), SoVRMLVertexPoint::computeBBox(), doAction(), SoVRMLIndexedFaceSet::generateDefaultNormals(), SoVRMLPointSet::generatePrimitives(), SoVRMLVertexPoint::getPrimitiveCount(), GLRender(), and SoVRMLCoordinate().

---

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. so nobody hand-wrote this, a robot did it, and honestly? it ate. ✨

---

and that's the whole page, bestie — this was Coin, Version 2.5.0, documenting SoVRMLCoordinate(3). go forth and cast responsibly. mwah 💅💖