Open Inventor Reference
SoFocalDistanceElement Class Reference

Element that stores the current focal distance of the camera. More...

#include <Inventor/elements/SoFocalDistanceElement.h>

Inheritance diagram for SoFocalDistanceElement:
SoFloatElement SoElement

Public Member Functions

virtual void init (SoState *state)
 Initializes element. More...
 
- Public Member Functions inherited from SoFloatElement
virtual bool matches (const SoElement *elt) const
 Comparison based on value of floats. More...
 
virtual SoElementcopyMatchInfo () const
 Copy method, takes care copying the data. More...
 
virtual void print (FILE *fp) const
 Prints element (for debugging) 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, float distance)
 Sets the current focal distance in the state. More...
 
static void set (SoState *state, SoNode *, float distance)
 
static float get (SoState *state)
 Returns current focal distance from the state. More...
 
static float getDefault ()
 Returns the default focal distance. More...
 
static void initClass ()
 Initializes the SoFocalDistanceElement class. More...
 
- Static Public Member Functions inherited from SoFloatElement
static void initClass ()
 Initializes the SoFloatElement 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 ~SoFocalDistanceElement ()
 
- Protected Member Functions inherited from SoFloatElement
virtual void setElt (float value)
 Virtual set that subclasses can override to implement side-effect behaviors. More...
 
virtual ~SoFloatElement ()
 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...
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoFloatElement
static void set (int stackIndex, SoState *state, float value)
 Set value. More...
 
static float get (int stackIndex, SoState *state)
 Get value. 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...
 
- Protected Attributes inherited from SoFloatElement
float data
 Storage for data. More...
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 Stack index for SoElement class. More...
 

Detailed Description

This can be used to determine the center of attention of the camera.

Definition at line 70 of file SoFocalDistanceElement.h.

Constructor & Destructor Documentation

◆ ~SoFocalDistanceElement()

virtual SoFocalDistanceElement::~SoFocalDistanceElement ( )
protectedvirtual

Member Function Documentation

◆ get()

static float SoFocalDistanceElement::get ( SoState state)
inlinestatic

Definition at line 88 of file SoFocalDistanceElement.h.

References SoFloatElement::get().

◆ getDefault()

static float SoFocalDistanceElement::getDefault ( )
inlinestatic

Definition at line 92 of file SoFocalDistanceElement.h.

◆ init()

virtual void SoFocalDistanceElement::init ( SoState state)
virtual

Reimplemented from SoElement.

◆ initClass()

static void SoFocalDistanceElement::initClass ( )
static

◆ set() [1/2]

static void SoFocalDistanceElement::set ( SoState state,
float  distance 
)
inlinestatic

Definition at line 79 of file SoFocalDistanceElement.h.

References SoFloatElement::set().

◆ set() [2/2]

static void SoFocalDistanceElement::set ( SoState state,
SoNode ,
float  distance 
)
inlinestatic

Definition at line 83 of file SoFocalDistanceElement.h.

References SoFloatElement::set().


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