SoGLColorIndexElement Class Reference

The SoGLColorIndexElement class sets the current OpenGL color. More...

#include <Inventor/elements/SoGLColorIndexElement.h>

Inheritance diagram for SoGLColorIndexElement:

Public Member Functions
int32_t	get (const int index) const
int32_t	getNum (void) const
virtual void	init (SoState *state)
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 int32_t	getDefault (void)
static const SoGLColorIndexElement *	getInstance (SoState *state)
static void	initClass (void)
static SbBool	isColorIndexMode (SoState *state)
static void	set (SoState *const state, SoNode *const node, const int32_t numindices, const int32_t *const indices)
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	~SoGLColorIndexElement ()
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 SoGLColorIndexElement class sets the current OpenGL color.

This element is only used when the OpenGL canvas is in color index mode, i.e. where colors for individual pixels are fetched from a color lookup table ("CLUT"). The usual thing to do is to set up a canvas in RGBA true color mode.

One common use for color index mode OpenGL canvases is to use one in the overlay planes (which are usually limited to only 2 or 4 available colors), if supported by the OpenGL hardware and / or driver.

See also

SoColorIndex

Constructor & Destructor Documentation

~SoGLColorIndexElement()

SoGLColorIndexElement::~SoGLColorIndexElement ( )

protectedvirtual

Destructor.

Member Function Documentation

createInstance()

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

get()

int32_t SoGLColorIndexElement::get

(

const int

index

)

const

Returns the index'th color index in element.

getClassStackIndex()

int SoGLColorIndexElement::getClassStackIndex ( void )

static

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

getClassTypeId()

SoType SoGLColorIndexElement::getClassTypeId ( void )

static

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

getDefault()

int32_t SoGLColorIndexElement::getDefault ( void )

static

Returns the default color index in element.

getInstance()

const SoGLColorIndexElement * SoGLColorIndexElement::getInstance ( SoState * state )

static

Returns the current element.

getNum()

int32_t SoGLColorIndexElement::getNum

(

void

)

const

Returns number of color indices in element.

init()

void SoGLColorIndexElement::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 SoReplacedElement.

initClass()

void SoGLColorIndexElement::initClass ( void )

static

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

isColorIndexMode()

SbBool SoGLColorIndexElement::isColorIndexMode ( SoState * state )

static

Returns TRUE if the current GL context is in color index mode.

set()

void SoGLColorIndexElement::set ( SoState *const state, SoNode *const node, const int32_t numindices, const int32_t *const indices )

static

Sets current color indices.

---

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

• SoGLColorIndexElement.h
• SoGLColorIndexElement.cpp