#include <Viewport.h>

Inheritance diagram for osg::Viewport:

Collaboration diagram for osg::Viewport:

Public Types
typedef double	value_type

Public Types inherited from osg::StateAttribute
enum	Values { OFF = 0x0, ON = 0x1, OVERRIDE = 0x2, PROTECTED = 0x4, INHERIT = 0x8 }

enum	Type { TEXTURE, POLYGONMODE, POLYGONOFFSET, MATERIAL, ALPHAFUNC, ANTIALIAS, COLORTABLE, CULLFACE, FOG, FRONTFACE, LIGHT, POINT, LINEWIDTH, LINESTIPPLE, POLYGONSTIPPLE, SHADEMODEL, TEXENV, TEXENVFILTER, TEXGEN, TEXMAT, LIGHTMODEL, BLENDFUNC, BLENDEQUATION, LOGICOP, STENCIL, COLORMASK, DEPTH, VIEWPORT, SCISSOR, BLENDCOLOR, MULTISAMPLE, CLIPPLANE, COLORMATRIX, VERTEXPROGRAM, FRAGMENTPROGRAM, POINTSPRITE, PROGRAM, CLAMPCOLOR, HINT, SAMPLEMASKI, PRIMITIVERESTARTINDEX, CLIPCONTROL, VALIDATOR, VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM, OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER, UNIFORMBUFFERBINDING, TRANSFORMFEEDBACKBUFFERBINDING, ATOMICCOUNTERBUFFERBINDING, PATCH_PARAMETER, FRAME_BUFFER_OBJECT, VERTEX_ATTRIB_DIVISOR, SHADERSTORAGEBUFFERBINDING, CAPABILITY = 100 }

typedef GLenum	GLMode

typedef unsigned int	GLModeValue

typedef unsigned int	OverrideValue

typedef std::pair< Type, unsigned int >	TypeMemberPair

typedef std::vector< StateSet * >	ParentList

