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

Public Member Functions | Static Public Member Functions | Protected Member Functions
SoGLColorIndexElement Class Reference

The SoGLColorIndexElement class sets the current OpenGL color.This element is only used when the OpenGL canvas is in colorindex mode, ie 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 truecolor mode. More...

#include <Inventor/elements/SoGLColorIndexElement.h>

Inheritance diagram for SoGLColorIndexElement:
SoReplacedElement SoElement

List of all members.

Public Member Functions

virtual void init (SoState *state)
int32_t getNum (void) const
int32_t get (const int index) const
- Public Member Functions inherited from SoReplacedElement
virtual SbBool matches (const SoElement *element) const
virtual SoElementcopyMatchInfo () const
uint32_t getNodeId () const
virtual void print (FILE *file) const
- 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 * createInstance (void)
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 const
SoGLColorIndexElement
getInstance (SoState *state)
static int32_t getDefault (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
void setTypeId (const SoType typeId)
void setStackIndex (const int index)
SoElementgetNextInStack (void) const
SoElementgetNextFree (void) const

Additional Inherited Members

- Static Protected Member Functions inherited from SoReplacedElement
static SoElementgetElement (SoState *const state, const int stackIndex, SoNode *const node)
- 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)
- Protected Attributes inherited from SoReplacedElement
uint32_t nodeId
- Protected Attributes inherited from SoElement
SoType typeId
int stackIndex
int depth

Detailed Description

The SoGLColorIndexElement class sets the current OpenGL color.

This element is only used when the OpenGL canvas is in colorindex mode, ie 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 truecolor mode.

One common use for colorindex 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 ( )
protectedvirtual

The destructor.


Member Function Documentation

SoType SoGLColorIndexElement::getClassTypeId ( void  )
static

This static method returns the class type.

Reimplemented from SoReplacedElement.

int SoGLColorIndexElement::getClassStackIndex ( void  )
static

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

Reimplemented from SoReplacedElement.

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.

void SoGLColorIndexElement::initClass ( void  )
static

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

Reimplemented from SoReplacedElement.

SbBool SoGLColorIndexElement::isColorIndexMode ( SoState state)
static

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

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.

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

Sets current color indices.

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

Returns the current element.

Referenced by getNum().

int32_t SoGLColorIndexElement::getNum ( void  ) const

Returns number of color indices in element.

References getInstance().


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

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

Generated on Thu Jul 19 2012 for Coin by Doxygen. 1.8.1.1