Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
SoDrawStyle Class Reference

The SoDrawStyle class specifies common rendering properties for shapes. More...

#include <Inventor/nodes/SoDrawStyle.h>

Inheritance diagram for SoDrawStyle:
SoNode SoFieldContainer SoBase

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

 SoDrawStyle (void)
 
virtual void callback (SoCallbackAction *action)
 
virtual void doAction (SoAction *action)
 
virtual SoType getTypeId (void) const
 
virtual void GLRender (SoGLRenderAction *action)
 
- Public Member Functions inherited from SoNode
virtual SoNodeaddToCopyDict (void) const
 
virtual SbBool affectsState (void) const
 
virtual void audioRender (SoAudioRenderAction *action)
 
virtual SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
 
virtual SoFieldContainercopyThroughConnection (void) const
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual SoChildListgetChildren (void) const
 
virtual void getMatrix (SoGetMatrixAction *action)
 
SbUniqueId getNodeId (void) const
 
NodeType getNodeType (void) const
 
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void grabEventsCleanup (void)
 
virtual void grabEventsSetup (void)
 
virtual void handleEvent (SoHandleEventAction *action)
 
SbBool isOverride (void) const
 
virtual void notify (SoNotList *l)
 
virtual void pick (SoPickAction *action)
 
virtual void rayPick (SoRayPickAction *action)
 
virtual void search (SoSearchAction *action)
 
void setNodeType (const NodeType type)
 
void setOverride (const SbBool state)
 
virtual void startNotify (void)
 
virtual void write (SoWriteAction *action)
 
virtual void writeInstance (SoOutput *out)
 
- Public Member Functions inherited from SoFieldContainer
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
 
SbBool enableNotify (const SbBool flag)
 
SbBool fieldsAreEqual (const SoFieldContainer *container) const
 
void get (SbString &fielddata)
 
void get (SbString &fielddata, SoOutput *out)
 
virtual int getAllFields (SoFieldList &l) const
 
virtual SoFieldgetEventIn (const SbName &name) const
 
virtual SoFieldgetEventOut (const SbName &name) const
 
virtual SoFieldgetField (const SbName &name) const
 
SbBool getFieldName (const SoField *const field, SbName &name) const
 
virtual int getFields (SoFieldList &l) const
 
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
 
SbBool getIsBuiltIn (void) const
 
voidgetUserData (void) const
 
SbBool hasDefaultValues (void) const
 
SbBool isNotifyEnabled (void) const
 
SbBool set (const char *const fielddata)
 
SbBool set (const char *fielddata, SoInput *input)
 
void setToDefaults (void)
 
void setUserData (void *userdata) const
 
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
 
- Public Member Functions inherited from SoBase
void addAuditor (void *const auditor, const SoNotRec::Type type)
 
void assertAlive (void) const
 
const SoAuditorListgetAuditors (void) const
 
virtual SbName getName (void) const
 
int32_t getRefCount (void) const
 
SbBool isOfType (SoType type) const
 Returns TRUE if the type of this object is either of the same type or inherited from type.
 
void ref (void) const
 
void removeAuditor (void *const auditor, const SoNotRec::Type type)
 
virtual void setName (const SbName &newname)
 
SbBool shouldWrite (void)
 
void touch (void)
 
void unref (void) const
 
