SoIndexedNurbsCurve(3)

📦 version 2.5.0, in fedora 43, fedora 44

okay so welcome to SoIndexedNurbsCurve(3) 💖 bestie you are about to read a whole manual page about smooth curves and honestly? it's giving main character. buckle up, we're going in.

✨ NAME ✨

SoIndexedNurbsCurve — the class that's literally a node for representing smooth curves. no cap, that's the whole job. it shows up in your scene graph and goes "hi, i am a curve, and i am smooth" 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoIndexedNurbsCurve.h>

Inherits SoShape. so it's part of the shape family, it's got the shape genes, it inherited the shape drama 🫶

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const — hands you the type id, the little name tag this node wears at the party ✨
  • SoIndexedNurbsCurve (void) — the constructor, aka the birth of your curve 🎀
  • virtual void GLRender (SoGLRenderAction *action) — does the actual drawing when the GL render action comes knocking 👑
  • virtual void rayPick (SoRayPickAction *action) — handles ray picking so your curve can be picked, lowkey iconic 🦋
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — reports how many primitives it's working with, for the counting girlies 🔢
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — computes the bounding box, the curve's little personal space 🫧
  • void sendPrimitive (SoAction *, SoPrimitiveVertex *) — sends out a primitive vertex, delivery service but for geometry 📦

💜 Public Member Functions inherited from SoShape

  • virtual SbBool affectsState (void) const
  • virtual void notify (SoNotList *nl)
  • virtual void callback (SoCallbackAction *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 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 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) — the class-level type id, the whole squad's name tag 💅
  • static void initClass (void) — sets the class up so it exists properly, the glow-up ritual ✨

💜 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 numControlPoints — how many control points you've got, the headcount of your curve's entourage ⭐
  • SoMFInt32 coordIndex — the index list telling it which coordinates to use, the little black book of vertex numbers 📖
  • SoMFFloat knotVector — the knot vector, which controls how the curve behaves, this is the actual secret sauce 🍓

🦋 Protected Member Functions 🦋

  • virtual const SoFieldData * getFieldData (void) const — returns the field data, the class's personal info sheet 💜
  • virtual ~SoIndexedNurbsCurve () — the destructor, the goodbye moment 😭
  • virtual void generatePrimitives (SoAction *action) — generates the primitives, the factory of little geometry bits 🔥
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center) — computes the bounding box and its center, the curve's lil aura 🫧
  • virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp) — makes the line segment detail for picking, so ray picking has something to report back ✨

💜 Protected Member Functions inherited from SoShape

  • SoShape (void)
  • virtual ~SoShape ()
  • float getComplexityValue (SoAction *action)
  • virtual SbBool shouldGLRender (SoGLRenderAction *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 * 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) — pointer to the field data pointer, yes it's a pointer to a pointer, it's giving inception 🌀

💜 Static Protected Member Functions inherited from SoShape

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

💅 Friends 💅

  • class SoIndexedNurbsCurveP — the private implementation buddy, bestie with special access privileges, iykyk 🤝

okay that's the class layout bestie and there is so much more still coming — do not close the tab, part 2 is right there and it's gonna eat 💖

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

okay so SoIndexedNurbsCurve is literally the node for representing smooth curves, bestie. 💖

Explaining NURBS? That's beyond the scope of this documentation, no cap. If you're unfamiliar with the principles of representing smooth curves and surfaces when doing 3D visualization, we recommend finding a good book on the subject, fr fr. 📚

FILE FORMAT/DEFAULTS:

IndexedNurbsCurve {
    numControlPoints 0
    coordIndex 0
    knotVector 0
}

🛠️ Constructor & Destructor Documentation 🛠️

  • SoIndexedNurbsCurve::SoIndexedNurbsCurve (void ) Constructor, bestie! It's literally the constructor. 💅 References coordIndex, knotVector, numControlPoints, and SoIndexedNurbsCurve(). Referenced by getFieldData(), and SoIndexedNurbsCurve().
  • SoIndexedNurbsCurve::~SoIndexedNurbsCurve () [protected], [virtual] Destructor. That's it. 🫡

📚 Member Function Documentation 📚

  • SoType SoIndexedNurbsCurve::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 SoShape.

  • const SoFieldData * SoIndexedNurbsCurve::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 SoShape. References SoIndexedNurbsCurve().
  • void SoIndexedNurbsCurve::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. References SoAction::getState(), SoState::pop(), SoState::push(), and SoShape::shouldGLRender().
  • void SoIndexedNurbsCurve::rayPick (SoRayPickAction * action) [virtual] Calculates picked point based on primitives generated by subclasses. 🎯 Reimplemented from SoShape. References SoAction::getState(), SoState::pop(), SoDebugError::postWarning(), SoState::push(), SoShape::rayPick(), and SoShape::shouldRayPick().
  • void SoIndexedNurbsCurve::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 SoShape::getPrimitiveCount().
  • void SoIndexedNurbsCurve::getBoundingBox (SoGetBoundingBoxAction * action) [virtual] Redefined to notify open caches that this shape contains lines. 📦 Reimplemented from SoShape. References SoShape::getBoundingBox(), and SoAction::getState().
  • void SoIndexedNurbsCurve::sendPrimitive (SoAction * , SoPrimitiveVertex * ) This method is part of the original SGI Inventor API, but not implemented in Coin, as it looks like a method that should probably have been private in Open Inventor. 🚫
  • void SoIndexedNurbsCurve::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.
  • void SoIndexedNurbsCurve::computeBBox (SoAction * action, SbBox3f & box, SbVec3f & center) [protected], [virtual] Calculates the bounding box of all control points, and sets the center to the average of these points. 📐 Implements SoShape. References coordIndex, SbBox3f::extendBy(), SoAction::getState(), SbBox3f::makeEmpty(), numControlPoints, and SbVec3f::setValue().
  • SoDetail * SoIndexedNurbsCurve::createLineSegmentDetail (SoRayPickAction * action, const SoPrimitiveVertex * v1, const SoPrimitiveVertex * v2, SoPickedPoint * pp) [protected], [virtual] Will create line detail for a SoPickedPoint. This method will only be called internally, when generatePrimitives() is used for picking (SoShape::rayPick() is not overridden). 🎣 This method returns NULL in Open Inventor, and subclasses will need to override this method to create details for a SoPickedPoint. This is not necessary with Coin. Of course, if you choose to override it, it will work in the same way as Open Inventor. For this to work, you must supply a face or line detail when generating primitives. If you supply NULL for the detail argument in SoShape::beginShape(), you'll have to override this method. Reimplemented from SoShape.

📊 Member Data Documentation 📊

  • SoSFInt32 SoIndexedNurbsCurve::numControlPoints Number of control points for this curve. 📍 Referenced by computeBBox(), and SoIndexedNurbsCurve().
  • SoMFInt32 SoIndexedNurbsCurve::coordIndex The control point indices. Supply at least numControlPoint indices. 🔢 Referenced by computeBBox(), and SoIndexedNurbsCurve().
  • SoMFFloat SoIndexedNurbsCurve::knotVector The knot vector. 🎀 Referenced by SoIndexedNurbsCurve().

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. 🤖

and that's a wrap, bestie! This was SoIndexedNurbsCurve(3) from Coin Version 2.5.0. Stay slay! 💅✨

📦 where this page comes from