SoVRMLVertexPoint(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLVertexPoint(3) — Library Functions Manual 💖

okay bestie, welcome to SoVRMLVertexPoint(3) from the Library Functions Manual! this is part 1, and it's a whole lot, but we're gonna get through it together. no cap. 💅✨

🌸 NAME 🌸

SoVRMLVertexPoint — the SoVRMLVertexPoint class is a superclass for point based VRML shapes. periodt. 💖

✨ SYNOPSIS ✨

here's the include, bestie:

#include <Inventor/VRMLnodes/SoVRMLVertexPoint.h>

Inherits SoVRMLGeometry.

Inherited by SoVRMLPointSet.

now the member function squad. it's giving "I have a huge family tree and I'm not sorry". 💅

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • 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)
  • virtual void notify (SoNotList *list)

🦋 Public Member Functions inherited from SoVRMLGeometry 🦋

  • virtual void search (SoSearchAction *action)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

🌸 Public Member Functions inherited from SoShape 🌸

  • virtual SbBool affectsState (void) const
  • virtual void rayPick (SoRayPickAction *action)
  • const SoBoundingBoxCache * getBoundingBoxCache (void) const

✨ 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 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 write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • 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 SoVRMLGeometry 💜

  • static SoType getClassTypeId (void)
  • static void initClass (void)

💙 Static Public Member Functions inherited from SoShape 💙

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize)
  • static float getDecimatedComplexity (SoState *state, float complexity)

💚 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 🎀

  • SoSFNode coord
  • SoSFNode color

💅 Protected Member Functions 💅

  • virtual const SoFieldData * getFieldData (void) const
  • SoVRMLVertexPoint (void)
  • virtual ~SoVRMLVertexPoint ()
  • virtual SbBool shouldGLRender (SoGLRenderAction *action)
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)

🌈 Protected Member Functions inherited from SoVRMLGeometry 🌈

  • SoVRMLGeometry (void)
  • virtual ~SoVRMLGeometry ()
  • void setupShapeHints (SoState *state, const SbBool ccw, const SbBool solid)
  • virtual SoChildList * getChildren (void) const

🍓 Protected Member Functions inherited from SoShape 🍓

  • SoShape (void)
  • virtual ~SoShape ()
  • float getComplexityValue (SoAction *action)
  • virtual void generatePrimitives (SoAction *action)=0
  • void beginSolidShape (SoGLRenderAction *action)
  • void endSolidShape (SoGLRenderAction *action)
  • void GLRenderBoundingBox (SoGLRenderAction *action)
  • SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action)
  • SbBool shouldRayPick (SoRayPickAction *const action)
  • void computeObjectSpaceRay (SoRayPickAction *const action)
  • void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix)
  • virtual SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
  • virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp)
  • virtual SoDetail * createPointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp)
  • void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3)
  • void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2)
  • void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v)
  • void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL)
  • void shapeVertex (const SoPrimitiveVertex *const v)
  • void endShape (void)
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const float r, const SbVec3f &normal)
  • SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)
  • void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)

🧚 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 SoVRMLGeometry ✨

  • static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoShape ✨

  • static const SoFieldData ** getFieldDataPtr (void)

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — hands you the pointer-to-the-class-wide-field-data-pointer. it's static, it's protected, it's inherited, it's giving "internal plumbing" ✨
  • static void setNextActionMethodIndex (int index) — sets the next action method index to index. very backstage-pass energy 💅
  • static int getNextActionMethodIndex (void) — returns that next action method index right back to you.
  • static void incNextActionMethodIndex (void) — bumps the next action method index up by one. go girl, increment 📈
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — takes a const SoType &nodetype and a const uint32_t bitmask and sets the compatibility types. yes bestie, there's a bitmask, we love a bitmask 🌈

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — returns the current write counter as a uint32_t.
  • static void staticDataLock (void) — locks the static data. 🔒
  • static void staticDataUnlock (void) — unlocks it again. 🔓

Additional Inherited Members

Public Types inherited from SoShape

the enum, verbatim, no notes:

enum TriangleShape { TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON,
    QUADS, QUAD_STRIP, POINTS, LINES, LINE_STRIP }

Public Types inherited from SoNode

another enum, and it's a long one, so buckle up:

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 SoVRMLVertexPoint class is a superclass for point based VRML shapes.

that's it. that's the whole vibe. it's the mom of point-shaped VRML things, and all the actual pointy children get their traits from her. 👑

🎀 Constructor & Destructor Documentation 🎀

SoVRMLVertexPoint::SoVRMLVertexPoint (void ) [protected]

