#include <SoViewportRegion.h>

Public Types
enum	PositionMode { POSITION_MODE_MIN_AND_MAX, POSITION_MODE_CENTER_AND_SIZE, POSITION_MODE_MIN_AND_SIZE, POSITION_MODE_MAX_AND_SIZE }
enum	ReferenceMode { REFERENCE_MODE_MIN, REFERENCE_MODE_CENTER, REFERENCE_MODE_MAX }
enum	DomainMode { DOMAIN_MODE_ABSOLUTE, DOMAIN_MODE_RELATIVE_TO_HEIGHT, DOMAIN_MODE_RELATIVE_TO_WIDTH, DOMAIN_MODE_RELATIVE_TO_MIN, DOMAIN_MODE_RELATIVE_TO_MAX }
enum	ProjectionType { ORTHOGRAPHIC, PERSPECTIVE, AUTO, UNMODIFIED }
Public Member Functions
	SoViewportRegion ()
	Constructor.
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
	Get bounding box.
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
	Reimplemented GLRenderBelowPath to render child graph with modified viewportSize.
virtual void	handleEvent (SoHandleEventAction *action)
	Handle event is reimplemented to forward events with modified viewportSize.
Static Public Member Functions
static void	initClass ()
	Initializes this class (called on dll initialization).
Public Attributes

SoSFBool	on
	Enable/Disable rendering of children.
SoSFBool	modifyVP
	Enable/Disable viewport region modification.
SoSFBool	usePreviousVP
	Enable/Disable relative viewport region modification.
SoSFEnum	xPositionMode
	Define how specify the viewport region in the x-dimension.
SoSFFloat	x1
	First value for viewport region definition in the x-dimension (right border, left border or center)
SoSFEnum	x1ReferenceMode
	Reference for x1.
SoSFEnum	x1DomainMode
	Domain of x1.
SoSFFloat	x2
	Second value for viewport region definition in the x-dimension (width or right border)
SoSFEnum	x2ReferenceMode
	Reference for x2.
SoSFEnum	x2DomainMode
	Domain of x1.
SoSFEnum	yPositionMode
	Define how specify the viewport region in the y-dimension.
SoSFFloat	y1
	First value for viewport region definition in the y-dimension (lower border, upper border or center)
SoSFEnum	y1ReferenceMode
	Reference for y1.
SoSFEnum	y1DomainMode
	Domain of y1.
SoSFFloat	y2
	Second value for viewport region definition in the y-dimension (height or upper border)
SoSFEnum	y2ReferenceMode
	Reference for y2.
SoSFEnum	y2DomainMode
	Domain of y2.
SoSFEnum	projectionType
	Used ProjectionType.
SoSFBool	renderDelayedPaths
	Enable/Disable delayed path rendering.
SoSFBool	detectMouseOver
	Enable/Disable mouse over detection.
SoSFBool	mouseOverViewport
	Indicates if the mouse is over the viewport region.
SoSFBool	forwardEvents
	Enable/Disable forwarding of events to children.
SoSFBool	forwardEventsInViewportOnly
	If true, only events that occured in the viewport region will be forwarded.
SoSFBool	mapEventToViewport
	Enable/Disable mapping of event coordinates to the viewport region.
SoSFBool	consumeEventsInViewport
	Enable/Disable consumption of handled events.
Protected Member Functions
virtual	~SoViewportRegion ()
	Destructor.
SbViewportRegion	getViewportRegion (SoState *state)
	Computes the ViewportRegion.
int	getInterpretedPosition (float value, int width, int height, bool isY, ReferenceMode refMode, DomainMode domMode)
	Interprets value as position in relation to given size based on the ReferenceMode and the DomainMode.
int	getInterpretedSize (float value, int width, int height, DomainMode domMode)
	Interprets value as size in relation to given size based on the DomainMode.
Protected Attributes
ProjectionType	_prevProjType
SbViewVolume::ProjectionType	_projType
SoCamera *	_insetCam

Detailed Description

Definition at line 45 of file SoViewportRegion.h.

Member Enumeration Documentation

enum SoViewportRegion::DomainMode

Enumerator:

DOMAIN_MODE_ABSOLUTE
DOMAIN_MODE_RELATIVE_TO_HEIGHT
DOMAIN_MODE_RELATIVE_TO_WIDTH
DOMAIN_MODE_RELATIVE_TO_MIN
DOMAIN_MODE_RELATIVE_TO_MAX

Definition at line 75 of file SoViewportRegion.h.

enum SoViewportRegion::PositionMode

Enumerator:

POSITION_MODE_MIN_AND_MAX
POSITION_MODE_CENTER_AND_SIZE
POSITION_MODE_MIN_AND_SIZE
POSITION_MODE_MAX_AND_SIZE

Definition at line 60 of file SoViewportRegion.h.

enum SoViewportRegion::ProjectionType

Enumerator:

