SoCoordinate4(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 SoCoordinate4 🎀

okay so we're doing SoCoordinate4(3) today bestie, straight out of the Library Functions Manual, and honestly? she's giving coordinate queen ✨

✨ NAME ✨

SoCoordinate4 — the node class that hands coordinates over to shape nodes. that's it, that's the job 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoCoordinate4.h>

Inherits SoNode. yes queen, she's part of the family tree 🌳

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • SoCoordinate4 (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)
  • 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 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 🌸

  • SoMFVec4f point — the main character, lowkey 🫶

💅 Protected Member Functions 💅

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

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

SoCoordinate4 is that girl who provides coordinates to shape nodes. periodt.

When traversal runs into nodes of this type, the coordinates it's holding get put onto the statestack so that shape nodes needing coordinate sets can grab them later — think SoFaceSet nodes or SoPointSet nodes 👑

The fourth element of the coordinate vectors is doing normalization duty. And here's the tea: a node of this type where all the normalization values equal 1.0 is literally equivalent to setting up an SoCoordinate3 node. same energy, different class bestie 💅

⚠️ heads up: an SoCoordinate4 node will replace whatever coordinates are already chilling in the state (if there are any). no stacking, no merging, she replaces. 🫢

📄 FILE FORMAT/DEFAULTS 📄

Coordinate4 {
    point 0 0 0 1
}

👀 See also 👀

  • SoCoordinate3

🛠 Constructor & Destructor Documentation 🛠

🌟 SoCoordinate4::SoCoordinate4 (void ) 🌟

Constructor. the origin story ✨

References point, and SoCoordinate4().

Referenced by getFieldData(), and SoCoordinate4().

💀 SoCoordinate4::~SoCoordinate4 () [protected], [virtual] 💀

Destructor. she's logging off 😭 (but protectively, and virtually)

💖 Member Function Documentation 💖

🌟 SoType SoCoordinate4::getTypeId (void ) const [virtual]

Okay bestie, this one is the identity check of the whole object world. It hands you back the type identification of anything derived from SoBase, which is what makes run-time type checking and "downward" casting possible. iykyk.

Usage example, and yes this is verbatim, don't touch it:

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

Now for the application programmers out there 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. Not optional, periodt. Normally you do it as part of setting up the full type system for your extension classes, and the usual move is using the pre-defined macros you get 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.

Want the full tea on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. 🫶

Implements SoBase.

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

Gives you back a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? It returns NULL. That's it, that's the whole vibe. 💀

Reimplemented from SoFieldContainer.

References SoCoordinate4().

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

This is the function that does the typical operation of a node for any action. The main character of action-handling, fr fr. 👑

Reimplemented from SoNode.

References SoAction::getState(), and point.

Referenced by callback(), getBoundingBox(), getPrimitiveCount(), GLRender(), and pick().

🎀 void SoCoordinate4::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. This one 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. Slay. 🌈

Reimplemented from SoNode.

References doAction(), SoAction::getState(), point, SoBase::staticDataLock(), and SoBase::staticDataUnlock().

🦋 void SoCoordinate4::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 so it encompasses the bounding box for this node — and so it shifts the center point for the scene more towards the one for this node. Big "make room for me" energy. 💅

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 SoCoordinate4::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. Lowkey just passing the info along, but it's essential. ✨

Reimplemented from SoNode.

References doAction().

💜 void SoCoordinate4::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

Does the common processing for SoPickAction action instances. No notes, it just handles it. 🙈

Reimplemented from SoNode.

References doAction().

🧚 void SoCoordinate4::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. Counting era, honestly iconic. ⭐

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().

🌈 Member Data Documentation 🌈

👑 SoMFVec4f SoCoordinate4::point

The coordinate set of 3D points as 4D vectors — each vector contains a 3D coordinate plus a normalization value. That's the whole point. Literally. 😭

Referenced by doAction(), GLRender(), and SoCoordinate4().

💫 Author 💫

Generated automatically by Doxygen for Coin from the source code. (Not a human bestie, but it did its thing. 🫶)

okay that's the whole page bestie, you made it to the end!! 🎉 this one is from Coin, Version 2.5.0, and it's the SoCoordinate4(3) page. go forth and build cute 4D coordinate nodes, mwah 💖🌸✨

📦 where this page comes from