Open Inventor Reference
SoNormalElement Class Reference

Element that stores the current surface normals. More...

#include <Inventor/elements/SoNormalElement.h>

Inheritance diagram for SoNormalElement:
SoReplacedElement SoElement SoGLNormalElement

Public Member Functions

virtual void init (SoState *state)
 Initializes element.
 
int32_t getNum () const
 Returns the number of normal vectors in an instance.
 
const SbVec3fget (int index) const
 Returns the indexed normal from an element.
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
- Public Member Functions inherited from SoReplacedElement
virtual void init (SoState *state)
 Initializes node id in element.
 
virtual bool matches (const SoElement *elt) const
 Returns TRUE if the element matches another element, based on node-id.
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
virtual SoElementcopyMatchInfo () const
 Create and return a copy of this element.
 
SbNodeIdType getNodeId () const
 Return nodeId.
 
- Public Member Functions inherited from SoElement
virtual void init (SoState *state)
 Initializes element.
 
virtual void push (SoState *state)
 Pushes/pops element.
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
virtual bool matches (const SoElement *elt) const =0
 Returns TRUE if the element matches another element (of the same class, presumably) with respect to cache validity.
 
virtual SoElementcopyMatchInfo () const =0
 Create a copy that we can put in a cache used list and call matches() on later.
 
SoType getTypeId () const
 Returns type identifier for element instance.
 
int getStackIndex () const
 Returns the stack index for an element instance.
 
void setDepth (int dpth)
 Sets stuff in an element instance.
 
void setNext (SoElement *nxt)
 
void setNextInStack (SoElement *nxt)
 
void setNextFree (SoElement *nxt)
 
int getDepth () const
 Returns stuff from element instance.
 
SoElementgetNext () const
 
virtual ~SoElement ()
 Destructor.
 

Static Public Member Functions

static void set (SoState *state, SoNode *node, int32_t numNormals, const SbVec3f *normals)
 Sets the current normals.
 
static const SoNormalElementgetInstance (SoState *state)
 Returns the top (current) instance of the element in the state.
 
static void initClass ()
 Initializes the SoNormalElement class.
 
- Static Public Member Functions inherited from SoReplacedElement
static void initClass ()
 Initializes the SoReplacedElement class.
 
- Static Public Member Functions inherited from SoElement
static SoType getClassTypeId ()
 Returns type identifier for SoElement class.
 
static void initElements ()
 Initialize ALL Inventor element classes.
 
static void initClass ()
 Initializes the SoElement class.
 
static int getNumStackIndices ()
 Returns the number of stack indices allocated.
 
static SoType getIdFromStackIndex (int stackIndex)
 Returns the id for the element with the given stack index.
 

Protected Member Functions

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

Protected Attributes

int32_t numNormals
 
const SbVec3fnormals
 
- 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.
 
- 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.
 
static const SoElementgetConstElement (SoState *state, int stackIndex)
 Returns a read-only pointer to the top instance in the given element stack.
 
static int createStackIndex (SoType id)
 Creates and returns a new stack index.
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 Stack index for SoElement class.
 

Detailed Description

This class allows read-only access to the top element in the state to make accessing several values in it more efficient. Individual values must be accessed through this instance.

Definition at line 77 of file SoNormalElement.h.

Constructor & Destructor Documentation

◆ ~SoNormalElement()

virtual SoNormalElement::~SoNormalElement ( )
protectedvirtual

Member Function Documentation

◆ get()

const SbVec3f & SoNormalElement::get ( int  index) const
inline

Definition at line 98 of file SoNormalElement.h.

References SoDebugError::post().

◆ getInstance()

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

Definition at line 90 of file SoNormalElement.h.

References SoElement::getConstElement().

◆ getNum()

int32_t SoNormalElement::getNum ( ) const
inline

Definition at line 95 of file SoNormalElement.h.

◆ init()

virtual void SoNormalElement::init ( SoState state)
virtual

Reimplemented from SoReplacedElement.

Reimplemented in SoGLNormalElement.

◆ initClass()

static void SoNormalElement::initClass ( )
static

◆ print()

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

Reimplemented from SoReplacedElement.

◆ set()

static void SoNormalElement::set ( SoState state,
SoNode node,
int32_t  numNormals,
const SbVec3f normals 
)
static

Member Data Documentation

◆ normals

const SbVec3f* SoNormalElement::normals
protected

Definition at line 118 of file SoNormalElement.h.

◆ numNormals

int32_t SoNormalElement::numNormals
protected

Definition at line 117 of file SoNormalElement.h.


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