SoLinePatternElement Class Reference

Stores the current line stipple pattern. More...

#include <Inventor/elements/SoLinePatternElement.h>

Inheritance diagram for SoLinePatternElement:

Public Member Functions
virtual void	print (FILE *fp) const
	Prints element (for debugging).
Public Member Functions inherited from SoElement
virtual void	push (SoState *state)
	Pushes element.
virtual void	pop (SoState *state, const SoElement *prevTopElement)
	Pops element.
virtual SoType	getTypeId () const
	Returns type identifier for element 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 int	getClassStackIndex ()
	Returns the stack id for this element.
static void	set (SoState *state, u_short pattern, int factor=1)
	Sets the current line pattern in the state.
static void	set (SoState *state, SoNode *, u_short pattern, int factor=1)
	Sets the current line pattern in the state.
static u_short	get (SoState *state, int &factor)
	Returns current line pattern from the state.
static u_short	getDefault ()
	Deprecated: Returns the default line pattern.
static u_short	getDefaultPattern ()
	Returns the default line pattern.
static int	getDefaultScaleFactor ()
	Returns the default line pattern scale factor.
Static Public Member Functions inherited from SoReplacedElement
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static int	getClassStackIndex ()
	Returns the stack id for this element.
Static Public Member Functions inherited from SoElement
static SoType	getClassTypeId ()
	Returns type identifier for SoElement class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Stores the current line stipple pattern.

This slement stores the current line stipple pattern.

SEE ALSO

SoDrawStyle

Definition at line 67 of file SoLinePatternElement.h.

Member Function Documentation

get()

static u_short SoLinePatternElement::get ( SoState *  state, int &  factor  )

static

Returns current line pattern from the state.

The current line pattern scale factor from the state is returned in factor.

getClassStackIndex()

static int SoLinePatternElement::getClassStackIndex ( )

static

Returns the stack id for this element.

getClassTypeId()

static SoType SoLinePatternElement::getClassTypeId ( )

static

Returns the type identifier for this class.

getDefault()

static u_short SoLinePatternElement::getDefault ( )

inlinestatic

Deprecated: Returns the default line pattern.

Definition at line 94 of file SoLinePatternElement.h.

getDefaultPattern()

static u_short SoLinePatternElement::getDefaultPattern ( )

inlinestatic

Returns the default line pattern.

Definition at line 100 of file SoLinePatternElement.h.

getDefaultScaleFactor()

static int SoLinePatternElement::getDefaultScaleFactor ( )

inlinestatic

Returns the default line pattern scale factor.

A multiplier for each bit in the line pattern. If factor is 3, for example, each bit in the pattern will be used three times before the next bit in the pattern is used. The factor parameter is clamped to the range [1, 256] and defaults to 1.

Definition at line 112 of file SoLinePatternElement.h.

print()

virtual void SoLinePatternElement::print ( FILE *  fp ) const

virtual

Prints element (for debugging).

Reimplemented from SoReplacedElement.

set() [1/2]

static void SoLinePatternElement::set ( SoState *  state, SoNode *  , u_short  pattern, int  factor = 1  )

inlinestatic

Sets the current line pattern in the state.

Definition at line 81 of file SoLinePatternElement.h.

set() [2/2]

static void SoLinePatternElement::set ( SoState *  state, u_short  pattern, int  factor = 1  )

static

Sets the current line pattern in the state.

---

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

• Inventor/elements/SoLinePatternElement.h