SoNonIndexedShape(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

SoNonIndexedShape — the superclass for all non-indexed vertex based shapes. That's it, that's the whole vibe. 💅

okay so real quick before we dive in: this page comes straight out of the Library Functions Manual, section 3, and bestie it is long. So we're doing this in 2 parts and you're reading part 1. Grab a snack. 🍓

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoNonIndexedShape.h>

Inherits SoVertexShape.

Inherited by SoFaceSet, SoLineSet, SoPointSet, SoQuadMesh, and SoTriangleStripSet.

So yeah — this is the momager of that whole little friend group. Everyone below her inherits the drip. 👑

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const

Public Member Functions inherited from SoVertexShape

  • virtual void notify (SoNotList *nl)
  • virtual SbBool generateDefaultNormals (SoState *state, SoNormalBundle *bundle)
  • virtual SbBool generateDefaultNormals (SoState *state, SoNormalCache *cache)
  • virtual void write (SoWriteAction *action)

Public Member Functions inherited from SoShape

  • virtual SbBool affectsState (void) const
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)=0
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *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 doAction (SoAction *action)
  • 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 pick (SoPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • 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 SoVertexShape

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

  • SoSFInt32 startIndex — the one and only field this class brings to the table all on its own. main character energy fr fr. 💖

Public Attributes inherited from SoVertexShape

  • SoSFNode vertexProperty

💜 Protected Member Functions 💜

(this is the behind-the-scenes section, the iykyk girlies 🫶)

  • virtual const SoFieldData * getFieldData (void) const
  • SoNonIndexedShape (void)
  • virtual ~SoNonIndexedShape ()
  • void computeCoordBBox (SoAction *action, int numVertices, SbBox3f &box, SbVec3f &center)
  • void fixNumVerticesPointers (SoState *state, const int32_t *&start, const int32_t *&end, int32_t *dummyarray) const

Protected Member Functions inherited from SoVertexShape

  • SoVertexShape (void)
  • virtual ~SoVertexShape ()
  • virtual SbBool shouldGLRender (SoGLRenderAction *action)
  • void setNormalCache (SoState *const state, const int num, const SbVec3f *normals)
  • SoNormalCache * getNormalCache (void) const
  • SoNormalCache * generateAndReadLockNormalCache (SoState *const state)
  • void getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const SbBool neednormals)
  • void readLockNormalCache (void)
  • void readUnlockNormalCache (void)

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)

okay that's the whole family tree and honestly? iconic. 🌈 but bestie we are not done — part 2 is right there waiting for you, and it's got the actual lore. don't you dare close the tab. 🦋

💖 Protected Member Functions inherited from SoFieldContainer 💖

Okay bestie, so SoFieldContainer is passing down these protected member functions like they're limited edition:

  • SoFieldContainer (void) — the constructor, serving looks.
  • ~SoFieldContainer () — the destructor, closing the curtain.

🦋 Protected Member Functions inherited from SoBase 🦋

And SoBase said "hold my iced coffee" and gave us these:

  • SoBase (void) — constructor.
  • virtual ~SoBase () — virtual destructor, very mindful.
  • virtual void destroy (void) — destroy, virtual.
  • SbBool hasMultipleWriteRefs (void) const — checks for multiple write refs.
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header.
  • void writeFooter (SoOutput *out) const — writes the footer.
  • virtual const char * getFileFormatName (void) const — gets the file format name.

✨ Static Protected Member Functions ✨

  • static const SoFieldData ** getFieldDataPtr (void) — the field data pointer getter, iconic.

🌸 Static Protected Member Functions inherited from SoVertexShape 🌸

  • static const SoFieldData ** getFieldDataPtr (void) — same energy.

🌺 Static Protected Member Functions inherited from SoShape 🌺

  • static const SoFieldData ** getFieldDataPtr (void) — again, no cap.

💜 Static Protected Member Functions inherited from SoNode 💜

  • static const SoFieldData ** getFieldDataPtr (void) — the getter.
  • static void setNextActionMethodIndex (int index) — sets the next action method index.
  • static int getNextActionMethodIndex (void) — gets it.
  • static void incNextActionMethodIndex (void) — increments it.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types.

🌈 Static Protected Member Functions inherited from SoBase 🌈

  • static uint32_t getCurrentWriteCounter (void) — gets the current write counter.
  • static void staticDataLock (void) — locks static data.
  • static void staticDataUnlock (void) — unlocks static data.

👑 Additional Inherited Members 👑

