Open Inventor Reference
Public Member Functions | Static Public Member Functions | List of all members
SoAmbientColorElement Class Reference
Elements

This class is being superceded by the SoLazyElement class. More...

#include <Inventor/elements/SoAmbientColorElement.h>

Public Member Functions

int32_t getNum () const
 Returns the number of ambient colors in any instance.
 
const SbColor & get (int index) const
 Returns the current ambient color.
 

Static Public Member Functions

static void set (SoState *state, SoNode *, int32_t numColors, const SbColor *colors)
 Sets the current ambient color(s)
 
static const SoAmbientColorElement * getInstance (SoState *state)
 Returns the top (current) instance of the element in the state.
 
static SbColor getDefault ()
 Returns the default ambient color.
 

Detailed Description

All methods are converted inline to SoLazyElement methods for compatibility. This only uses the first ambient color, not an array of them.

Definition at line 78 of file SoAmbientColorElement.h.

Member Function Documentation

◆ get()

const SbColor & SoAmbientColorElement::get ( int  index) const
inline

Definition at line 110 of file SoAmbientColorElement.h.

References SoLazyElement::getAmbient(), and SoDebugError::post().

◆ getDefault()

static SbColor SoAmbientColorElement::getDefault ( )
inlinestatic

Definition at line 121 of file SoAmbientColorElement.h.

References SoLazyElement::getDefaultAmbient().

◆ getInstance()

static const SoAmbientColorElement * SoAmbientColorElement::getInstance ( SoState *  state)
inlinestatic

Definition at line 98 of file SoAmbientColorElement.h.

◆ getNum()

int32_t SoAmbientColorElement::getNum ( ) const
inline

Definition at line 107 of file SoAmbientColorElement.h.

◆ set()

static void SoAmbientColorElement::set ( SoState *  state,
SoNode *  ,
int32_t  numColors,
const SbColor *  colors 
)
inlinestatic

Definition at line 84 of file SoAmbientColorElement.h.

References SoDebugError::post(), and SoLazyElement::setAmbient().

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