typedef osg::StateAttributeCallback	Callback

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
	Viewport ()

	Viewport (value_type x, value_type y, value_type width, value_type height)

	Viewport (const Viewport &vp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

	META_StateAttribute (osg, Viewport, VIEWPORT)

virtual int	compare (const StateAttribute &sa) const

Viewport &	operator= (const Viewport &rhs)

void	setViewport (value_type x, value_type y, value_type width, value_type height)

value_type &	x ()

value_type	x () const

value_type &	y ()

value_type	y () const

value_type &	width ()

value_type	width () const

value_type &	height ()

value_type	height () const

bool	valid () const

double	aspectRatio () const

const osg::Matrix	computeWindowMatrix () const

virtual void	apply (State &state) const

Public Member Functions inherited from osg::StateAttribute
	StateAttribute ()

	StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

virtual Object *	cloneType () const =0

virtual Object *	clone (const CopyOp &) const =0

virtual bool	isSameKindAs (const Object *obj) const

virtual const char *	libraryName () const

virtual const char *	className () const

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Texture *	asTexture ()

virtual const Texture *	asTexture () const

virtual Type	getType () const =0

virtual unsigned int	getMember () const

TypeMemberPair	getTypeMemberPair () const

virtual bool	isTextureAttribute () const

bool	operator< (const StateAttribute &rhs) const

bool	operator== (const StateAttribute &rhs) const

bool	operator!= (const StateAttribute &rhs) const

const ParentList &	getParents () const

StateSet *	getParent (unsigned int i)

const StateSet *	getParent (unsigned int i) const

unsigned int	getNumParents () const

void	setShaderComponent (ShaderComponent *sc)

ShaderComponent *	getShaderComponent ()

const ShaderComponent *	getShaderComponent () const

virtual bool	getModeUsage (ModeUsage &) const

virtual bool	checkValidityOfAssociatedModes (osg::State &) const

void	setUpdateCallback (StateAttributeCallback *uc)

StateAttributeCallback *	getUpdateCallback ()

const StateAttributeCallback *	getUpdateCallback () const

void	setEventCallback (StateAttributeCallback *ec)

StateAttributeCallback *	getEventCallback ()

const StateAttributeCallback *	getEventCallback () const

virtual void	compileGLObjects (State &) const

virtual void	resizeGLObjectBuffers (unsigned int)

virtual void	releaseGLObjects (State *=0) const

Public Member Functions inherited from osg::Object
	Object ()

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

std::string	getCompoundClassName () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

virtual void	setThreadSafeRefUnref (bool threadSafe)

virtual void	setName (const std::string &name)

void	setName (const char *name)

const std::string &	getName () const

void	setDataVariance (DataVariance dv)

DataVariance	getDataVariance () const

virtual void	computeDataVariance ()

void	setUserDataContainer (osg::UserDataContainer *udc)

osg::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

virtual Referenced *	getUserData ()

virtual const Referenced *	getUserData () const

template<typename T >
bool	getUserValue (const std::string &name, T &value) const

template<typename T >
void	setUserValue (const std::string &name, const T &value)

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const

int	ref () const

int	unref () const

int	unref_nodelete () const

int	referenceCount () const

ObserverSet *	getObserverSet () const

ObserverSet *	getOrCreateObserverSet () const

void	addObserver (Observer *observer) const

void	removeObserver (Observer *observer) const

Protected Member Functions
virtual	~Viewport ()

Protected Member Functions inherited from osg::StateAttribute
virtual	~StateAttribute ()

void	addParent (osg::StateSet *object)

void	removeParent (osg::StateSet *object)

Protected Member Functions inherited from osg::Object
virtual	~Object ()

Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()

void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

Protected Attributes
value_type	_x

value_type	_y

value_type	_width

value_type	_height

Protected Attributes inherited from osg::StateAttribute
ParentList	_parents

ref_ptr< ShaderComponent >	_shaderComponent

ref_ptr< StateAttributeCallback >	_updateCallback

ref_ptr< StateAttributeCallback >	_eventCallback

Protected Attributes inherited from osg::Object
std::string	_name

DataVariance	_dataVariance

osg::UserDataContainer *	_userDataContainer

Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet

OpenThreads::Atomic	_refCount

Additional Inherited Members
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

Detailed Description

Encapsulate OpenGL glViewport.

Definition at line 23 of file Viewport.h.

Member Typedef Documentation

typedef double osg::Viewport::value_type

Definition at line 30 of file Viewport.h.

Constructor & Destructor Documentation

osg::Viewport::Viewport ( )

osg::Viewport::Viewport	(	value_type	x,
		value_type	y,
		value_type	width,
		value_type	height
	)

inline

Definition at line 34 of file Viewport.h.

osg::Viewport::Viewport	(	const Viewport &	vp,
		const CopyOp &	copyop = `CopyOp::SHALLOW_COPY`
	)

inline

Copy constructor using CopyOp to manage deep vs shallow copy.

Definition at line 42 of file Viewport.h.

virtual osg::Viewport::~Viewport ( )

protectedvirtual

Member Function Documentation

virtual void osg::Viewport::apply ( State & ) const

virtual

apply the OpenGL state attributes. The render info for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

Reimplemented from osg::StateAttribute.

double osg::Viewport::aspectRatio ( ) const

inline

Return the aspectRatio of the viewport, which is equal to width/height. If height is zero, the potential division by zero is avoided by simply returning 1.0f.

Definition at line 121 of file Viewport.h.

virtual int osg::Viewport::compare ( const StateAttribute & sa ) const

inlinevirtual

Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Implements osg::StateAttribute.

Definition at line 52 of file Viewport.h.

const osg::Matrix osg::Viewport::computeWindowMatrix ( ) const

inline

Compute the Window Matrix which takes projected coords into Window coordinates. To convert local coordinates into window coordinates use v_window = v_local * MVPW matrix, where the MVPW matrix is ModelViewMatrix * ProjectionMatrix * WindowMatrix, the latter supplied by Viewport::computeWindowMatrix(), the ModelView and Projection Matrix can either be sourced from the current osg::State object, via osgUtil::SceneView or CullVisitor.

Definition at line 129 of file Viewport.h.

Here is the call graph for this function:

Here is the caller graph for this function:

value_type& osg::Viewport::height ( )

inline

Definition at line 113 of file Viewport.h.

value_type osg::Viewport::height ( ) const

inline

Definition at line 114 of file Viewport.h.

osg::Viewport::META_StateAttribute	(	osg	,
		Viewport	,
		VIEWPORT
	)

Viewport& osg::Viewport::operator= ( const Viewport & rhs )

inline

Definition at line 67 of file Viewport.h.

void osg::Viewport::setViewport	(	value_type	x,
		value_type	y,
		value_type	width,
		value_type	height
	)

inline

Definition at line 79 of file Viewport.h.

bool osg::Viewport::valid ( ) const

inline

Definition at line 116 of file Viewport.h.

value_type& osg::Viewport::width ( )

inline

Definition at line 110 of file Viewport.h.

value_type osg::Viewport::width ( ) const

inline

Definition at line 111 of file Viewport.h.

value_type& osg::Viewport::x ( )

inline

Definition at line 104 of file Viewport.h.

value_type osg::Viewport::x ( ) const

inline

Definition at line 105 of file Viewport.h.

value_type& osg::Viewport::y ( )

inline

Definition at line 107 of file Viewport.h.

value_type osg::Viewport::y ( ) const

inline

Definition at line 108 of file Viewport.h.

Member Data Documentation

value_type osg::Viewport::_height

protected

Definition at line 143 of file Viewport.h.

value_type osg::Viewport::_width

protected

Definition at line 142 of file Viewport.h.

value_type osg::Viewport::_x

protected

Definition at line 140 of file Viewport.h.

value_type osg::Viewport::_y

protected

Definition at line 141 of file Viewport.h.

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

osg_head/include/osg/Viewport.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation