SoAmbientColorElement Class Reference

The SoAmbientColorElement class is yet to be documented. More...

#include <Inventor/elements/SoAmbientColorElement.h>

Inheritance diagram for SoAmbientColorElement:

Public Member Functions
const SbColor &	get (const int index) const
	FIXME: write doc.
const SbColor *	getArrayPtr (void) const
int32_t	getNum (void) const
	FIXME: write doc.
virtual void	init (SoState *state)
	FIXME: write doc.
Public Member Functions inherited from SoReplacedElement
virtual SoElement *	copyMatchInfo () const
SbUniqueId	getNodeId () 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
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	push (SoState *state)
void	setDepth (const int depth)

Static Public Member Functions
static void *	createInstance (void)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static const SoAmbientColorElement *	getInstance (SoState *state)
	FIXME: write doc.
static void	initClass (void)
static void	set (SoState *const state, SoNode *const node, const int32_t numcolors, const SbColor *const colors)
	FIXME: write doc.
Static Public Member Functions inherited from SoReplacedElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
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	~SoAmbientColorElement ()
Protected Member Functions inherited from SoReplacedElement
virtual	~SoReplacedElement ()
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 SoReplacedElement
static SoElement *	getElement (SoState *const state, const int stackIndex, SoNode *const node)
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 SoReplacedElement
SbUniqueId	nodeId
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 SoAmbientColorElement class is yet to be documented.

Constructor & Destructor Documentation

~SoAmbientColorElement()

SoAmbientColorElement::~SoAmbientColorElement ( )

protectedvirtual

Destructor.

Member Function Documentation

createInstance()

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

getArrayPtr()

const SbColor * SoAmbientColorElement::getArrayPtr

(

void

)

const

Return a pointer to the color array. This method is not part of the OIV API.

getClassStackIndex()

int SoAmbientColorElement::getClassStackIndex ( void )

static

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

getClassTypeId()

SoType SoAmbientColorElement::getClassTypeId ( void )

static

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

init()

void SoAmbientColorElement::init ( SoState * state )

virtual

FIXME: write doc.

Reimplemented from SoReplacedElement.

initClass()

void SoAmbientColorElement::initClass ( void )

static

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

---

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

• SoAmbientColorElement.h
• SoAmbientColorElement.cpp