Constructor. 🎂

  • References color, coord, and SoVRMLVertexPoint().
  • Referenced by getFieldData(), and SoVRMLVertexPoint().

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

Destructor. 💀 bye bestie, thanks for the points.

💅 Member Function Documentation 💅

SoType SoVRMLVertexPoint::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. no cap, this is the function for "wait, what even are you?" 🕵️

Usage example:

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

okay so 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. not optional, bestie, it's mandatory, it's the law 📜

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

  • Reimplemented from SoVRMLGeometry.
  • Reimplemented in SoVRMLPointSet.

const SoFieldData * SoVRMLVertexPoint::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. so like, check it before you dereference it, i'm begging 🙈

  • Reimplemented from SoVRMLGeometry.
  • Reimplemented in SoVRMLPointSet.
  • References SoVRMLVertexPoint().

void SoVRMLVertexPoint::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action. just the standard "do the thing" of the node world ✨

  • Reimplemented from SoNode.
  • References color, coord, SoNode::doAction(), and SoNode::SoNode().

void SoVRMLVertexPoint::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. 🎨

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 SoShape.
  • Reimplemented in SoVRMLPointSet.
  • References color, coord, SoNode::GLRender(), and SoNode::SoNode().
  • Referenced by SoVRMLPointSet::GLRender().

void SoVRMLVertexPoint::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction. 📦

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 SoShape.
  • Reimplemented in SoVRMLPointSet.
  • References SoNode::getBoundingBox().
  • Referenced by SoVRMLPointSet::getBoundingBox().

void SoVRMLVertexPoint::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 the SoCallbackAction for extracting information about the scene graph.

  • Reimplemented from SoShape.
  • References SoNode::callback().

void SoVRMLVertexPoint::pick (SoPickAction * action) [virtual]

Action method for SoPickAction. 👆

Does common processing for SoPickAction action instances.

  • Reimplemented from SoNode.
  • References SoNode::pick().

void SoVRMLVertexPoint::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.

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

  • Reimplemented from SoShape.
  • References SoGetPrimitiveCountAction::addNumPoints(), coord, SoMField::getNum(), SoVRMLCoordinate::point, and SoShape::shouldPrimitiveCount().

void SoVRMLVertexPoint::notify (SoNotList * l) [virtual]

Notifies all auditors for this instance when changes are made. 📣 the group chat ping of the scene graph fr fr

  • Reimplemented from SoVRMLGeometry.
  • References SoVRMLGeometry::notify().

SbBool SoVRMLVertexPoint::shouldGLRender (SoGLRenderAction * action) [protected], [virtual]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. okay so it said what it said, don't @ me, it's internal ✋

  • Reimplemented from SoVRMLGeometry.
  • References coord, and SoVRMLGeometry::shouldGLRender().
  • Referenced by SoVRMLPointSet::GLRender().

void SoVRMLVertexPoint::computeBBox (SoAction * action, SbBox3f & box, SbVec3f & center) [protected], [virtual]

Implemented by SoShape subclasses to let the SoShape superclass know the exact size and weighted center point of the shape's bounding box.

The bounding box and center point should be calculated and returned in the local coordinate system. 🗺️

The method implements action behavior for shape nodes for SoGetBoundingBoxAction. It is invoked from SoShape::getBoundingBox(). (Subclasses should not override SoNode::getBoundingBox().) read that twice bestie, it's a real rule.

The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry. 😭 so don't go reading center before you write it, okay?

  • Implements SoShape.
  • References coord, SbBox3f::extendBy(), SbBox3f::getCenter(), SoMField::getNum(), SoMFVec3f::getValues(), SbBox3f::isEmpty(), SbBox3f::makeEmpty(), and SoVRMLCoordinate::point.

🌸 Member Data Documentation 🌸

SoSFNode SoVRMLVertexPoint::coord

Should contain an SoVRMLCoordinate node. 📍

  • Referenced by computeBBox(), doAction(), SoVRMLPointSet::generatePrimitives(), getPrimitiveCount(), GLRender(), shouldGLRender(), and SoVRMLVertexPoint().

SoSFNode SoVRMLVertexPoint::color

Can contain an SoVRMLColor node when color per point is needed. 🌈 one color per point, that's the whole assignment, iconic behavior honestly

  • Referenced by doAction(), SoVRMLPointSet::generatePrimitives(), GLRender(), and SoVRMLVertexPoint().

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap on part 2, bestie 💖 this whole page is from Coin, Version 2.5.0, and it's the manual page for SoVRMLVertexPoint(3). no date on it, just the version, so that's all we've got. mwah, go render something pointy ✨🎀

📦 where this page comes from