SoDrawStyle Class Reference

Node that defines the style to use when rendering. More...

#include <Inventor/nodes/SoDrawStyle.h>

Inheritance diagram for SoDrawStyle:

Public Types
enum	Style {   FILLED = SoDrawStyleElement::FILLED ,   LINES = SoDrawStyleElement::LINES ,   POINTS = SoDrawStyleElement::POINTS ,   INVISIBLE = SoDrawStyleElement::INVISIBLE ,   MARKERS = SoDrawStyleElement::MARKERS }
	Draw styles. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoDrawStyle ()
	Creates a drawing style node with default settings.
virtual void	setOverride (const SbBool state)
	Set the state of the override field.
virtual SbBool	isOverride () const
	Returns the state of the override field.
Public Member Functions inherited from SoNode
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFEnum	style
	Drawing style.
SoSFFloat	pointSize
	Radius of points (for POINTS style).
SoSFFloat	lineWidth
	Width of lines (for LINES style).
SoSFUShort	linePattern
	Stipple pattern for lines (for LINES style).
SoSFInt32	linePatternScaleFactor
	Stipple pattern scale factor (for LINES style).

Detailed Description

Node that defines the style to use when rendering.

This node defines the current drawing style for all subsequent shape nodes in a scene graph. SoDrawStyle specifies how primitives should be rendered.

Draw style

The drawing style has no effect on picking or callback primitive generation. In particular, geometry with style INVISIBLE is not rendered but is still pickable.
It can be useful to put, for example, an invisible sphere around an assembly to ensure that it is always picked as a unit.

Style INVISIBLE should generally not be used to "turn off" geometry. It is more efficient to put an SoSwitch node above the geometry and all its associated nodes. Using the Switch's whichChild field to "turn off" geometry avoids traversing any of the associated nodes.

Point size and line width notes

• The default point size and line width are both 0, which means to use the OpenGL default value (1 in both cases). Point size and line width valuess greater than zero are considered to be specified in printer's points, where 1 inch = 72 printer's points. However the default pixels-per-inch (managed by SbViewportRegion) is also 72. So effectively point size and line width are specified in pixels unless the application specifically sets a different pixels-per-inch value.
• The maximum line width is hardware dependent. Only width 1 is guaranteed. An application could simulate wider lines using polygons if necessary.
• If line antialiasing is disabled (which is the default), then OpenGL rounds the specified line width to the nearest integer. If rounding results in the value 0, it is as if the line width was set to 1.
• When the specified point size and/or line width is greater than zero, the SoDrawStyle node will have a dependency on the SoViewportRegionElement (for the pixels-per-inch value). As a result render caches may be invalidated when the viewport size changes, e.g. if the drawing window is resized.

FILE FORMAT/DEFAULT

DrawStyle {

style	FILLED
pointSize	0
lineWidth	0
linePattern	0xffff
linePatternScaleFactor	1

}

ACTION BEHAVIOR

SoGLRenderAction, SoCallbackAction
Sets the current drawing style. Sets: SoDrawStyleElement, SoPointSizeElement, SoLineWidthElement, SoLinePatternElement.

SEE ALSO

SoLightModel, SoPickStyle, SoShapeHints, SoColorMask

Definition at line 142 of file SoDrawStyle.h.

Member Enumeration Documentation

Style

enum SoDrawStyle::Style

Draw styles.

Enumerator
FILLED	Draw filled regions.
LINES	Draw only outlines (wireframe)
POINTS	Draw points at vertices.
INVISIBLE	Do not draw anything at all.
MARKERS	Draw markers.

Definition at line 148 of file SoDrawStyle.h.

Constructor & Destructor Documentation

SoDrawStyle()

SoDrawStyle::SoDrawStyle

(

)

Creates a drawing style node with default settings.

Member Function Documentation

getClassTypeId()

static SoType SoDrawStyle::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoDrawStyle::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

isOverride()

virtual SbBool SoDrawStyle::isOverride ( ) const

inlinevirtual

Returns the state of the override field.

Reimplemented from SoNode.

Definition at line 239 of file SoDrawStyle.h.

setOverride()

virtual void SoDrawStyle::setOverride ( const SbBool  state )

inlinevirtual

Set the state of the override field.

see SoNode::setOverride doc.

Reimplemented from SoNode.

Definition at line 233 of file SoDrawStyle.h.

Member Data Documentation

linePattern

SoSFUShort SoDrawStyle::linePattern

Stipple pattern for lines (for LINES style).

This specifies how dashed or dotted lines will be drawn. The pattern is a 16-bit series of 0s and 1s and is repeated as necessary to stipple a given line. A 1 indicates that drawing occurs, and a 0 that it does not, on a pixel-by-pixel basis, starting with the low-order bits of the pattern. Values can range from 0 (invisible) to 0xffff (solid). Default is 0xffff.

The line pattern can be stretched using the linePatternScaleFactor field.

Definition at line 213 of file SoDrawStyle.h.

linePatternScaleFactor

SoSFInt32 SoDrawStyle::linePatternScaleFactor

Stipple pattern scale factor (for LINES style).

It stretches the line pattern (see linePattern) by multiplying each subseries of consecutive 1s and 0s. Scale factors are clamped to lie between 1 and 255. Default is 1.

NOTE: field available since Open Inventor 4.0

Definition at line 222 of file SoDrawStyle.h.

lineWidth

SoSFFloat SoDrawStyle::lineWidth

Width of lines (for LINES style).

The default line width is 0, meaning to use the default OpenGL value (1). Line widths greater than zero are considered to be specified in printer's points, where 1 inch = 72 printer's points. However the default pixels-per-inch value (managed by SbViewportRegion) is also 72. So effectively line width is specified in pixels unless the application sets a different pixels-per-inch value.

Please see the notes in the class description for more information.

Definition at line 200 of file SoDrawStyle.h.

pointSize

SoSFFloat SoDrawStyle::pointSize

Radius of points (for POINTS style).

Default is 0, meaning to use the default OpenGL value (1). Point sizes greater than zero are considered to be specified in printer's point, where 1 inch = 72 printer's points. However the default pixels-per-inch value (managed by SbViewportRegion) is also 72. So effectively point size is specified in pixels unless the application sets a different pixels-per-inch value.

Please see the notes in the class description for more information.

Definition at line 188 of file SoDrawStyle.h.

style

SoSFEnum SoDrawStyle::style

Drawing style.

Use enum Style. Default is FILLED.

Definition at line 176 of file SoDrawStyle.h.

---

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

• Inventor/nodes/SoDrawStyle.h