🎀 Public Types inherited from SoShape 🎀

The enum:

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

🍓 Public Types inherited from SoNode 🍓

The enum:

       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 SoNonIndexedShape class is the superclass for all non-indexed vertex based shapes. It's literally the blueprint for all your non-indexed vertex vibes.

It contains the (now obsoleted) startIndex field and a convenience method for calculating the bounding box. So it's a bit vintage, but still slaying.

🎀 Constructor & Destructor Documentation 🎀

SoNonIndexedShape::SoNonIndexedShape (void ) [protected]

Constructor. It references SoNonIndexedShape(), and startIndex. It's referenced by getFieldData(), and SoNonIndexedShape().

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

Destructor. Periodt.

✨ Member Function Documentation ✨

SoType SoNonIndexedShape::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 SoVertexShape.

Reimplemented in SoFaceSet, SoLineSet, SoMarkerSet, SoPointSet, SoQuadMesh, and SoTriangleStripSet.

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

Reimplemented in SoFaceSet, SoLineSet, SoMarkerSet, SoPointSet, SoQuadMesh, and SoTriangleStripSet.

References SoNonIndexedShape().

void SoNonIndexedShape::computeCoordBBox (SoAction * action, int numVertices, SbBox3f & box, SbVec3f & center) [protected]

This method is provided as a convenient means for the subclasses of this class to find their bounding box and center value.

The returned bounding box will enclose all vertices from startIndex up to startIndex + numVertices. If numVertices is less than zero, all vertices in the current coordinate element or vertex property node will be used in the calculation.

The center point will be calculated as the average of all the vertices in the bounding box.

References SbBox3f::extendBy(), SoMField::getNum(), SbVec4f::getReal(), SoAction::getState(), SoMFVec3f::getValues(), SoBase::isOfType(), SbVec3f::setValue(), SoNode::SoNode(), startIndex, SoVertexProperty::vertex, and SoVertexShape::vertexProperty.

Referenced by SoFaceSet::computeBBox(), SoLineSet::computeBBox(), SoPointSet::computeBBox(), SoQuadMesh::computeBBox(), and SoTriangleStripSet::computeBBox().

void SoNonIndexedShape::fixNumVerticesPointers (SoState * state, const int32_t *& start, const int32_t *& end, int32_t * dummyarray) const [protected]

Convenience method that might adjust start and end pointers, which should point at the start and end of the numVertices array when calling this method. This takes care of the case where numVertices contains a single -1, and all coordinates in the state (or in the vertexProperty field) should be rendered as one primitive.

dummyarray should be a temporary array, with room for one integer.

Not part of the OIV API.

References SoMField::getNum(), startIndex, SoVertexProperty::vertex, and SoVertexShape::vertexProperty.

Referenced by SoFaceSet::generateDefaultNormals(), SoTriangleStripSet::generateDefaultNormals(), SoFaceSet::generatePrimitives(), SoLineSet::generatePrimitives(), SoTriangleStripSet::generatePrimitives(), SoFaceSet::getPrimitiveCount(), SoLineSet::getPrimitiveCount(), SoTriangleStripSet::getPrimitiveCount(), SoFaceSet::GLRender(), SoLineSet::GLRender(), and SoTriangleStripSet::GLRender().

🌸 Member Data Documentation 🌸

SoSFInt32 SoNonIndexedShape::startIndex

Coordinates are fetched from this index on. This field is now obsoleted, and is provided only for backward compatibility.

Referenced by computeCoordBBox(), fixNumVerticesPointers(), SoFaceSet::generateDefaultNormals(), SoQuadMesh::generateDefaultNormals(), SoTriangleStripSet::generateDefaultNormals(), SoFaceSet::generatePrimitives(), SoLineSet::generatePrimitives(), SoPointSet::generatePrimitives(), SoQuadMesh::generatePrimitives(), SoTriangleStripSet::generatePrimitives(), SoMarkerSet::getPrimitiveCount(), SoPointSet::getPrimitiveCount(), SoFaceSet::GLRender(), SoLineSet::GLRender(), SoMarkerSet::GLRender(), SoPointSet::GLRender(), SoQuadMesh::GLRender(), SoTriangleStripSet::GLRender(), and SoNonIndexedShape().

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. So if you see a typo, blame the robots, not me. 💅

And that's a wrap on SoNonIndexedShape(3) from Coin, Version 2.5.0. Stay slay, bestie. 🦋✨

📦 where this page comes from