SoCoordinate4(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 NAME 💖

SoCoordinate4 — okay so this is the manual page for SoCoordinate4(3), and its whole entire personality is: it's a node that provides coordinates to shape nodes. That's the job. That's the assignment. She's a node full of coordinates and she's thriving. 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoCoordinate4.h>

Inherits SoNode. Yes bestie, it's a node, it said what it said. 🦋

🫶 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=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

  • SoMFVec4f point

That's the one field, bestie. The whole point of the node. Literally named point. 🎀

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

  • 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. The SoCoordinate4 class is a node for providing coordinates to shape nodes. That's the mission statement, periodt. ✨

When you're traversing your scene graph and you run into a node of this type, the coordinates it's holding get put onto the statestack for later use by shape nodes of the types that need coordinate sets — think SoFaceSet nodes or SoPointSet nodes, the girlies that actually consume them. 🫶

The fourth element of the coordinate vectors is used for normalization.</purl> Okay, and here's the cute part: if you have a node of this type where all the normalization values are equal to 1.0, that's the equivalent of setting up an SoCoordinate3 node. Same energy, different class. 💅

⚠️ Heads up bestie: note that an SoCoordinate4 node will replace the coordinates already present in the state (if any). Not merge. Not blend. Replace. She's not sharing the statestack, she's taking it. 😭

📄 FILE FORMAT/DEFAULTS:

Coordinate4 {
    point 0 0 0 1
}

👀 See also

  • SoCoordinate3

🎀 Constructor & Destructor Documentation 🎀

💖 SoCoordinate4::SoCoordinate4 (void )

Constructor. She's born. 🦋

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

Destructor. She's protected, she's virtual, she's saying goodbye. 💜

okay and that's where this part wraps — but we are so not done, because there's more of this page coming and she has more to say. 🌈

💖 Member Function Documentation 💖

okay bestie, here's the whole menu of member functions for SoCoordinate4. each one is a little vibe, but they all do important stuff. let's get into it. 💅

  • SoType SoCoordinate4::getTypeId (void ) const [virtual] — so this one returns the type identification of an object derived from a class inheriting SoBase. it's literally used for run-time type checking and "downward" casting. iconic.

Usage example:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. 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 (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

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

Implements SoBase.

  • const SoFieldData * SoCoordinate4::getFieldData (void ) const [protected], [virtual] — returns a pointer to the class-wide field data storage object for this instance. if no fields are present, returns NULL. no cap.

Reimplemented from SoFieldContainer.

  • void SoCoordinate4::doAction (SoAction * action) [virtual] — this function performs the typical operation of a node for any action. main character energy fr fr.

Reimplemented from SoNode.

  • void SoCoordinate4::GLRender (SoGLRenderAction * action) [virtual] — action method for the SoGLRenderAction. it's giving rendering traversal realness.

this is called during rendering traversals. nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

  • void SoCoordinate4::getBoundingBox (SoGetBoundingBoxAction * action) [virtual] — action method for the SoGetBoundingBoxAction. we love a good bounding box moment.

calculates bounding box and center coordinates for 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.

nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

  • void SoCoordinate4::callback (SoCallbackAction * action) [virtual] — action method for SoCallbackAction. so cute.

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.

Reimplemented from SoNode.

  • void SoCoordinate4::pick (SoPickAction * action) [virtual] — action method for SoPickAction. picking is a whole vibe, ngl.

does common processing for SoPickAction action instances.

Reimplemented from SoNode.

  • void SoCoordinate4::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual] — action method for the SoGetPrimitiveCountAction. counting primitives? slay.

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

nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

🌸 Member Data Documentation 🌸

  • SoMFVec4f SoCoordinate4::point — coordinate set of 3D points as 4D vectors (each vector contains a 3D coordinate plus normalization value). the way this is literally the whole point of the class. 💖

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code.

okay that's a wrap bestie! this page is from Coin, version 3.1.3, and it's the SoCoordinate4(3) manual page. Doxygen auto-generated it from the source code, so you know it's official. bye! 💅✨

📦 where this page comes from