SoGLLineWidthElement Class Reference

The SoGLLineWidthElement class changes the line width setting of the OpenGL render state. More...

#include <Inventor/elements/SoGLLineWidthElement.h>

Inheritance diagram for SoGLLineWidthElement:

Public Member Functions
virtual void	init (SoState *state)
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	push (SoState *state)
Public Member Functions inherited from SoFloatElement
virtual SoElement *	copyMatchInfo (void) const
virtual SbBool	matches (const SoElement *element) const
virtual void	print (FILE *file) const
Public Member Functions inherited from SoElement
virtual	~SoElement ()
int	getDepth (void) const
int	getStackIndex (void) const
const SoType	getTypeId (void) const
void	setDepth (const int depth)

Static Public Member Functions
static void *	createInstance (void)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoLineWidthElement
static void *	createInstance (void)
static float	get (SoState *const state)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static float	getDefault ()
static void	initClass (void)
static void	set (SoState *const state, const float lineWidth)
static void	set (SoState *const state, SoNode *const node, const float lineWidth)
Static Public Member Functions inherited from SoFloatElement
static float	get (const int stackIndex, SoState *const state)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
static void	set (const int stackIndex, SoState *const state, const float value)
static void	set (const int stackIndex, SoState *const state, SoNode *const node, const float 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	~SoGLLineWidthElement ()
virtual void	setElt (float width)
Protected Member Functions inherited from SoLineWidthElement
virtual	~SoLineWidthElement ()
Protected Member Functions inherited from SoFloatElement
virtual	~SoFloatElement ()
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 SoFloatElement
float	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 SoGLLineWidthElement class changes the line width setting of the OpenGL render state.

Requests from the scene graph to change the line width when rendering OpenGL line primitives will be made through this element, which forwards it to the appropriate native OpenGL call.

The Coin library does not place any bounds on the values of the line widths, but be aware that the range and granularity of what is valid line widths depends on the underlying OpenGL implementation. Application programmers using line primitives (typically through the SoLineSet or SoIndexedLineSet nodes) should consider these boundary values. They can be acquired by running the following code from within a valid OpenGL context:

GLfloat bounds[2];
glGetFloatv(GL_LINE_WIDTH_RANGE, bounds);
GLfloat granularity[1];
glGetFloatv(GL_LINE_WIDTH_GRANULARITY, granularity);

Another, perhaps more convenient, way of acquiring the OpenGL implementation limits with regard to point sizes is to use the So@Gui@GLWidget::getPointSizeLimits() method in the GUI "glue" interface library you are using (SoQt, SoXt, SoGtk, SoWin, ...).

Constructor & Destructor Documentation

~SoGLLineWidthElement()

SoGLLineWidthElement::~SoGLLineWidthElement ( void )

protectedvirtual

Destructor.

Member Function Documentation

createInstance()

void * SoGLLineWidthElement::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.

getClassStackIndex()

int SoGLLineWidthElement::getClassStackIndex ( void )

static

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

getClassTypeId()

SoType SoGLLineWidthElement::getClassTypeId ( void )

static

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

init()

void SoGLLineWidthElement::init ( SoState * state )

virtual

Initializes the element to its default value. The default value is 0.0.

Reimplemented from SoLineWidthElement.

initClass()

void SoGLLineWidthElement::initClass ( void )

static

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

pop()

void SoGLLineWidthElement::pop ( SoState * state, const SoElement * prevTopElement )

virtual

This method is called when the state is popped, and the depth of the element is bigger than the current state depth. pop() is called on the new top of stack, and a pointer to the previous top of stack is passed in prevTopElement.

Override this method if you need to copy some state information from the previous top of stack.

Reimplemented from SoElement.

push()

void SoGLLineWidthElement::push ( SoState * state )

virtual

This method is called every time a new element is required in one of the stacks. This happens when a writable element is requested, using SoState::getElement() or indirectly SoElement::getElement(), and the depth of the current element is less than the state depth.

Override this method if your element needs to copy data from the previous top of stack. The push() method is called on the new element, and the previous element can be found using SoElement::getNextInStack().

Reimplemented from SoElement.

setElt()

void SoGLLineWidthElement::setElt ( float value )

protectedvirtual

Set element value.

Reimplemented from SoFloatElement.

---

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

• SoGLLineWidthElement.h
• SoGLLineWidthElement.cpp