Coin Logo http://www.sim.no
http://www.coin3d.org

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | Related Pages

SoFloatElement Class Reference
[Elements (mostly for internal use)]

#include <Inventor/elements/SoFloatElement.h>

Inheritance diagram for SoFloatElement:

SoElement SoLineWidthElement SoListenerGainElement SoPointSizeElement SoGLLineWidthElement SoGLPointSizeElement List of all members.

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


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)

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)

Protected Member Functions

virtual ~SoFloatElement ()

Protected Attributes

float data


Constructor & Destructor Documentation

SoFloatElement::~SoFloatElement void   )  [protected, virtual]
 

Destructor.


Member Function Documentation

SoType SoFloatElement::getClassTypeId void   )  [static]
 

This static method returns the class type.

Reimplemented from SoElement.

Reimplemented in SoGLLineWidthElement, SoGLPointSizeElement, SoLineWidthElement, SoPointSizeElement, and SoListenerGainElement.

int SoFloatElement::getClassStackIndex void   )  [static]
 

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

Reimplemented from SoElement.

Reimplemented in SoGLLineWidthElement, SoGLPointSizeElement, SoLineWidthElement, SoPointSizeElement, and SoListenerGainElement.

void SoFloatElement::initClass void   )  [static]
 

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

Reimplemented from SoElement.

Reimplemented in SoGLLineWidthElement, SoGLPointSizeElement, SoLineWidthElement, SoPointSizeElement, and SoListenerGainElement.

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 SoGLLineWidthElement, SoGLPointSizeElement, SoLineWidthElement, SoPointSizeElement, and SoListenerGainElement.

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.

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 scenegraph traversal caching operations.

Implements SoElement.

void SoFloatElement::print FILE *  file  )  const [virtual]
 

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

Reimplemented from SoElement.

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.

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.

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.

void SoFloatElement::setElt float  value  )  [virtual]
 

Set element value.

Reimplemented in SoGLLineWidthElement, and SoGLPointSizeElement.


Member Data Documentation

float SoFloatElement::data [protected]
 

The element's value.


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

Copyright © 1998-2004 by Systems in Motion AS. All rights reserved.

Generated on Sat Sep 3 10:55:31 2005 for Coin by Doxygen. 1.4.4