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 SoElement *	copyMatchInfo (void) const
virtual SbBool	matches (const SoElement *element) const
virtual void	print (FILE *file) const
virtual void	setElt (int32_t value)
Public Member Functions inherited from SoElement
virtual	~SoElement ()
int	getDepth (void) const
int	getStackIndex (void) const
const SoType	getTypeId (void) const
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	push (SoState *state)
void	setDepth (const int depth)

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

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

Additional Inherited Members
Static Protected Member Functions inherited from SoElement
static int	createStackIndex (const SoType id)
static const SoElement *	getConstElement (SoState *const state, const int stackIndex)
static SoElement *	getElement (SoState *const state, const int stackIndex)
Protected Attributes inherited from SoInt32Element
int32_t	data
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
SoType	typeId
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

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.

Creates a new instance of the class type corresponding to the SoType object.

get()

int32_t SoLinePatternElement::get ( SoState *const state )

static

Returns line stipple pattern from state.

getClassStackIndex()

int SoLinePatternElement::getClassStackIndex ( void )

static

This static method returns the state stack index for the class.

getClassTypeId()

SoType SoLinePatternElement::getClassTypeId ( void )

static

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

getDefault()

int32_t SoLinePatternElement::getDefault ( )

static

Returns default line stipple pattern.

getDefaultScaleFactor()

int32_t SoLinePatternElement::getDefaultScaleFactor ( )

static

Returns default line stipple pattern scale factor.

getScaleFactor()

int32_t SoLinePatternElement::getScaleFactor ( SoState *const state )

static

Returns line stipple pattern scale factor from state.

init()

void SoLinePatternElement::init ( SoState * state )

virtual

Initializes element in state to default value.

Reimplemented from SoInt32Element.

Reimplemented in SoGLLinePatternElement.

initClass()

void SoLinePatternElement::initClass ( void )

static

Initialize relevant common data for all instances, like the type system.

set() [1/2]

void SoLinePatternElement::set ( SoState *const state, 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, SoNode *const node, const int32_t pattern, const int32_t factor = 1 )

static

Sets the given pattern in the state.

---

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

• SoLinePatternElement.h
• SoLinePatternElement.cpp