SoDrawStyle(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

🌸 SoDrawStyle 🌸

okay bestie, welcome to SoDrawStyle(3) β€” a Library Functions Manual page and honestly? lowkey a vibe. sit down, grab a strawberry drink πŸ“, and let's get into it.


✨ NAME ✨

SoDrawStyle β€” the class that specifies common rendering properties for shapes. yes, "specificies" is how the original spells it and I'm keeping it fr fr πŸ’€


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/nodes/SoDrawStyle.h>

Inherits SoNode. it's giving nepo baby but in a cute way πŸ‘‘

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

πŸ’œ 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

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)
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=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
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 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)
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 *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

SoSFEnum style
SoSFFloat pointSize
SoSFFloat lineWidth
SoSFUShort linePattern
SoSFInt32 linePatternScaleFactor

like, the actual fields you get to play with πŸ’…

πŸ“ 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

πŸ¦‹ 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 = 1
static int nextActionMethodIndex = 0

🌟 Detailed Description 🌟

The SoDrawStyle class specificies common rendering properties for shapes. (again. keeping the typo. it's canon now. no cap.)

Use SoDrawStyle nodes to influence how shape nodes following them in the scenegraph 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. ✨

Simple scenegraph structure usage example β€” literally the cutest way to explain it:

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

notice how each DrawStyle only affects what comes after it in the tree, bestie. it's giving "rules for the people behind me" main character energy πŸ’…

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:

Enumerator

  • FILLED β€” Render all geometry as-is. the no-notes, unbothered default 🫢
  • LINES β€” Render all geometry as border lines.
  • POINTS β€” Render all geometry as vertex points.
  • INVISIBLE β€” Don't render geometry. not me ghosting the entire scene πŸ’€

πŸŽ€ Constructor & Destructor Documentation πŸŽ€

SoDrawStyle::SoDrawStyle (void )

Constructor. it's here, it's ready, it's serving.

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

Destructor. protected and virtual, as it should be. slay.

πŸ’… Member Function Documentation πŸ’…

okay bestie, we're deep in the function docs now. strap in, because this is where the type system and action magic live. no cap. ✨


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

This one returns the type identification of an object derived from a class that inherits SoBase. It's giving run-time type checking and "downward" casting energy, periodt.

Usage example, bestie:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. That's 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 info 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, it returns NULL. lowkey straightforward, ngl.

Reimplemented from SoFieldContainer.


πŸ’« void SoDrawStyle::doAction (SoAction * action) [virtual] πŸ’«

This function performs the typical operation of a node for any action. main character energy, fr fr.

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 who wants to throw geometry primitives at OpenGL, overrides this method. slay.

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

Reimplemented from SoNode.


🌈 Member Data Documentation 🌈

πŸ‘‘ SoSFEnum SoDrawStyle::style πŸ‘‘

How to render the geometry following a drawstyle node in the scene graph. Default is SoDrawStyle::FILLED. the vibe check for your geometry, honestly.

πŸ’œ 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. no cap.

🌊 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. obsessed.

⭐ SoSFUShort SoDrawStyle::linePattern ⭐

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


🫢 Author 🫢

Generated automatically by Doxygen for Coin from the source code. so meta.


πŸ’– that's the whole vibe, bestie. this page was brought to you by Coin, Version 3.1.3, and the manual page SoDrawStyle(3). mwah. πŸ’…

πŸ“¦ where this page comes from