SoMarkerSet(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoMarkerSet(3) — from the Library Functions Manual 💖

okay bestie, sit down, hydrate, because we're about to get into SoMarkerSet(3) and honestly? it's giving iconic. ✨

🌈 NAME 🌈

SoMarkerSet — the SoMarkerSet class displays a set of 2D bitmap markers in 3D. that's it, that's the vibe. 🎀

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoMarkerSet.h>

Inherits SoPointSet. so like, it's a SoPointSet at heart but with a glow-up. 💅

🦋 Public Types 🦋

the marker menu, no cap — every single one of these is a real value you can use:

enum MarkerType { NONE = -1, CROSS_5_5, PLUS_5_5, MINUS_5_5, SLASH_5_5,
    BACKSLASH_5_5, BAR_5_5, STAR_5_5, Y_5_5, LIGHTNING_5_5, WELL_5_5,
    CIRCLE_LINE_5_5, SQUARE_LINE_5_5, DIAMOND_LINE_5_5,
    TRIANGLE_LINE_5_5, RHOMBUS_LINE_5_5, HOURGLASS_LINE_5_5,
    SATELLITE_LINE_5_5, PINE_TREE_LINE_5_5, CAUTION_LINE_5_5,
    SHIP_LINE_5_5, CIRCLE_FILLED_5_5, SQUARE_FILLED_5_5,
    DIAMOND_FILLED_5_5, TRIANGLE_FILLED_5_5, RHOMBUS_FILLED_5_5,
    HOURGLASS_FILLED_5_5, SATELLITE_FILLED_5_5, PINE_TREE_FILLED_5_5,
    CAUTION_FILLED_5_5, SHIP_FILLED_5_5, CROSS_7_7, PLUS_7_7, MINUS_7_7,
    SLASH_7_7, BACKSLASH_7_7, BAR_7_7, STAR_7_7, Y_7_7, LIGHTNING_7_7,
    WELL_7_7, CIRCLE_LINE_7_7, SQUARE_LINE_7_7, DIAMOND_LINE_7_7,
    TRIANGLE_LINE_7_7, RHOMBUS_LINE_7_7, HOURGLASS_LINE_7_7,
    SATELLITE_LINE_7_7, PINE_TREE_LINE_7_7, CAUTION_LINE_7_7,
    SHIP_LINE_7_7, CIRCLE_FILLED_7_7, SQUARE_FILLED_7_7,
    DIAMOND_FILLED_7_7, TRIANGLE_FILLED_7_7, RHOMBUS_FILLED_7_7,
    HOURGLASS_FILLED_7_7, SATELLITE_FILLED_7_7, PINE_TREE_FILLED_7_7,
    CAUTION_FILLED_7_7, SHIP_FILLED_7_7, CROSS_9_9, PLUS_9_9, MINUS_9_9,
    SLASH_9_9, BACKSLASH_9_9, BAR_9_9, STAR_9_9, Y_9_9, LIGHTNING_9_9,
    WELL_9_9, CIRCLE_LINE_9_9, SQUARE_LINE_9_9, DIAMOND_LINE_9_9,
    TRIANGLE_LINE_9_9, RHOMBUS_LINE_9_9, HOURGLASS_LINE_9_9,
    SATELLITE_LINE_9_9, PINE_TREE_LINE_9_9, CAUTION_LINE_9_9,
    SHIP_LINE_9_9, CIRCLE_FILLED_9_9, SQUARE_FILLED_9_9,
    DIAMOND_FILLED_9_9, TRIANGLE_FILLED_9_9, RHOMBUS_FILLED_9_9,
    HOURGLASS_FILLED_9_9, SATELLITE_FILLED_9_9, PINE_TREE_FILLED_9_9,
    CAUTION_FILLED_9_9, SHIP_FILLED_9_9, NUM_MARKERS }

like… that's a whole alphabet of little glyphs. shapes at 5_5, 7_7 and 9_9 sizes, each in a line version and a filled version, plus NONE = -1 and the counter NUM_MARKERS at the end keeping count. periodt. 👑

🌸 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 Member Functions 🎀

these are the ones that belong to SoMarkerSet itself, bestie:

  • virtual SoType getTypeId (void) const — hands you the type id, the classic. 💫
  • SoMarkerSet (void) — the constructor. hi bestie. 🫶
  • virtual void GLRender (SoGLRenderAction *action) — does the actual drawing.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts primitives.

🧚 Public Member Functions inherited from SoPointSet 🧚

  • SoPointSet (void)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)

🧚 Public Member Functions inherited from SoVertexShape 🧚

  • virtual void notify (SoNotList *nl)
  • virtual void write (SoWriteAction *action)

🧚 Public Member Functions inherited from SoShape 🧚

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

