SoFocalDistanceElement Class Reference

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

#include <Inventor/elements/SoFocalDistanceElement.h>

Inheritance diagram for SoFocalDistanceElement:

Public Member Functions
virtual void	init (SoState *state)
	Initializes element.
Public Member Functions inherited from SoFloatElement
virtual bool	matches (const SoElement *elt) const
	Comparison based on value of floats.
virtual SoElement *	copyMatchInfo () const
	Copy method, takes care copying the data.
virtual void	print (FILE *fp) const
	Prints element (for debugging)
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 SoElement *	copyMatchInfo () 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.
SoElement *	getNext () const
virtual	~SoElement ()
	Destructor.

Static Public Member Functions
static void	set (SoState *state, float distance)
	Sets the current focal distance in the state.
static void	set (SoState *state, SoNode *, float distance)
static float	get (SoState *state)
	Returns current focal distance from the state.
static float	getDefault ()
	Returns the default focal distance.
static void	initClass ()
	Initializes the SoFocalDistanceElement class.
Static Public Member Functions inherited from SoFloatElement
static void	initClass ()
	Initializes the SoFloatElement 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	~SoFocalDistanceElement ()
Protected Member Functions inherited from SoFloatElement
virtual void	setElt (float value)
	Virtual set that subclasses can override to implement side-effect behaviors.
virtual	~SoFloatElement ()
	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.
SoElement *	getNextInStack () const
	Returns next instance in specific element stack.
SoElement *	getNextFree () const
	Returns next free element in a specific element stack.

Additional Inherited Members
Static Protected Member Functions inherited from SoFloatElement
static void	set (int stackIndex, SoState *state, float value)
	Set value.
static float	get (int stackIndex, SoState *state)
	Get value.
Static Protected Member Functions inherited from SoElement
static SoElement *	getElement (SoState *state, int stackIndex)
	Returns an instance of an element from the stack with the given index in the given state.
static const SoElement *	getConstElement (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.
Protected Attributes inherited from SoFloatElement
float	data
	Storage for data.
Static Protected Attributes inherited from SoElement
static int	classStackIndex
	Stack index for SoElement class.

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:

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/elements/SoFocalDistanceElement.h