ORTHOGRAPHIC
PERSPECTIVE
AUTO	same type as previous camera in state
UNMODIFIED	use cam as specified in child graph

Definition at line 84 of file SoViewportRegion.h.

enum SoViewportRegion::ReferenceMode

Enumerator:

REFERENCE_MODE_MIN
REFERENCE_MODE_CENTER
REFERENCE_MODE_MAX

Definition at line 68 of file SoViewportRegion.h.

Constructor & Destructor Documentation

SoViewportRegion::SoViewportRegion ( )

Constructor.

virtual SoViewportRegion::~SoViewportRegion ( ) [protected, virtual]

Destructor.

Member Function Documentation

virtual void SoViewportRegion::getBoundingBox ( SoGetBoundingBoxAction * action ) [virtual]

Get bounding box.

int SoViewportRegion::getInterpretedPosition	(	float	value,
		int	width,
		int	height,
		bool	isY,
		ReferenceMode	refMode,
		DomainMode	domMode
	)		`[protected]`

Interprets value as position in relation to given size based on the ReferenceMode and the DomainMode.

int SoViewportRegion::getInterpretedSize	(	float	value,
		int	width,
		int	height,
		DomainMode	domMode
	)		`[protected]`

Interprets value as size in relation to given size based on the DomainMode.

SbViewportRegion SoViewportRegion::getViewportRegion ( SoState * state ) [protected]

Computes the ViewportRegion.

virtual void SoViewportRegion::GLRenderBelowPath ( SoGLRenderAction * action ) [virtual]

Reimplemented GLRenderBelowPath to render child graph with modified viewportSize.

virtual void SoViewportRegion::handleEvent ( SoHandleEventAction * action ) [virtual]

Handle event is reimplemented to forward events with modified viewportSize.

static void SoViewportRegion::initClass ( ) [static]

Initializes this class (called on dll initialization).

Member Data Documentation

SoCamera* SoViewportRegion::_insetCam [protected]

Definition at line 187 of file SoViewportRegion.h.

ProjectionType SoViewportRegion::_prevProjType [protected]

Definition at line 184 of file SoViewportRegion.h.

SbViewVolume::ProjectionType SoViewportRegion::_projType [protected]

Definition at line 185 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::consumeEventsInViewport

Enable/Disable consumption of handled events.

Definition at line 166 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::detectMouseOver

Enable/Disable mouse over detection.

Definition at line 151 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::forwardEvents

Enable/Disable forwarding of events to children.

Definition at line 157 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::forwardEventsInViewportOnly

If true, only events that occured in the viewport region will be forwarded.

Definition at line 160 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::mapEventToViewport

Enable/Disable mapping of event coordinates to the viewport region.

Definition at line 163 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::modifyVP

Enable/Disable viewport region modification.

Definition at line 97 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::mouseOverViewport

Indicates if the mouse is over the viewport region.

Definition at line 154 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::on

Enable/Disable rendering of children.

Definition at line 94 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::projectionType

Used ProjectionType.

Definition at line 145 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::renderDelayedPaths

Enable/Disable delayed path rendering.

Definition at line 148 of file SoViewportRegion.h.

SoSFBool SoViewportRegion::usePreviousVP

Enable/Disable relative viewport region modification.

Definition at line 100 of file SoViewportRegion.h.

SoSFFloat SoViewportRegion::x1

First value for viewport region definition in the x-dimension (right border, left border or center)

Definition at line 106 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::x1DomainMode

Domain of x1.

Definition at line 112 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::x1ReferenceMode

Reference for x1.

Definition at line 109 of file SoViewportRegion.h.

SoSFFloat SoViewportRegion::x2

Second value for viewport region definition in the x-dimension (width or right border)

Definition at line 115 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::x2DomainMode

Domain of x1.

Definition at line 121 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::x2ReferenceMode

Reference for x2.

Definition at line 118 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::xPositionMode

Define how specify the viewport region in the x-dimension.

Definition at line 103 of file SoViewportRegion.h.

SoSFFloat SoViewportRegion::y1

First value for viewport region definition in the y-dimension (lower border, upper border or center)

Definition at line 127 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::y1DomainMode

Domain of y1.

Definition at line 133 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::y1ReferenceMode

Reference for y1.

Definition at line 130 of file SoViewportRegion.h.

SoSFFloat SoViewportRegion::y2

Second value for viewport region definition in the y-dimension (height or upper border)

Definition at line 136 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::y2DomainMode

Domain of y2.

Definition at line 142 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::y2ReferenceMode

Reference for y2.

Definition at line 139 of file SoViewportRegion.h.

SoSFEnum SoViewportRegion::yPositionMode

Define how specify the viewport region in the y-dimension.

Definition at line 124 of file SoViewportRegion.h.

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

MeVisLab/Standard/Sources/Inventor/SoUtils/SoViewportRegion.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation