SoDrawStyle(3)

📦 version 2.5.0, in fedora 43, fedora 44

👑 SoDrawStyle 👑

okay so this one's straight from the Library Functions Manual bestie, and it's a long one — it comes in 2 parts and this is part 1 💖 more parts follow, don't go anywhere ✨

🌸 NAME 🌸

SoDrawStyle — the class that specifies all the common rendering properties for shapes. she's literally the vibe-setter for everything after her 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoDrawStyle.h>

and bestie, she Inherits SoNode.

💖 Public Types 💖

  • enum Style { FILLED = SoDrawStyleElement::FILLED, LINES = SoDrawStyleElement::LINES, POINTS = SoDrawStyleElement::POINTS, INVISIBLE = SoDrawStyleElement::INVISIBLE }

🦋 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 💖

  • virtual SoType getTypeId (void) const
  • SoDrawStyle (void)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)

🦋 Public Member Functions inherited from SoNode 🦋

the whole inheritance glow-up, no cap:

  • 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 SbBool affectsState (void) const
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • 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 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 💖

  • SoSFEnum style
  • SoSFFloat pointSize
  • SoSFFloat lineWidth
  • SoSFUShort linePattern

💖 Protected Member Functions 💖

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoDrawStyle ()

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

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

💖 DETAILED DESCRIPTION 💖

okay so the SoDrawStyle class specifies all the common rendering properties for shapes. she's the moment, she's the blueprint 💅

Use SoDrawStyle nodes to influence how the shape nodes following them in the scenegraph will be rendered. like, whatever comes after a DrawStyle gets its whole look decided by her, no cap. This node type has fields to help decide how certain aspects of point-based shapes, line-based shapes and filled shape primitives are rendered. ✨

Simple scenegraph structure usage example, bestie edition:

#Inventor V2.1 ascii

Separator {
   Sphere { }
   Translation { translation 4 0 0 }
   DrawStyle { style LINES  lineWidth 2 }
   Sphere { }
   Translation { translation 4 0 0 }
   DrawStyle { style POINTS  pointSize 2 }
   Sphere { }
}

FILE FORMAT/DEFAULTS:

DrawStyle {
    style FILLED
    pointSize 0
    lineWidth 0
    linePattern 0xffff
}

🔥 MEMBER ENUMERATION DOCUMENTATION 🔥

🦋 enum SoDrawStyle::Style 🦋

Enumeration for the various ways to render geometry. pick your fighter, bestie 💅

Enumerator:

  • FILLED — render all geometry as-is. the default, the classic, the moment ✨
  • LINES — render all geometry as border lines. wireframe era activated 🦋
  • POINTS — render all geometry as vertex points. dots, dots, dots 🍓
  • INVISIBLE — don't render geometry. poof, gone, she's literally not here 💀

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

🌸 SoDrawStyle::SoDrawStyle (void ) 🌸

Constructor. new SoDrawStyle just dropped ✨

References FILLED, INVISIBLE, linePattern, LINES, lineWidth, POINTS, pointSize, SoDrawStyle(), and style.

Referenced by getFieldData(), and SoDrawStyle().

🌸 SoDrawStyle::~SoDrawStyle () [protected], [virtual] 🌸

Destructor. she's leaving the group chat, say bye 🫶

and that's part 1 bestie — part 2 is literally right there, keep scrolling 💖

✨ Member Function Documentation ✨

💅 SoType SoDrawStyle::getTypeId (void ) const [virtual] 💅

okay bestie, so this one returns the type identification of an object derived from a class inheriting SoBase. It’s literally for run-time type checking and "downward" casting. periodt.

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.

Implements SoBase.

🦋 const SoFieldData * SoDrawStyle::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 SoFieldContainer.

  • References: SoDrawStyle().

🔥 void SoDrawStyle::doAction (SoAction * action) [virtual] 🔥

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

  • References: SoAction::getState(), SoNode::isOverride(), linePattern, lineWidth, pointSize, SoLineWidthElement::set(), SoPointSizeElement::set(), SoOverrideElement::setDrawStyleOverride(), SoOverrideElement::setLinePatternOverride(), SoOverrideElement::setLineWidthOverride(), SoOverrideElement::setPointSizeOverride(), and style.
  • Referenced by: callback(), and GLRender().

🌈 void SoDrawStyle::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 SoNode.

  • References: doAction().

🫶 void SoDrawStyle::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 SoNode.

  • References: doAction().

🎀 Member Data Documentation 🎀

💖 SoSFEnum SoDrawStyle::style 💖

How to render the geometry following a drawstyle node in the scene graph. Default SoDrawStyle::FILLED.

  • Referenced by: doAction(), and SoDrawStyle().

🍓 SoSFFloat SoDrawStyle::pointSize 🍓

Size in screen pixels of SoPointSet points, and also of geometry vertex points if setting the SoDrawStyle::style to SoDrawStyle::POINTS.

The valid range of pointsize settings varies according to which OpenGL implementation is used. For the purpose of not trying to set illegal values, the application programmer should at run-time check the valid range. How this can be accomplished is described in the class documentation of SoGLPointSizeElement.

Default value is 0.0f, which is a "tag" value which tells the rendering library to use the default setting.

  • Referenced by: doAction(), and SoDrawStyle().

🧚 SoSFFloat SoDrawStyle::lineWidth 🧚

Width in screen pixels of SoLineSet and SoIndexedLineSet lines, and also of geometry border lines if setting the SoDrawStyle::style to SoDrawStyle::LINES.

The valid range of linewidth settings varies according to which OpenGL implementation is used. For the purpose of not trying to set illegal values, the application programmer should at run-time check the valid range. How this can be accomplished is described in the class documentation of SoGLLineWidthElement.

Default value is 0.0f, which is a "tag" value which tells the rendering library to use the default setting.

  • Referenced by: doAction(), and SoDrawStyle().

⭐ SoSFUShort SoDrawStyle::linePattern ⭐

Pattern as a bitmask used when drawing lines. Default is 0xffff (no "holes").

  • Referenced by: doAction(), and SoDrawStyle().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

And that’s the whole vibe, bestie. The footer says Coin, Version 2.5.0, SoDrawStyle(3) — that’s the source/version/page energy, and there’s no extra date on this one. Mwah 💋💖

📦 where this page comes from