SoLogicalViewportElement Class Reference

VSG extension Stores the logical viewport region. More...

#include <Inventor/elements/SoLogicalViewportElement.h>

Inheritance diagram for SoLogicalViewportElement:
SoElement SoTypedObject

List of all members.

Public Member Functions

virtual void print (FILE *fp) const

Static Public Member Functions

static SoType getClassTypeId ()
static int getClassStackIndex ()
static void set (SoState *state, const SbViewportRegion &vp)
static const SbViewportRegionget (SoState *state)
static SbViewportRegion getDefaultViewport ()
static SoLogicalViewportElementgetInstance (const SoState *state, SbBool &elemIsSet)

Detailed Description

VSG extension 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 SoOffscreenRenderer).


PoBaseView, SoOffscreenRenderer, SoGLRenderAction

Member Function Documentation

static const SbViewportRegion& SoLogicalViewportElement::get ( SoState state  )  [static]

Returns the current viewport region from the state.

static int SoLogicalViewportElement::getClassStackIndex (  )  [static]

Returns the stack id for this element.

Reimplemented from SoElement.

static SoType SoLogicalViewportElement::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoElement.

static SbViewportRegion SoLogicalViewportElement::getDefaultViewport (  )  [inline, static]

Returns the default viewport region.

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.

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

Prints element (for debugging).

Reimplemented from SoElement.

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:

Open Inventor Toolkit reference manual, generated on 24 Mar 2020
Copyright © Thermo Fisher Scientific All rights reserved.