SoCoordinate3(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoCoordinate3(3) — Library Functions Manual 🎀

okay bestie, welcome to the SoCoordinate3(3) page, straight out of the Library Functions Manual and honestly? it's giving coordinate supplier to the shape-node girlies. let's go 💅

✨ NAME ✨

SoCoordinate3 — the SoCoordinate3 class is a node for providing coordinates to shape nodes. periodt.

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoCoordinate3.h>

Inherits SoNode.

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoCoordinate3 (void)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *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 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

  • SoMFVec3f point

🦋 Protected Member Functions

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

✨ 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 👑

The SoCoordinate3 class is a node for providing coordinates to shape nodes.

When encountering nodes of this type during traversal, the coordinates it contains will be put on the state stack for later use by shape nodes of types which needs coordinate sets (like SoFaceSet nodes or SoPointSet nodes). so like… it's literally stacking up coords for the shape girlies to come grab later, no cap 🫶

note bestie: an SoCoordinate3 node will replace the coordinates already present in the state (if any). like, it's not adding on top — it's a full takeover, main character energy, the old coords are GONE 💀

FILE FORMAT/DEFAULTS:

Coordinate3 {
    point 0 0 0
}

🌈 See also

SoCoordinate4

🧚 Constructor & Destructor Documentation 🧚

✨ SoCoordinate3::SoCoordinate3 (void )

Constructor. yes she constructs 💅

References point, and SoCoordinate3().

Referenced by getFieldData(), and SoCoordinate3().

✨ SoCoordinate3::~SoCoordinate3 () [protected], [virtual]

Destructor. and that's the wrap on the destructor — protected AND virtual, she's doing both, iconic 🎀

💖 Member Function Documentation 💖

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

Okay bestie, this one hands you the type identification of any object that inherits from SoBase. It's what the library uses for run-time type checking and for "downward" casting (aka: "I know you're actually this subclass, let me talk to you as one"). 🎀

Usage example, and yes you're getting it verbatim:

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 listen, if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. Not optional, fr fr. Usually you do this as part of setting up the whole type system for your extension classes, which is normally accomplished with 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. 📚

Implements SoBase.

🌟 const SoFieldData * SoCoordinate3::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 no fields present? You get NULL. That's it, that's the whole vibe. 🙈

Reimplemented from SoFieldContainer.

References SoCoordinate3().

🌟 void SoCoordinate3::doAction(SoAction * action) [virtual]

This function performs the typical operation of a node for any action. Generic queen behavior, honestly. 👑

Reimplemented from SoNode.

References SoAction::getState(), and point.

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

🌟 void SoCoordinate3::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 want to yeet geometry primitives at OpenGL, override this method.

Reimplemented from SoNode.

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

🌟 void SoCoordinate3::callback(SoCallbackAction * action) [virtual]

Action method for SoCallbackAction. 🦋

Simply updates the state according to how the node behaves for the render action, so the application programmer can use SoCallbackAction for extracting information about the scene graph. It's giving "just keep the state consistent so the devs can peek." 👀

Reimplemented from SoNode.

References doAction().

🌟 void SoCoordinate3::getBoundingBox(SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction. 📦

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 shifts the center point for the scene more towards the one for this node. Very "make it fit, make it centered" energy. ✨

Nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoNode.

References doAction().

🌟 void SoCoordinate3::pick(SoPickAction * action) [virtual]

Action method for SoPickAction. 🎯

Does the common processing for SoPickAction action instances. Standard, iconic, does exactly what it says.

Reimplemented from SoNode.

References doAction().

🌟 void SoCoordinate3::getPrimitiveCount(SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction. 🔢

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Counting era, no cap. 💅

Nodes influencing 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 💖

🌸 SoMFVec3f SoCoordinate3::point

Coordinate set of 3D points. Literally the whole personality of this class. 🫶

Referenced by doAction(), GLRender(), SoTabPlaneDragger::reallyAdjustScaleTabSize(), and SoCoordinate3().

👑 Author

Generated automatically by Doxygen for Coin from the source code. (Not a human author, just Doxygen doing its little thing. 🤖✨)

And that's a wrap, bestie! This page came to you from Coin, Version 2.5.0, filed under SoCoordinate3(3) — same source, same version, same date as the footer says, no notes. Go build something cute with your 3D points. 💖🌈🦋

📦 where this page comes from