🧚 Public Member Functions inherited from SoNode 🧚

okay this list is long but we do not skip, we do not summarise, we list every single one 💖

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

the static girlies — no instance needed, they just exist:

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static int getNumDefinedMarkers (void) — tells you how many markers are currently defined.
  • static void addMarker (int idx, const SbVec2s &size, const unsigned char *bytes, SbBool isLSBFirst=1, SbBool isUpToDown=1) — drop a brand new marker into the set.
  • static SbBool getMarker (int idx, SbVec2s &size, const unsigned char *&bytes, SbBool &isLSBFirst) — fetch the details of a marker.
  • static SbBool removeMarker (int idx) — yeet a marker out of the set.
  • static SbBool isMarkerBitSet (int idx, int bitNumber) — check whether a specific bit is set on a marker.

💜 Static Public Member Functions inherited from SoPointSet 💜

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

💜 Static Public Member Functions inherited from SoNonIndexedShape 💜

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

the actual data fields you can poke at:

  • SoMFInt32 markerIndex — the multi-value field holding your marker indices. this is the main character of this whole class, fr fr. 👑

🌺 Public Attributes inherited from SoPointSet 🌺

  • SoSFInt32 numPoints

🌺 Public Attributes inherited from SoNonIndexedShape 🌺

  • SoSFInt32 startIndex

🌺 Public Attributes inherited from SoVertexShape 🌺

  • SoSFNode vertexProperty

🦋 Protected Member Functions 🦋

for the subclasses and the internal machinery, not for casual touching:

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoMarkerSet () — the destructor.

🎀 Protected Member Functions inherited from SoPointSet 🎀

  • virtual ~SoPointSet ()
  • virtual void generatePrimitives (SoAction *action)
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
  • virtual SbBool generateDefaultNormals (SoState *, SoNormalCache *nc)
  • virtual SbBool generateDefaultNormals (SoState *state, SoNormalBundle *bundle)

🎀 Protected Member Functions inherited from SoNonIndexedShape 🎀

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

okay so real talk: these are the lil behind-the-scenes helpers the class keeps to itself. you don't call them from the outside, but they're doing the heavy lifting, iykyk 💅

💜 Protected Member Functions inherited from SoVertexShape

  • SoVertexShape (void) — the constructor, doing constructor things ✨
  • virtual ~SoVertexShape () — the destructor, tearing it all down gently 🫶
  • virtual SbBool shouldGLRender (SoGLRenderAction *action) — asks the universe (well, the action) whether this shape should actually render rn
  • void setNormalCache (SoState *const state, const int num, const SbVec3f *normals) — stashes those normals in the cache, num of them, from normals
  • SoNormalCache * getNormalCache (void) const — hands you back the normal cache, no take-backs
  • SoNormalCache * generateAndReadLockNormalCache (SoState *const state) — generates the normal cache and read-locks it, all in one go, main character energy 👑
  • void getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const SbBool neednormals) — pulls out the vertex data: coords, normals, and whether normals were actually needed
  • void readLockNormalCache (void) — read-locks the normal cache, simple as
  • void readUnlockNormalCache (void) — and this one unlocks it, balance restored 🧚

🌸 Protected Member Functions inherited from SoShape

  • SoShape (void) — constructor ✨
  • virtual ~SoShape () — destructor 🫶
  • float getComplexityValue (SoAction *action) — grabs the complexity value from the action
  • void beginSolidShape (SoGLRenderAction *action) — starts a solid shape render
  • void endSolidShape (SoGLRenderAction *action) — ends it, we love closure 💖
  • void GLRenderBoundingBox (SoGLRenderAction *action) — renders the bounding box
  • SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action) — should we count primitives? asking for the action
  • SbBool shouldRayPick (SoRayPickAction *const action) — should this ray-pick? vibes only
  • void computeObjectSpaceRay (SoRayPickAction *const action) — computes the object-space ray
  • void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix) — same thing but with a matrix in the mix
  • virtual SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp) — makes a triangle detail from three vertices v1, v2, v3 and the picked point pp
  • virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp) — line segment detail, two vertices v1, v2, plus pp
  • virtual SoDetail * createPointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp) — point detail from vertex v and picked point pp
  • void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3) — fires off the triangle callbacks for v1, v2, v3
  • void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2) — fires off the line segment callbacks
  • void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v) — fires off the point callbacks
  • void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL) — kicks off a shape of type shapetype, with optional detail (defaults to NULL)
  • void shapeVertex (const SoPrimitiveVertex *const v) — drops in a shape vertex
  • void endShape (void) — wraps the shape up 🎀
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal) — generates a vertex with coords s, t and a 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) — the deluxe version, with s, t, r and normal
  • SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex) — spins up the vertex array with coords, per-vertex normals, and the tex/color per-vertex flags
  • void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex) — shuts that vertex array down, vbo and all 🦋

