Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all 
NAME
SoDrawStyle -
The SoDrawStyle class specificies common rendering properties for shapes.
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.
SYNOPSIS
#include <Inventor/nodes/SoDrawStyle.h>
Inherits SoNode.
Public Types
enum Style { FILLED = SoDrawStyleElement::FILLED, LINES = SoDrawStyleElement::LINES, POINTS =
SoDrawStyleElement::POINTS, INVISIBLE = SoDrawStyleElement::INVISIBLE }
Public Member Functions
virtual SoType getTypeId (void) const
Returns the type identification of an object derived from a class inheriting SoBase. This is used for
run-time type checking and 'downward' casting.
SoDrawStyle (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
Static Public Member Functions
static SoType getClassTypeId (void)
static void initClass (void)
Public Attributes
SoSFEnum style
SoSFFloat pointSize
SoSFFloat lineWidth
SoSFUShort linePattern
SoSFInt32 linePatternScaleFactor
Protected Member Functions
virtual const SoFieldData * getFieldData (void) const
virtual ~SoDrawStyle ()
Static Protected Member Functions
static const SoFieldData ** getFieldDataPtr (void)
Additional Inherited Members
Detailed Description
The SoDrawStyle class specificies common rendering properties for shapes.
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:
#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.
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 (void)
Constructor.
SoDrawStyle::~SoDrawStyle () [protected], [virtual]
Destructor.
Member Function Documentation
SoType SoDrawStyle::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
}
}
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.
void SoDrawStyle::doAction (SoAction *action) [virtual]
This function performs the typical operation of a node for any action.
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.
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 drawstyle node in the scene graph. Default 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 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.
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.
SoSFUShort SoDrawStyle::linePattern
Pattern as a bitmask used when drawing lines. Default is 0xffff (no 'holes').
Author
Generated automatically by Doxygen for Coin from the source code.