SoLinePatternElement Class Reference

The SoLinePatternElement class defines the line stipple pattern. More...

#include <Inventor/elements/SoLinePatternElement.h>

Inheritance diagram for SoLinePatternElement:

Public Types
enum	Patterns { CONTINUOUS = 0xFFFF }

Public Member Functions
virtual void	init (SoState *state)
Public Member Functions inherited from SoInt32Element
virtual SbBool	matches (const SoElement *element) const
virtual SoElement *	copyMatchInfo (void) const
virtual void	print (FILE *file) const
virtual void	setElt (int32_t value)
	FIXME: write doc.
Public Member Functions inherited from SoElement
const SoType	getTypeId (void) const
int	getStackIndex (void) const
virtual void	push (SoState *state)
virtual void	pop (SoState *state, const SoElement *prevTopElement)
void	setDepth (const int depth)
int	getDepth (void) const
virtual	~SoElement ()

Static Public Member Functions
static SoType	getClassTypeId (void)
static int	getClassStackIndex (void)
static void *	createInstance (void)
static void	initClass (void)
static void	set (SoState *const state, SoNode *const node, const int32_t pattern, const int32_t factor=1)
static void	set (SoState *const state, const int32_t pattern, const int32_t factor=1)
static int32_t	get (SoState *const state)
static int32_t	getDefault ()
static int32_t	getScaleFactor (SoState *const state)
static int32_t	getDefaultScaleFactor ()
Static Public Member Functions inherited from SoInt32Element
static SoType	getClassTypeId (void)
static int	getClassStackIndex (void)
static void	initClass (void)
static void	set (const int index, SoState *const state, SoNode *const node, const int32_t value)
static void	set (const int index, SoState *const state, const int32_t value)
static int32_t	get (const int index, SoState *const state)
	FIXME: write doc.
Static Public Member Functions inherited from SoElement
static void	initClass (void)
static SoType	getClassTypeId (void)
static int	getClassStackIndex (void)
static void	initElements (void)
static int	getNumStackIndices (void)
static SoType	getIdFromStackIndex (const int stackIndex)

Protected Member Functions
virtual	~SoLinePatternElement ()
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
virtual void	captureThis (SoState *state) const
void	setTypeId (const SoType typeId)
void	setStackIndex (const int index)
SoElement *	getNextInStack (void) const
SoElement *	getNextFree (void) const

Additional Inherited Members
Static Protected Member Functions inherited from SoElement
static SoElement *	getElement (SoState *const state, const int stackIndex)
static const SoElement *	getConstElement (SoState *const state, const int stackIndex)
static int	createStackIndex (const SoType id)
Protected Attributes inherited from SoInt32Element
int32_t	data
Protected Attributes inherited from SoElement
SoType	typeId
int	stackIndex
int	depth
Static Protected Attributes inherited from SoElement
static int	classStackIndex
static SoTypeList *	stackToType

Detailed Description

The SoLinePatternElement class defines the line stipple pattern.

Line stippling is used to mask out fragments of a line.

Constructor & Destructor Documentation

~SoLinePatternElement()

SoLinePatternElement::~SoLinePatternElement ( void  )

protectedvirtual

The destructor.

Member Function Documentation

createInstance()

void * SoLinePatternElement::createInstance ( void  )

static

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

initClass()

void SoLinePatternElement::initClass ( void  )

static

This static method initializes static data for the SoLinePatternElement class.

init()

void SoLinePatternElement::init ( SoState *  state )

virtual

Initializes element in state to default value.

Reimplemented from SoInt32Element.

Reimplemented in SoGLLinePatternElement.

set() [1/2]

void SoLinePatternElement::set ( SoState *const  state, SoNode *const  node, const int32_t  pattern, const int32_t  factor = 1  )

static

Sets the given pattern in the state.

set() [2/2]

void SoLinePatternElement::set ( SoState *const  state, const int32_t  pattern, const int32_t  factor = 1  )

static

Sets the given pattern in the state.

get()

int32_t SoLinePatternElement::get ( SoState *const  state )

static

Returns line stipple pattern from state.

getDefault()

int32_t SoLinePatternElement::getDefault ( )

static

Returns default line stipple pattern.

getScaleFactor()

int32_t SoLinePatternElement::getScaleFactor ( SoState *const  state )

static

Returns line stipple pattern scale factor from state.

getDefaultScaleFactor()

int32_t SoLinePatternElement::getDefaultScaleFactor ( )

static

Returns default line stipple pattern scale factor.

---

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

• SoLinePatternElement.h
• SoLinePatternElement.cpp