Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoStereoElement Class Reference

VSG extension Stores the current stereo attributes. More...

#include <Inventor/elements/SoStereoElement.h>

+ Inheritance diagram for SoStereoElement:

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static int getClassStackIndex ()
 Returns the stack id for this element.
 
static void setStereoAbsoluteAdjustments (SoState *state, SbBool absolute)
 Indicates if the stereo offset and and balance setting should be interpreted as factors or as absolute parameters.
 
static bool isStereoAbsoluteAdjustments (SoState *state)
 Returns TRUE if stereo adjustments are absolute.
 
static void setStereoAdjustment (SoState *state, float stoffset)
 Sets the stereo offset adjustment.
 
static void setBalanceAdjustment (SoState *state, float stbalance, SbBool stNearFrac=false)
 Sets the stereo balance adjustment.
 
static void setInterEyeDistance (SoState *state, float ied)
 Sets the inter-eye distance (immersive MP only).
 
static void setReversedView (SoState *state, bool strev)
 Sets the stereo inverted view flag.
 
static float getStereoAdjustment (SoState *state)
 Returns the stereo offset adjustment.
 
static float getBalanceAdjustment (SoState *state)
 Returns the stereo balance adjustment.
 
static SbBool isBalanceAdjustmentNearFrac (SoState *state)
 Returns TRUE when the stereo balance adjustement is defined as a fraction of the camera near distance.
 
static float getInterEyeDistance (SoState *state)
 Returns the inter-eye distance (immersive MP only).
 
static bool getReversedView (SoState *state)
 Returns the inverted view flag.
 
static void set (SoState *state, const SoCamera::StereoMode mode)
 Sets the stereo mode, LEFT_VIEW, RIGHT_VIEW, or MONOSCOPIC.
 
static SoCamera::StereoMode getStereoMode (SoState *state)
 Returns the stereoMode.
 
static SoStereoElementgetInstance (const SoState *state, SbBool &elemIsSet)
 Return the top (current) instance of the element in the state.
 
- Static Public Member Functions inherited from SoElement
static SoType getClassTypeId ()
 Returns type identifier for SoElement class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Friends

class SoGuiRenderArea
 
class SoBaseStereo
 
class SoStereoCamera
 

Additional Inherited Members

- Public Member Functions inherited from SoElement
virtual void push (SoState *state)
 Pushes element.
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 Pops element.
 
virtual void print (FILE *fp) const
 Prints element (for debugging).
 
virtual SoType getTypeId () const
 Returns type identifier for element instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Detailed Description

VSG extension Stores the current stereo attributes.

This element stores the current stereo attributes.

SEE ALSO

Definition at line 41 of file SoStereoElement.h.

Member Function Documentation

◆ getBalanceAdjustment()

static float SoStereoElement::getBalanceAdjustment ( SoState state)
static

Returns the stereo balance adjustment.

◆ getClassStackIndex()

static int SoStereoElement::getClassStackIndex ( )
static

Returns the stack id for this element.


◆ getClassTypeId()

static SoType SoStereoElement::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getInstance()

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.

◆ getInterEyeDistance()

static float SoStereoElement::getInterEyeDistance ( SoState state)
static

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

◆ getReversedView()

static bool SoStereoElement::getReversedView ( SoState state)
static

Returns the inverted view flag.

◆ getStereoAdjustment()

static float SoStereoElement::getStereoAdjustment ( SoState state)
static

Returns the stereo offset adjustment.

◆ getStereoMode()

static SoCamera::StereoMode SoStereoElement::getStereoMode ( SoState state)
static

Returns the stereoMode.

◆ isBalanceAdjustmentNearFrac()

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.

◆ isStereoAbsoluteAdjustments()

static bool SoStereoElement::isStereoAbsoluteAdjustments ( SoState state)
static

Returns TRUE if stereo adjustments are absolute.

See setStereoAbsoluteAdjustments().

◆ set()

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

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

◆ setBalanceAdjustment()

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.

◆ setInterEyeDistance()

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

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

◆ setReversedView()

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

Sets the stereo inverted view flag.

◆ setStereoAbsoluteAdjustments()

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.

◆ setStereoAdjustment()

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

Sets the stereo offset adjustment.

Friends And Related Symbol Documentation

◆ SoBaseStereo

friend class SoBaseStereo
friend

Definition at line 158 of file SoStereoElement.h.

◆ SoGuiRenderArea

friend class SoGuiRenderArea
friend

Definition at line 157 of file SoStereoElement.h.

◆ SoStereoCamera

friend class SoStereoCamera
friend

Definition at line 159 of file SoStereoElement.h.


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