SoLogicalViewportElement Class Reference

Stores the logical viewport region. More...

#include <Inventor/elements/SoLogicalViewportElement.h>

Inheritance diagram for SoLogicalViewportElement:

Public Member Functions
virtual void	print (FILE *fp) const
	Prints element (for debugging).
Public Member Functions inherited from SoElement
virtual void	push (SoState *state)
	Pushes element.
virtual void	pop (SoState *state, const SoElement *prevTopElement)
	Pops element.
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.

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	set (SoState *state, const SbViewportRegion &vp)
	Sets the viewport region.
static const SbViewportRegion &	get (SoState *state)
	Returns the current viewport region from the state.
static SbViewportRegion	getDefaultViewport ()
	Returns the default viewport region.
static SoLogicalViewportElement *	getInstance (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.

Detailed Description

Stores the logical viewport region.

This element stores the logical viewport region, which indicates to the camera(s) the whole size of the window which is being rendered into. This information is needed when the viewport region has been split, so that the camera doesn't adjust its parameters on only a part of the whole window.

LogicalViewportElement is used for "tiled" rendering – in this case it contains the size (and aspect ratio) of the complete large image, while ViewportRegionElement contains the size of the tile (subimage) we are currently rendering. SoCamera::computeView uses the logical viewport's aspect ratio for ADJUST_CAMERA mode, so we render all the tiles with the same adjustment (but only if the LogicalViewportElement was actually set during traversal – see SoOffscreenRenderArea).

SEE ALSO

PoBaseView, SoOffscreenRenderArea, SoGLRenderAction

Definition at line 54 of file SoLogicalViewportElement.h.

Member Function Documentation

get()

static const SbViewportRegion & SoLogicalViewportElement::get ( SoState *  state )

static

Returns the current viewport region from the state.

getClassStackIndex()

static int SoLogicalViewportElement::getClassStackIndex ( )

static

Returns the stack id for this element.

getClassTypeId()

static SoType SoLogicalViewportElement::getClassTypeId ( )

static

Returns the type identifier for this class.

getDefaultViewport()

static SbViewportRegion SoLogicalViewportElement::getDefaultViewport ( )

inlinestatic

Returns the default viewport region.

Definition at line 72 of file SoLogicalViewportElement.h.

getInstance()

static SoLogicalViewportElement * SoLogicalViewportElement::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.

print()

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

virtual

Prints element (for debugging).

Reimplemented from SoElement.

set()

static void SoLogicalViewportElement::set ( SoState *  state, const SbViewportRegion &  vp  )

static

Sets the viewport region.

---

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

• Inventor/elements/SoLogicalViewportElement.h