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

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

The SoInt32Element class is the base class for elements that simply store a 32-bit integer.

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 32-bit integer value. More...

#include <Inventor/elements/SoInt32Element.h>

Inheritance diagram for SoInt32Element:

SoElement

List of all members.

Public Member Functions

virtual void init (SoState *state)
 FIXME: write doc.
virtual SbBool matches (const SoElement *element) const
virtual SoElementcopyMatchInfo (void) const
virtual void print (FILE *file) const
virtual void setElt (int32_t value)
 FIXME: write doc.

Static Public Member Functions

static SoType getClassTypeId (void)
static int getClassStackIndex (void)
static void initClass (void)
static void set (const int index, SoState *const state, SoNode *const node, const int32_t value)
static void set (const int index, SoState *const state, const int32_t value)
static int32_t get (const int index, SoState *const state)
 FIXME: write doc.

Protected Attributes

int32_t data


Detailed Description

The SoInt32Element class is the base class for elements that simply store a 32-bit integer.

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 32-bit integer 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 32-bit integer value.

See also:
SoReplacedElement, SoFloatElement, SoAccumulatedElement

Member Function Documentation

SoType SoInt32Element::getClassTypeId ( void   )  [static]

This static method returns the class type.

Reimplemented from SoElement.

int SoInt32Element::getClassStackIndex ( void   )  [static]

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

Reimplemented from SoElement.

void SoInt32Element::initClass ( void   )  [static]

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

Reimplemented from SoElement.

SbBool SoInt32Element::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.

References data, and SoElement::getTypeId().

SoElement * SoInt32Element::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.

References SoType::createInstance(), data, and SoElement::getTypeId().

void SoInt32Element::print ( FILE *  file  )  const [virtual]

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

Reimplemented from SoElement.

References data, SoType::getName(), SbName::getString(), and SoElement::getTypeId().

void SoInt32Element::set ( const int  index,
SoState *const   state,
const int32_t  value 
) [static]

FIXME: write doc.


Member Data Documentation

SoInt32Element::data [protected]

The 32-bit integer value of the element.

Referenced by copyMatchInfo(), get(), init(), matches(), print(), and setElt().


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

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

Generated on Mon Feb 23 16:33:51 2009 for Coin by Doxygen. 1.5.8