SoFloatElement Class Reference

SoFloatElement is an abstract base class for elements that consists of a single float value. More...

#include <Inventor/elements/SoFloatElement.h>

Inheritance diagram for SoFloatElement:

Public Member Functions
virtual SoElement *	copyMatchInfo (void) const
virtual void	init (SoState *state)
virtual SbBool	matches (const SoElement *element) const
virtual void	print (FILE *file) const
virtual void	setElt (float 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 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	~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)

Protected Attributes
float	data
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
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)
Static Protected Attributes inherited from SoElement
static int	classStackIndex
static SoTypeList *	stackToType

Detailed Description

SoFloatElement is an abstract base class for elements that consists of a single float value.

This is the superclass of elements where the new element data replaces the old data, and where the data the element stores is a simple single precision floating point value.

This element is like a convenient light-weight version of the SoReplacedElement. It differs from the SoReplacedElement in that the set() and get() methods are already implemented, since it is known that subclasses will still contain just a single float value.

See also

SoReplacedElement, SoInt32Element, SoAccumulatedElement

Constructor & Destructor Documentation

~SoFloatElement()

SoFloatElement::~SoFloatElement ( void )

protectedvirtual

Destructor.

Member Function Documentation

copyMatchInfo()

SoElement * SoFloatElement::copyMatchInfo ( void ) const

virtual

This function creates a copy of the element that contains enough information to enable the matches() function to work.

Used to help with scene graph traversal caching operations.

Implements SoElement.

get()

float SoFloatElement::get ( const int index, SoState *const state )

static

Static method to fetch the value of the element of this type from the given state at the given stack index.

getClassStackIndex()

int SoFloatElement::getClassStackIndex ( void )

static

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

getClassTypeId()

SoType SoFloatElement::getClassTypeId ( void )

static

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

init()

void SoFloatElement::init ( SoState * state )

virtual

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

Reimplemented from SoElement.

Reimplemented in SoComplexityElement, SoCreaseAngleElement, SoDecimationPercentageElement, SoFocalDistanceElement, SoFontSizeElement, SoGLLineWidthElement, SoGLPointSizeElement, SoLineWidthElement, SoListenerGainElement, SoPointSizeElement, and SoTextureQualityElement.

initClass()

void SoFloatElement::initClass ( void )

static

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

matches()

SbBool SoFloatElement::matches ( const SoElement * element ) const

virtual

This function returns TRUE is the element matches another element (of the same class), with respect to cache validity.

If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function.

Implements SoElement.

print()

void SoFloatElement::print ( FILE * file ) const

virtual

This function is for printing element information, and is used mostly for debugging purposes.

Reimplemented from SoElement.

set() [1/2]

void SoFloatElement::set ( const int stackIndex, SoState *const state, const float value )

static

Static method for setting the value of an element in the given state at the given stackIndex.

set() [2/2]

void SoFloatElement::set ( const int index, SoState *const state, SoNode *const node, const float value )

static

Static method for setting the value of an element in the given state at the given stack index.

setElt()

void SoFloatElement::setElt ( float value )

virtual

Set element value.

Reimplemented in SoGLPointSizeElement, and SoGLLineWidthElement.

Member Data Documentation

data

float SoFloatElement::data

protected

The floating point value of the element.

---

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

• SoFloatElement.h
• SoFloatElement.cpp