openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Viewport Class Reference
Inheritance diagram for osg::Viewport:
osg::StateAttribute osg::Object osg::Referenced

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, VALIDATOR,
  VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM,
  OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER,
  UNIFORMBUFFERBINDING, TRANSFORMFEEDBACKBUFFERBINDING
}
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
void setViewport (value_type x, value_type y, value_type width, value_type height)
value_typex ()
value_type x () const
value_typey ()
value_type y () const
value_typewidth ()
value_type width () const
value_typeheight ()
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 ObjectcloneType () const =0
virtual Objectclone (const CopyOp &) const =0
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual TextureasTexture ()
virtual const TextureasTexture () 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 ParentListgetParents () const
StateSetgetParent (unsigned int i)
const StateSetgetParent (unsigned int i) const
unsigned int getNumParents () const
void setShaderComponent (ShaderComponent *sc)
ShaderComponentgetShaderComponent ()
const ShaderComponentgetShaderComponent () const
virtual bool getModeUsage (ModeUsage &) const
virtual bool checkValidityOfAssociatedModes (osg::State &) const
void setUpdateCallback (StateAttributeCallback *uc)
StateAttributeCallbackgetUpdateCallback ()
const StateAttributeCallbackgetUpdateCallback () const
void setEventCallback (StateAttributeCallback *ec)
StateAttributeCallbackgetEventCallback ()
const StateAttributeCallbackgetEventCallback () 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)
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::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () 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)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () 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::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

Detailed Description

Encapsulate OpenGL glViewport.

Member Typedef Documentation

typedef double osg::Viewport::value_type

Constructor & Destructor Documentation

osg::Viewport::Viewport ( )
osg::Viewport::Viewport ( value_type  x,
value_type  y,
value_type  width,
value_type  height 
)
inline
osg::Viewport::Viewport ( const Viewport vp,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline

Copy constructor using CopyOp to manage deep vs shallow copy.

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.

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.

References COMPARE_StateAttribute_Parameter, and COMPARE_StateAttribute_Types.

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.

References osg::Matrixd::scale(), and osg::Matrixd::translate().

Referenced by osg::CullStack::getWindowMatrix(), osgUtil::IntersectionVisitor::pushWindowMatrix(), and osgManipulator::PointerInfo::setCamera().

value_type& osg::Viewport::height ( )
inline
value_type osg::Viewport::height ( ) const
inline
osg::Viewport::META_StateAttribute ( osg  ,
Viewport  ,
VIEWPORT   
)
void osg::Viewport::setViewport ( value_type  x,
value_type  y,
value_type  width,
value_type  height 
)
inline
bool osg::Viewport::valid ( ) const
inline
value_type& osg::Viewport::width ( )
inline
value_type osg::Viewport::width ( ) const
inline
value_type& osg::Viewport::x ( )
inline
value_type osg::Viewport::x ( ) const
inline
value_type& osg::Viewport::y ( )
inline
value_type osg::Viewport::y ( ) const
inline

Member Data Documentation

value_type osg::Viewport::_height
protected
value_type osg::Viewport::_width
protected
value_type osg::Viewport::_x
protected
value_type osg::Viewport::_y
protected

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