🎀 Protected Member Functions inherited from SoNode

  • SoNode (void) — constructor ✨
  • virtual ~SoNode () — destructor 🫶
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance in from in, with flags

💅 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — constructor ✨
  • ~SoFieldContainer () — destructor 🫶

🌈 Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor ✨
  • virtual ~SoBase () — destructor 🫶
  • virtual void destroy (void) — destroys the thing, dramatically but correctly 💀
  • SbBool hasMultipleWriteRefs (void) const — checks if it's got multiple write refs
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header out, knowing if it's a isgroup and/or isengine
  • void writeFooter (SoOutput *out) const — writes the footer, the lil goodbye 👋
  • virtual const char * getFileFormatName (void) const — returns the file format name as a const char *

⭐ Static Protected Member Functions ⭐

  • static const SoFieldData ** getFieldDataPtr (void) — returns a pointer-to-pointer to the field data, no cap 🫶

💖 Static Protected Member Functions inherited from SoPointSet

  • static const SoFieldData ** getFieldDataPtr (void) — same deal, SoPointSet's own version

💖 Static Protected Member Functions inherited from SoNonIndexedShape

  • static const SoFieldData ** getFieldDataPtr (void) — and SoNonIndexedShape's version

💖 Static Protected Member Functions inherited from SoVertexShape

  • static const SoFieldData ** getFieldDataPtr (void) — SoVertexShape's turn

💖 Static Protected Member Functions inherited from SoShape

  • static const SoFieldData ** getFieldDataPtr (void) — SoShape's turn

💖 Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — SoNode's version
  • static void setNextActionMethodIndex (int index) — sets the next action method index to index
  • static int getNextActionMethodIndex (void) — gets that index back
  • static void incNextActionMethodIndex (void) — bumps it up by one, slay
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for nodetype with 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 🔓

🌟 Additional Inherited Members 🌟

  • 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, and static int nextActionMethodIndex = 0

✨ Detailed Description ✨

The SoMarkerSet class displays a set of 2D bitmap markers in 3D. literally its whole job and it does it gorgeously 💅

This node uses the coordinates currently on the state (or in the vertexProperty field) in order. The numPoints field specifies the number of points in the set.

In addition to supplying the user with a set of standard markers to choose from, it is also possible to specify one's own bitmaps for markers. custom markers?? we love options 🎨

This node class is an extension versus the original SGI Inventor v2.1 API. In addition to being a Coin extension, it is also present in TGS' Inventor implementation. (Note that TGS's implementation doesn't support the NONE markerIndex value.)

FILE FORMAT/DEFAULTS:

MarkerSet {
    vertexProperty NULL
    startIndex 0
    numPoints -1
    markerIndex 0
}

Since

  • TGS Inventor 2.5
  • Coin 1.0

🦋 Member Enumeration Documentation 🦋

enum SoMarkerSet::MarkerType

Defines the different standard markers. 🌈

🎀 Constructor & Destructor Documentation 🎀

SoMarkerSet::SoMarkerSet (void )

Constructor.

References markerIndex, and SoMarkerSet().

Referenced by getFieldData(), and SoMarkerSet().

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

Destructor. 🫶

💖 Member Function Documentation 💖

✨ SoType SoMarkerSet::getTypeId (void ) const [virtual]

Okay bestie, this one hands you the type identification of any object derived from a class that inherits SoBase. What's it for? Run-time type checking and "downward" casting. Very detective, very sleuth. 🔍

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

Now listen up, application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else: you must override this method in all subclasses. No skipping. This is normally done as part of setting up the full type system for your extension classes, and it's usually accomplished with 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 tea on writing Coin extensions, go read the class documentation of the toplevel superclasses for the various class groups. 📚

Reimplemented from SoPointSet.

🎀 const SoFieldData * SoMarkerSet::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. That's it, that's the whole vibe. ✨

Reimplemented from SoPointSet.

References SoMarkerSet().

🦋 void SoMarkerSet::GLRender (SoGLRenderAction * action) [virtual]

This is the action method for SoGLRenderAction.

It gets called during rendering traversals. Any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. Very main character of it. 💅

Reimplemented from SoPointSet.

References SoAction::getState(), SoVertexShape::getVertexData(), SbViewportRegion::getViewportSizePixels(), markerIndex, SbMatrix::multVecMatrix(), SoPointSet::numPoints, SoState::pop(), SoDebugError::postWarning(), SoState::push(), SoVertexShape::shouldGLRender(), SoNonIndexedShape::startIndex, and SoVertexShape::vertexProperty.

🌸 void SoMarkerSet::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for SoGetPrimitiveCountAction.

