SoVRMLPointSet(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 NAME 💖

SoVRMLPointSet — hi bestie, welcome to the manual page for SoVRMLPointSet (it's a section 3 page, straight out of the Library Functions Manual 🫶). Short version: the SoVRMLPointSet class is used to represent a set of 3D points. That's it, that's the whole assignment, and it ate. ✨

🌸 SYNOPSIS 🌸

First things first, you gotta pull the header in like this:

#include <Inheritor/VRMLnodes/SoVRMLPointSet.h>

no wait, literally, the actual line is:

#include <Inventor/VRMLnodes/SoVRMLPointSet.h>

There we go. 🎀

And the family tree? She inherits SoVRMLVertexPoint. Generational, honestly. 👑

✨ Public Member Functions ✨

The ones that are hers, right here on this class:

  • virtual SoType getTypeId (void) const
  • SoVRMLPointSet (void)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)

🦋 Public Member Functions inherited from SoVRMLVertexPoint 🦋

  • virtual void doAction (SoAction *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 SoVRMLVertexPoint 🎀

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

🔒 Protected Member Functions 🔒

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLPointSet ()
  • virtual void generatePrimitives (SoAction *action)

🧸 Protected Member Functions inherited from SoVRMLVertexPoint 🧸

  • 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)
  • 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 SoVRMLVertexPoint 🫧

  • static const SoFieldData ** getFieldDataPtr (void)
ok that's the whole SYNOPSIS, and bestie, this page is long, so it comes in 2 parts — more is loading, don't close the tab 💅✨

✨ Static Protected Member Functions inherited from SoVRMLGeometry ✨

  • static const SoFieldData ** getFieldDataPtr (void) — inherited, periodt.

🦋 Static Protected Member Functions inherited from SoShape 🦋

  • static const SoFieldData ** getFieldDataPtr (void) — inherited from SoShape, bestie.

💅 Static Protected Member Functions inherited from SoNode 💅

  • static const SoFieldData ** getFieldDataPtr (void) — inherited from SoNode.
  • static void setNextActionMethodIndex (int index) — inherited.
  • static int getNextActionMethodIndex (void) — inherited.
  • static void incNextActionMethodIndex (void) — inherited.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — inherited.

🌸 Static Protected Member Functions inherited from SoBase 🌸

  • static uint32_t getCurrentWriteCounter (void) — inherited.
  • static void staticDataLock (void) — inherited.
  • static void staticDataUnlock (void) — inherited.

🎀 Additional Inherited Members 🎀

💜 Public Types inherited from SoShape 💜

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

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

🌈 Public Attributes inherited from SoVRMLVertexPoint 🌈

  • SoSFNode coord — the coord field, iconic.
  • SoSFNode color — the color field, also iconic.

🧚 Protected Types inherited from SoBase 🧚

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

💖 Protected Attributes inherited from SoNode 💖

  • uint32_t uniqueId — uniqueId, periodt.

🦄 Protected Attributes inherited from SoFieldContainer 🦄

  • SbBool isBuiltIn — isBuiltIn, no cap.

👑 Static Protected Attributes inherited from SoNode 👑

  • static uint32_t nextUniqueId = 0 — nextUniqueId is 0.
  • static int nextActionMethodIndex = 0 — nextActionMethodIndex is 0.

📖 Detailed Description 📖

The SoVRMLPointSet class is used to represent a set of 3D points.

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

PointSet {
  exposedField  SFNode  color      NULL
  exposedField  SFNode  coord      NULL
}

The PointSet node specifies a set of 3D points, in the local coordinate system, with associated colours at each point. The coord field specifies a SoVRMLCoordinate node (or instance of a Coordinate node). The results are undefined if the coord field specifies any other type of node. PointSet uses the coordinates in order. If the coord field is NULL, the point set is considered empty. PointSet nodes are not lit, not texture-mapped, nor do they participate in collision detection. The size of each point is implementation-dependent. If the color field is not NULL, it shall specify a SoVRMLColor node that contains at least the number of points contained in the coord node. The results are undefined if the color field specifies any other type of node. Colours shall be applied to each point in order. The results are undefined if the number of values in the Color node is less than the number of values specified in the Coordinate node. If the color field is NULL and there is a SoVRMLMaterial node defined for the SoVRMLAppearance node affecting this PointSet node, the emissiveColor of the Material node shall be used to draw the points. More details on lighting equations can be found in 4.14, Lighting model (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.14).

🛠️ Constructor & Destructor Documentation 🛠️

SoVRMLPointSet::SoVRMLPointSet (void )

Constructor.

References SoVRMLPointSet().

Referenced by getFieldData(), and SoVRMLPointSet().

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

Destructor.

🔧 Member Function Documentation 🔧

SoType SoVRMLPointSet::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.

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

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.

Reimplemented from SoVRMLVertexPoint.

const SoFieldData * SoVRMLPointSet::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.

Reimplemented from SoVRMLVertexPoint.

References SoVRMLPointSet().

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

References SoShape::finishVertexArray(), SoGLRenderAction::getCacheContext(), SbColor4f::getPackedValue(), SoAction::getState(), SoVRMLVertexPoint::GLRender(), SoVRMLVertexPoint::shouldGLRender(), and SoShape::startVertexArray().

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

References SoVRMLVertexPoint::getBoundingBox(), and SoAction::getState().

void SoVRMLPointSet::generatePrimitives (SoAction * action) [protected], [virtual]

The method implements action behavior for shape nodes for SoCallbackAction. It is invoked from SoShape::callback(). (Subclasses should not override SoNode::callback().)

The subclass implementations uses the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), with SoDetail instances, to pass the primitives making up the shape back to the caller.

Implements SoShape.

References SoShape::beginShape(), SoVRMLVertexPoint::color, SoVRMLVertexPoint::coord, SoShape::endShape(), SoMField::getNum(), SoAction::getState(), SoMFVec3f::getValues(), SoVRMLCoordinate::point, SoPointDetail::setCoordinateIndex(), SoPrimitiveVertex::setDetail(), SoPointDetail::setMaterialIndex(), SoPrimitiveVertex::setMaterialIndex(), SoPrimitiveVertex::setPoint(), and SoShape::shapeVertex().

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code.

And that's the whole vibe, bestie. This page is from Coin Version 2.5.0, titled SoVRMLPointSet(3), and there's no date on the footer so we're just gonna say it's Doxygen-generated from the source code. Periodt 💅✨

📦 where this page comes from