Open Inventor Reference
SoLightAttenuationElement Class Reference

Element that stores the light attenuation(s) of the current environment. More...

#include <Inventor/elements/SoLightAttenuationElement.h>

Inheritance diagram for SoLightAttenuationElement:
SoReplacedElement SoElement

Public Member Functions

virtual void init (SoState *state)
 Initializes element. More...
 
virtual SoElementcopyMatchInfo () const
 Create and return a copy of this element. More...
 
virtual bool matches (const SoElement *elt) const
 Returns TRUE if the attenuations match in both elements. More...
 
virtual void print (FILE *fp) const
 Prints element (for debugging) More...
 
- Public Member Functions inherited from SoReplacedElement
SbNodeIdType getNodeId () const
 Return nodeId. More...
 
- Public Member Functions inherited from SoElement
virtual void push (SoState *state)
 Pushes/pops element. More...
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 
SoType getTypeId () const
 Returns type identifier for element instance. More...
 
int getStackIndex () const
 Returns the stack index for an element instance. More...
 
void setDepth (int dpth)
 Sets stuff in an element instance. More...
 
void setNext (SoElement *nxt)
 
void setNextInStack (SoElement *nxt)
 
void setNextFree (SoElement *nxt)
 
int getDepth () const
 Returns stuff from element instance. More...
 
SoElementgetNext () const
 
virtual ~SoElement ()
 Destructor. More...
 

Static Public Member Functions

static void set (SoState *state, SoNode *node, const SbVec3f &attenuation)
 Sets the current light attenuation(s) More...
 
static const SbVec3fget (SoState *state)
 Returns the current light attenuation from the state. More...
 
static SbVec3f getDefault ()
 Returns the default light attenuation. More...
 
static void initClass ()
 Initializes the SoLightAttenuationElement class. More...
 
- Static Public Member Functions inherited from SoReplacedElement
static void initClass ()
 Initializes the SoReplacedElement class. More...
 
- Static Public Member Functions inherited from SoElement
static SoType getClassTypeId ()
 Returns type identifier for SoElement class. More...
 
static void initElements ()
 Initialize ALL Inventor element classes. More...
 
static void initClass ()
 Initializes the SoElement class. More...
 
static int getNumStackIndices ()
 Returns the number of stack indices allocated. More...
 
static SoType getIdFromStackIndex (int stackIndex)
 Returns the id for the element with the given stack index. More...
 

Protected Member Functions

virtual ~SoLightAttenuationElement ()
 
- Protected Member Functions inherited from SoReplacedElement
virtual ~SoReplacedElement ()
 Destructor. More...
 
- Protected Member Functions inherited from SoElement
 SoElement ()
 Constructor; use typeId.createInstance to create elements. More...
 
void capture (SoState *state) const
 Does whatever is necessary in state to capture this element for caching purposes. More...
 
virtual void captureThis (SoState *state) const
 Really captures this element, once it has been determined that a cache is open to capture it. More...
 
void setTypeId (SoType id)
 Sets typeId in instance. More...
 
void setStackIndex (int index)
 Sets stackIndex in instance. More...
 
SoElementgetNextInStack () const
 Returns next instance in specific element stack. More...
 
SoElementgetNextFree () const
 Returns next free element in a specific element stack. More...
 

Protected Attributes

SbVec3f attenuation
 
- Protected Attributes inherited from SoReplacedElement
SbNodeIdType nodeId
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoReplacedElement
static SoElementgetElement (SoState *state, int stackIndex, SoNode *node)
 Overrides SoElement::getElement() to set the nodeId in the element instance before returning it. More...
 
- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *state, int stackIndex)
 Returns an instance of an element from the stack with the given index in the given state. More...
 
static const SoElementgetConstElement (SoState *state, int stackIndex)
 Returns a read-only pointer to the top instance in the given element stack. More...
 
static int createStackIndex (SoType id)
 Creates and returns a new stack index. More...
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 Stack index for SoElement class. More...
 

Detailed Description

This used to set up subsequent light sources. The attenuation is stored as an SbVec3f, where the first component of the vector is the quadratic term of the attenuation, the second is the linear term, and the third is the constant.

Definition at line 74 of file SoLightAttenuationElement.h.

Constructor & Destructor Documentation

◆ ~SoLightAttenuationElement()

virtual SoLightAttenuationElement::~SoLightAttenuationElement ( )
protectedvirtual

Member Function Documentation

◆ copyMatchInfo()

virtual SoElement* SoLightAttenuationElement::copyMatchInfo ( ) const
virtual

Reimplemented from SoReplacedElement.

◆ get()

static const SbVec3f& SoLightAttenuationElement::get ( SoState state)
static

◆ getDefault()

static SbVec3f SoLightAttenuationElement::getDefault ( )
inlinestatic

Definition at line 90 of file SoLightAttenuationElement.h.

◆ init()

virtual void SoLightAttenuationElement::init ( SoState state)
virtual

Reimplemented from SoReplacedElement.

◆ initClass()

static void SoLightAttenuationElement::initClass ( )
static

◆ matches()

virtual bool SoLightAttenuationElement::matches ( const SoElement elt) const
virtual

Reimplemented from SoReplacedElement.

◆ print()

virtual void SoLightAttenuationElement::print ( FILE *  fp) const
virtual

Reimplemented from SoReplacedElement.

◆ set()

static void SoLightAttenuationElement::set ( SoState state,
SoNode node,
const SbVec3f attenuation 
)
static

Member Data Documentation

◆ attenuation

SbVec3f SoLightAttenuationElement::attenuation
protected

Definition at line 106 of file SoLightAttenuationElement.h.


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