It calculates the number of triangle, line segment and point primitives for the node, and adds these to the counters of the action. Math girlies rise up. 🧮

Nodes that influence how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoPointSet.

References SoGetPrimitiveCountAction::addNumImage(), SoAction::getState(), SoVertexShape::getVertexData(), SoPointSet::numPoints, SoState::pop(), SoState::push(), SoShape::shouldPrimitiveCount(), SoNonIndexedShape::startIndex, and SoVertexShape::vertexProperty.

⭐ int SoMarkerSet::getNumDefinedMarkers (void ) [static]

Returns the number of defined markers. Short, sweet, slay. 💅

🌈 void SoMarkerSet::addMarker (int idx, const SbVec2s & size, const unsigned char * bytes, SbBool isLSBFirst = 1, SbBool isUpToDown = 1) [static]

Replace the bitmap for the marker at idx with the representation given by size dimensions with the bitmap data at bytes. isLSBFirst and isUpToDown indicate how the bitmap data is ordered. And if markerIndex is NONE? It does nothing. Nada. Zilch. 🙈

Here's a complete usage example which demonstrates how to set up a user-specified marker from a char-map. Note that the "multi-colored" pixmap data is converted to a monochrome bitmap before being passed to addMarker() because addMarker() supports only bitmaps. No color, bestie, we're monochrome here. 🖤

const int WIDTH = 18;
const int HEIGHT = 19;
const int BYTEWIDTH = (WIDTH + 7) / 2;

const char coin_marker[WIDTH * HEIGHT + 1] = {
  ".+                "
  "+@.+              "
  " .@#.+            "
  " +$@##.+          "
  "  .%@&##.+        "
  "  +$@&&*##.+      "
  "   .%@&&*=##.+    "
  "   +$@&&&&=-##.+  "
  "    .%@&&&&&-;#&+ "
  "    +$@&&&&&&=#.  "
  "     .%@&&&&*#.   "
  "     +$@&&&&#.    "
  "      .%@&@%@#.   "
  "      +$%@%.$@#.  "
  "       .%%. .$@#. "
  "       +$.   .$>#."
  "        +     .$. "
  "               .  "
  "                  " };

int byteidx = 0;
unsigned char bitmapbytes[BYTEWIDTH * HEIGHT];
for (int h = 0; h < HEIGHT; h++) {
  unsigned char bits = 0;
  for (int w = 0; w < WIDTH; w++) {
    if (coin_marker[(h * WIDTH) + w] != ' ') { bits |= (0x80 >> (w % 8)); }
    if ((((w + 1) % 8) == 0) || (w == WIDTH - 1)) {
      bitmapbytes[byteidx++] = bits;
      bits = 0;
    }
  }
}

int MYAPP_ARROW_IDX = SoMarkerSet::getNumDefinedMarkers(); // add at end
SoMarkerSet::addMarker(MYAPP_ARROW_IDX, SbVec2s(WIDTH, HEIGHT),
                       bitmapbytes, FALSE, TRUE);

This will provide you with an index given by MYAPP_ARROW_IDX which can be used in SoMarkerSet::markerIndex to display the new marker. Iconic. 👑

🍓 SbBool SoMarkerSet::getMarker (int idx, SbVec2s & size, const unsigned char *& bytes, SbBool & isLSBFirst) [static]

Returns data for marker at idx in the size, bytes and isLSBFirst parameters.

If no marker is defined for given idx, or SoMarkerSet::markerIndex is NONE (not removable), FALSE is returned. If everything is OK, TRUE is returned. Simple as. ✅

💜 SbBool SoMarkerSet::removeMarker (int idx) [static]

Removes marker at idx. Bye bye marker, hope you had a good run. 👋

If no marker is defined for given idx, or SoMarkerSet::markerIndex is NONE (not removable), FALSE is returned. If everything is OK, TRUE is returned.

💀 SbBool SoMarkerSet::isMarkerBitSet (int idx, int bitNumber) [static]

Not supported in Coin. Should probably not have been part of the public Open Inventor API.

That's the whole thing. It's giving legacy baggage, honestly. 😭

💖 Member Data Documentation 💖

🫶 SoMFInt32 SoMarkerSet::markerIndex

Contains the set of index markers to display, defaults to 0 (CROSS_5_5). The special value NONE renders nothing for that marker. ✨

Referenced by GLRender(), and SoMarkerSet().

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code. Yes bestie, a robot wrote the skeleton — the personality is all mine. 🤖💖

And that's a wrap on SoMarkerSet(3)! This lil page came to you straight from the Coin source code, Version 2.5.0 — go check the version and date in your own local copy of the page if you need the exact stamp, because that footer is where it lives. Stay type-safe, stay slay. Periodt. 💅✨

📦 where this page comes from