SoDrawStyle(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoDrawStyle(3) — the Coin manual, part 1 of 2 🎀

okay bestie, sit DOWN. this is the SoDrawStyle page from the Coin manual, section 3, and it's a whole meal. no cap. we're doing the full thing — every type, every member function, every inherited little gremlin — and it's giving thorough. let's get into it 💅

🌸 NAME 🌸

SoDrawStyle — the class that specifies common rendering properties for shapes. that's it, that's the whole vibe. 🦋

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoDrawStyle.h>

Inherits SoNode. (so it's a whole node, obviously, it's in the name, iykyk 👑)

🎀 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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

💅 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

these are the ones your girl inherited and did NOT have to write herself. iconic behaviour honestly 💜

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=FALSE) 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)
  • SbUniqueId 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=FALSE)
  • 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 *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) 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 — returns TRUE if the type of this object is either of the same type or inherited from type. like, it does a vibe check on the type system fr fr 🫶
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. the little pre-game ritual, bestie ✨

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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. ✨
  • static void initClasses (void)
  • static SbUniqueId 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. ✨
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. 👑
  • static void cleanupClass (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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. ✨
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. 👑
  • 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 *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

🍓 Public Attributes

the actual fields, the main characters of this whole node 💖

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

🎀 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)
  • virtual ~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
  • virtual SoNotRec createNotRec (void)

⭐ 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

  • SbUniqueId uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

👑 Detailed Description 👑

The SoDrawStyle class specifies common rendering properties for shapes. (yes bestie the NAME section said it and the Detailed Description is saying it again. it's thorough like that. periodt 💅)

Use SoDrawStyle nodes to influence how shape nodes following them in the scene graph will be rendered. This node type have fields to help decide how certain aspects of point-based shapes, line-based shapes and filled shape primitives are rendered. so basically you drop one of these in your scene graph and everything after it gets styled. main character energy fr fr 🔥

Simple scene graph structure usage example:

#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 💜

the defaults, laid out exactly as they live in the file format. copy them character for character or the vibes will be off 🧚

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

and that's the end of part 1, bestie — we're not done yet, there's more coming, so don't go anywhere 💖

✨ Member Enumeration Documentation ✨

🎀 enum SoDrawStyle::Style

Bestie, this enum is literally the menu of ways you can render your geometry. Pick your vibe:

  • FILLED — render all geometry as-is, no notes, fully solid. The default slay. 💅
  • LINES — render all geometry as border lines instead. Wireframe era. 🦋
  • POINTS — render all geometry as vertex points. Every vertex is a lil star. ⭐
  • INVISIBLE — don't render geometry at all. Ghost mode, gone, not here, unbothered. 👻

🌸 Constructor & Destructor Documentation 🌸

SoDrawStyle::SoDrawStyle (void )

Constructor. Makes the thing. ✨

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

Destructor. Unmakes the thing. It's protected, so it's giving internal business only, iykyk. 🙈

💖 Member Function Documentation 💖

SoType SoDrawStyle::getClassTypeId (void ) — [static]

This static method returns the SoType object associated with objects of this class. It's the class-level ID card, no instance required. 👑

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

Returns the type identification of an object derived from a class inheriting SoBase. This is what makes runtime type checking and "downward" casting work — so you can peek at what something actually is before you treat it like its parent. Reimplemented from SoBase. 🔍

const SoFieldData ** SoDrawStyle::getFieldDataPtr (void ) — [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (Translation: bestie, this is not for you, it's the library's own business. 💀)

Returns the SoFieldData class which holds information about fields in this node.

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, it returns NULL. Reimplemented from SoFieldContainer. 🫶

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

This function performs the typical operation of a node for any action. One node, every action, versatile icon. Reimplemented from SoNode. 🌈

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 that want to throw geometry primitives at OpenGL, override this method. Reimplemented from SoNode. 🔥

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. 💜

🧚 Member Data Documentation 🧚

SoSFEnum SoDrawStyle::style

How to render the geometry following a draw style node in the scene graph. Default is SoDrawStyle::FILLED. ✨

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 main character of point sizing. ⭐

Heads up bestie — the valid range of point size settings varies according to which OpenGL implementation is used. So for the purpose of not trying to set illegal values, the application programmer should at runtime 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. 🏷️

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.

Same warning energy, no cap — the valid range of line width settings varies according to which OpenGL implementation is used. For the purpose of not trying to set illegal values, the application programmer should at runtime 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. 🏷️

SoSFUShort SoDrawStyle::linePattern

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

SoSFInt32 SoDrawStyle::linePatternScaleFactor

Multiplier for the bitmask in linePattern (range 1 - 256). Default is 1.

👑 Author 👑

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

And that's the whole page, bestie — this was Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's giving SoDrawStyle(3). Go forth and render responsibly. 🎀💖🦋

📦 where this page comes from