Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
SoAmbientColorElement Class Reference

Stores ambient color of current material (superseded by SoMaterialElement). More...

#include <Inventor/elements/SoAmbientColorElement.h>

Public Member Functions

int32_t getNum () const
 Returns the number of ambient colors in any instance.
 
const SbColorget (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 SoAmbientColorElementgetInstance (SoState *state)
 Returns the top (current) instance of the element in the state.
 
static SbColor getDefault ()
 Returns the default ambient color.
 

Detailed Description

Stores ambient color of current material (superseded by SoMaterialElement).

This class is superseded by the SoMaterialElement class. All methods are converted inline to SoMaterialElement methods for compatibility. This only uses the first ambient color, not an array of them.

SEE ALSO

Definition at line 72 of file SoAmbientColorElement.h.

Member Function Documentation

◆ get()

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

Returns the current ambient color.

Definition at line 138 of file SoAmbientColorElement.h.

◆ getDefault()

static SbColor SoAmbientColorElement::getDefault ( )
inlinestatic

Returns the default ambient color.

Definition at line 101 of file SoAmbientColorElement.h.

◆ getInstance()

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

Returns the top (current) instance of the element in the state.

Definition at line 127 of file SoAmbientColorElement.h.

◆ getNum()

int32_t SoAmbientColorElement::getNum ( ) const
inline

Returns the number of ambient colors in any instance.

Definition at line 90 of file SoAmbientColorElement.h.

◆ set()

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

Sets the current ambient color(s).

Definition at line 113 of file SoAmbientColorElement.h.


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