void unrefNoDelete (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.
 
- Static Public Member Functions inherited from SoNode
static void audioRenderS (SoAction *action, SoNode *node)
 
static void callbackS (SoAction *action, SoNode *node)
 
static int getActionMethodIndex (const SoType type)
 
static void getBoundingBoxS (SoAction *action, SoNode *node)
 
static SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static SoType getClassTypeId (void)
 
static uint32_t getCompatibilityTypes (const SoType &nodetype)
 
static void getMatrixS (SoAction *action, SoNode *node)
 
static SbUniqueId getNextNodeId (void)
 
static void getPrimitiveCountS (SoAction *action, SoNode *node)
 
static void GLRenderS (SoAction *action, SoNode *node)
 
static void handleEventS (SoAction *action, SoNode *node)
 
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 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 Public Member Functions inherited from SoFieldContainer
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static void cleanupClass (void)
 
static void copyDone (void)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
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 initCopyDict (void)
 
- Static Public Member Functions inherited from SoBase
static void addName (SoBase *const base, const char *const name)
 
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static void decrementCurrentWriteCounter (void)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static SoBasegetNamedBase (const SbName &name, SoType type)
 
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
 
static SbBool getTraceRefs (void)
 
static void incrementCurrentWriteCounter (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.
 
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
 
static SbBool readRoute (SoInput *input)
 
static void removeName (SoBase *const base, const char *const name)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 

Public Attributes

SoSFUShort linePattern
 
SoSFInt32 linePatternScaleFactor
 
SoSFFloat lineWidth
 
SoSFFloat pointSize
 
SoSFEnum style
 

Protected Member Functions

virtual ~SoDrawStyle ()
 
virtual const SoFieldDatagetFieldData (void) const
 
- 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 SoNotRec createNotRec (void)
 
virtual void destroy (void)
 
virtual const char * getFileFormatName (void) const
 
SbBool hasMultipleWriteRefs (void) const
 
void writeFooter (SoOutput *out) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr (void)
 
static int getNextActionMethodIndex (void)
 
static void incNextActionMethodIndex (void)
 
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
 
static void setNextActionMethodIndex (int index)
 
- 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 int nextActionMethodIndex = 0
 
static SbUniqueId nextUniqueId = 1
 

Detailed Description

The SoDrawStyle class specifies common rendering properties for shapes.

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.

Simple scene graph structure usage example:

#Inventor V2.1 ascii
Sphere { }
Translation { translation 4 0 0 }
Sphere { }
Translation { translation 4 0 0 }
Sphere { }
}
The SbList class is a template container class for lists.
Definition SbList.h:70
SoSFFloat lineWidth
Definition SoDrawStyle.h:61
SoSFFloat pointSize
Definition SoDrawStyle.h:60
SoSFEnum style
Definition SoDrawStyle.h:59
@ LINES
Definition SoDrawStyle.h:54
@ POINTS
Definition SoDrawStyle.h:55
Rendering of Example Scenegraph

FILE FORMAT/DEFAULTS:

linePattern 0xffff
}
SoSFUShort linePattern
Definition SoDrawStyle.h:62
SoSFInt32 linePatternScaleFactor
Definition SoDrawStyle.h:63
@ FILLED
Definition SoDrawStyle.h:53

Member Enumeration Documentation

◆ Style

Enumeration for the various ways to render geometry.

Enumerator
FILLED 

Render all geometry as-is.

LINES 

Render all geometry as border lines.

POINTS 

Render all geometry as vertex points.

INVISIBLE 

Don't render geometry.

Constructor & Destructor Documentation

◆ SoDrawStyle()

SoDrawStyle::SoDrawStyle ( void )

Constructor.

◆ ~SoDrawStyle()

SoDrawStyle::~SoDrawStyle ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ callback()

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.

◆ doAction()

void SoDrawStyle::doAction ( SoAction * action)
virtual

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

Reimplemented from SoNode.

◆ getClassTypeId()

SoType SoDrawStyle::getClassTypeId ( void )
static

This static method returns the SoType object associated with objects of this class.

◆ getFieldData()

const SoFieldData * SoDrawStyle::getFieldData ( void ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoFieldContainer.

◆ getFieldDataPtr()

const SoFieldData ** SoDrawStyle::getFieldDataPtr ( void )
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

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

◆ getTypeId()

SoType SoDrawStyle::getTypeId ( void ) const
virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Implements SoBase.

◆ 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 want to throw geometry primitives at OpenGL override this method.

Reimplemented from SoNode.

Member Data Documentation

◆ linePattern

SoSFUShort SoDrawStyle::linePattern

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

◆ linePatternScaleFactor

SoSFInt32 SoDrawStyle::linePatternScaleFactor

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

◆ lineWidth

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

◆ pointSize

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 point size 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 SoGLPointSizeElement.

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

◆ style

SoSFEnum SoDrawStyle::style

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


The documentation for this class was generated from the following files: