Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
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:
SoElement SoComplexityElement SoCreaseAngleElement SoDecimationPercentageElement SoFocalDistanceElement SoFontSizeElement SoLineWidthElement SoListenerGainElement SoPointSizeElement SoTextureQualityElement

Public Member Functions

virtual void init (SoState *state)
 
virtual SbBool matches (const SoElement *element) const
 
virtual SoElementcopyMatchInfo (void) const
 
virtual void print (FILE *file) const
 
virtual void setElt (float value)
 
- 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 initClass (void)
 
static void set (const int stackIndex, SoState *const state, SoNode *const node, const float value)
 
static void set (const int stackIndex, SoState *const state, const float value)
 
static float get (const int stackIndex, SoState *const state)
 
- 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 ~SoFloatElement ()
 
- 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)
 
SoElementgetNextInStack (void) const
 
SoElementgetNextFree (void) const
 

Protected Attributes

float data
 
- Protected Attributes inherited from SoElement
SoType typeId
 
int stackIndex
 
int depth
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *const state, const int stackIndex)
 
static const SoElementgetConstElement (SoState *const state, const int stackIndex)
 
static int createStackIndex (const SoType id)
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 
static SoTypeListstackToType
 

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

◆ init()

void SoFloatElement::init ( SoState state)
virtual

This function initializes the element type in the given SoState. It is called for the first element of each enabled element type in SoState objects.

Reimplemented from SoElement.

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

◆ 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.

◆ 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.

◆ 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  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.

◆ set() [2/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.

◆ 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.

◆ setElt()

void SoFloatElement::setElt ( float  value)
virtual

Set element value.

Reimplemented in SoGLPointSizeElement, and SoGLLineWidthElement.

Member Data Documentation

◆ data

float SoFloatElement::data
protected

The element's value.


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