SoStereoElement Class Reference
[Elements]

Stores the current stereo attributes. More...

#include <Inventor/elements/SoStereoElement.h>

Inheritance diagram for SoStereoElement:

List of all members.

Static Public Member Functions
static SoType	getClassTypeId ()
static int	getClassStackIndex ()
static void	setStereoAbsoluteAdjustments (SoState *state, SbBool absolute)
static bool	isStereoAbsoluteAdjustments (SoState *state)
static void	setStereoAdjustment (SoState *state, float stoffset)
static void	setBalanceAdjustment (SoState *state, float stbalance, SbBool stNearFrac=false)
static void	setInterEyeDistance (SoState *state, float ied)
static void	setReversedView (SoState *state, bool strev)
static float	getStereoAdjustment (SoState *state)
static float	getBalanceAdjustment (SoState *state)
static SbBool	isBalanceAdjustmentNearFrac (SoState *state)
static float	getInterEyeDistance (SoState *state)
static bool	getReversedView (SoState *state)
static void	set (SoState *state, const SoCamera::StereoMode mode)
static SoCamera::StereoMode	getStereoMode (SoState *state)
static SoStereoElement *	getInstance (const SoState *state, SbBool &elemIsSet)
Friends
class	SoGuiRenderArea
class	SoBaseStereo
class	SoStereoCamera

---

Detailed Description

Stores the current stereo attributes.

This element stores the current stereo attributes.

SEE ALSO

---

Member Function Documentation

static float SoStereoElement::getBalanceAdjustment

(

SoState *

state

)

[static]

Returns the stereo balance adjustment.

static int SoStereoElement::getClassStackIndex

(

)

[static]

Returns the stack id for this element.

Reimplemented from SoElement.

static SoType SoStereoElement::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoElement.

static SoStereoElement* SoStereoElement::getInstance	(	const SoState *	state,
		SbBool &	elemIsSet
	)			[static]

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

Note it does NOT cause cache dependency! It also casts away the const.

static float SoStereoElement::getInterEyeDistance

(

SoState *

state

)

[static]

Returns the inter-eye distance (immersive MP only).

static bool SoStereoElement::getReversedView

(

SoState *

state

)

[static]

Returns the inverted view flag.

static float SoStereoElement::getStereoAdjustment

(

SoState *

state

)

[static]

Returns the stereo offset adjustment.

static SoCamera::StereoMode SoStereoElement::getStereoMode

(

SoState *

state

)

[static]

Returns the stereoMode.

static SbBool SoStereoElement::isBalanceAdjustmentNearFrac

(

SoState *

state

)

[static]

Returns TRUE when the stereo balance adjustement is defined as a fraction of the camera near distance.

See setBalanceAdjustment.

static bool SoStereoElement::isStereoAbsoluteAdjustments

(

SoState *

state

)

[static]

Returns TRUE if stereo adjustments are absolute.

See setStereoAbsoluteAdjustments().

static void SoStereoElement::set	(	SoState *	state,
		const SoCamera::StereoMode	mode
	)			[static]

Sets the stereo mode, LEFT_VIEW, RIGHT_VIEW, or MONOSCOPIC.

static void SoStereoElement::setBalanceAdjustment	(	SoState *	state,
		float	stbalance,
		SbBool	stNearFrac = false
	)			[static]

Sets the stereo balance adjustment.

When stNearFrac is set to TRUE, stbalance value is considered to be a fraction of the camera near distance.

static void SoStereoElement::setInterEyeDistance	(	SoState *	state,
		float	ied
	)			[static]

Sets the inter-eye distance (immersive MP only).

static void SoStereoElement::setReversedView	(	SoState *	state,
		bool	strev
	)			[static]

Sets the stereo inverted view flag.

static void SoStereoElement::setStereoAbsoluteAdjustments	(	SoState *	state,
		SbBool	absolute
	)			[static]

Indicates if the stereo offset and and balance setting should be interpreted as factors or as absolute parameters.

If TRUE, the stereo adjustments are absolute.

static void SoStereoElement::setStereoAdjustment	(	SoState *	state,
		float	stoffset
	)			[static]

Sets the stereo offset adjustment.

---

Friends And Related Function Documentation

friend class SoBaseStereo [friend]

friend class SoGuiRenderArea [friend]

friend class SoStereoCamera [friend]

---

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

• Inventor/elements/SoStereoElement.h