#include <OgreViewport.h>
Public Methods | |
Viewport (Camera *camera, RenderTarget *target, float left, float top, float width, float height, int ZOrder) | |
The usual constructor. | |
~Viewport () | |
Default destructor. | |
void | _updateDimensions (void) |
Notifies the viewport of a possible change in dimensions. | |
void | update (void) |
Instructs the viewport to updates its contents. | |
RenderTarget * | getTarget (void) const |
Retrieves a pointer to the render target for this viewport. | |
Camera * | getCamera (void) const |
Retrieves a pointer to the camera for this viewport. | |
void | setCamera (Camera *cam) |
Sets the camera to use for rendering to this viewport. | |
int | getZOrder (void) const |
Gets the Z-Order of this viewport. | |
float | getLeft (void) const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. | |
float | getTop (void) const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. | |
float | getWidth (void) const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. | |
float | getHeight (void) const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. | |
int | getActualLeft (void) const |
Gets one of the actual dimensions of the viewport, a value in pixels. | |
int | getActualTop (void) const |
Gets one of the actual dimensions of the viewport, a value in pixels. | |
int | getActualWidth (void) const |
Gets one of the actual dimensions of the viewport, a value in pixels. | |
int | getActualHeight (void) const |
Gets one of the actual dimensions of the viewport, a value in pixels. | |
void | setDimensions (float left, float top, float width, float height) |
Sets the dimensions (after creation). | |
void | setBackgroundColour (const ColourValue &colour) |
Sets the initial background colour of the viewport (before rendering). | |
const ColourValue & | getBackgroundColour (void) const |
Gets the background colour. | |
void | setClearEveryFrame (bool clear) |
Determines whether to clear the viewport before rendering. | |
bool | getClearEveryFrame (void) const |
Determines if the viewport is cleared before every frame. | |
void | getActualDimensions (int &left, int &top, int &width, int &height) const |
Access to actual dimensions (based on target size). | |
bool | _isUpdated (void) const |
void | _clearUpdatedFlag (void) |
unsigned int | _getNumRenderedFaces (void) const |
Gets the number of rendered faces in the last update. | |
void | setOverlaysEnabled (bool enabled) |
Tells this viewport whether it should display Overlay objects. | |
bool | getOverlaysEnabled (void) const |
Returns whether or not Overlay objects (created in the SceneManager) are displayed in this viewport. | |
Protected Attributes | |
Camera * | mCamera |
RenderTarget * | mTarget |
float | mRelLeft |
float | mRelTop |
float | mRelWidth |
float | mRelHeight |
int | mActLeft |
int | mActTop |
int | mActWidth |
int | mActHeight |
int | mZOrder |
ZOrder. | |
ColourValue | mBackColour |
Background options. | |
bool | mClearEveryFrame |
bool | mUpdated |
bool | mShowOverlays |
a rendering region on a render target.
Definition at line 46 of file OgreViewport.h.
|
The usual constructor.
|
|
Default destructor.
Definition at line 68 of file OgreViewport.cpp. |
|
Definition at line 78 of file OgreViewport.cpp. References mUpdated. Referenced by Ogre::GLRenderSystem::_setViewport(), Ogre::D3D9RenderSystem::_setViewport(), and Ogre::D3DRenderSystem::_setViewport(). |
|
Gets the number of rendered faces in the last update.
Definition at line 215 of file OgreViewport.cpp. References Ogre::Camera::_getNumRenderedFaces(), and mCamera. |
|
Definition at line 73 of file OgreViewport.cpp. References mUpdated. Referenced by Ogre::GLRenderSystem::_setViewport(), Ogre::D3D9RenderSystem::_setViewport(), and Ogre::D3DRenderSystem::_setViewport(). |
|
Notifies the viewport of a possible change in dimensions.
Definition at line 83 of file OgreViewport.cpp. References Ogre::Camera::getAutoAspectRatio(), Ogre::RenderTarget::getHeight(), Ogre::Camera::getName(), Ogre::RenderTarget::getWidth(), mActHeight, mActLeft, mActTop, mActWidth, mCamera, mRelHeight, mRelLeft, mRelTop, mRelWidth, mTarget, mUpdated, Ogre::Real, and Ogre::Frustum::setAspectRatio(). |
|
Access to actual dimensions (based on target size).
Definition at line 206 of file OgreViewport.cpp. References mActHeight, mActLeft, mActTop, and mActWidth. Referenced by Ogre::SceneManager::renderShadowVolumesToStencil(). |
|
Gets one of the actual dimensions of the viewport, a value in pixels.
Definition at line 163 of file OgreViewport.cpp. References mActHeight. Referenced by Ogre::TerrainRenderable::_calculateCFactor(), Ogre::OverlayManager::_queueOverlaysForRendering(), Ogre::GLRenderSystem::_setViewport(), Ogre::D3D9RenderSystem::_setViewport(), Ogre::D3DRenderSystem::_setViewport(), and Ogre::GLRenderSystem::setScissorTest(). |
|
Gets one of the actual dimensions of the viewport, a value in pixels.
Definition at line 148 of file OgreViewport.cpp. References mActLeft. Referenced by Ogre::GLRenderSystem::_setViewport(), Ogre::D3D9RenderSystem::_setViewport(), Ogre::D3DRenderSystem::_setViewport(), and Ogre::GLRenderSystem::setScissorTest(). |
|
Gets one of the actual dimensions of the viewport, a value in pixels.
Definition at line 153 of file OgreViewport.cpp. References mActTop. Referenced by Ogre::GLRenderSystem::_setViewport(), Ogre::D3D9RenderSystem::_setViewport(), Ogre::D3DRenderSystem::_setViewport(), and Ogre::GLRenderSystem::setScissorTest(). |
|
Gets one of the actual dimensions of the viewport, a value in pixels.
Definition at line 158 of file OgreViewport.cpp. References mActWidth. Referenced by Ogre::OverlayManager::_queueOverlaysForRendering(), Ogre::GLRenderSystem::_setViewport(), Ogre::D3D9RenderSystem::_setViewport(), Ogre::D3DRenderSystem::_setViewport(), and Ogre::GLRenderSystem::setScissorTest(). |
|
Gets the background colour.
Definition at line 191 of file OgreViewport.cpp. References mBackColour. Referenced by Ogre::GLRenderSystem::_beginFrame(), Ogre::D3D9RenderSystem::_beginFrame(), and Ogre::D3DRenderSystem::_beginFrame(). |
|
Retrieves a pointer to the camera for this viewport.
Definition at line 123 of file OgreViewport.cpp. References mCamera. Referenced by Ogre::RenderTarget::_notifyCameraRemoved(), Ogre::SceneManager::createShadowTextures(), Ogre::SceneManager::prepareShadowTextures(), and Ogre::SceneManager::renderModulativeTextureShadowedQueueGroupObjects(). |
|
Determines if the viewport is cleared before every frame.
Definition at line 201 of file OgreViewport.cpp. References mClearEveryFrame. Referenced by Ogre::GLRenderSystem::_beginFrame(), Ogre::D3D9RenderSystem::_beginFrame(), and Ogre::D3DRenderSystem::_beginFrame(). |
|
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
Definition at line 143 of file OgreViewport.cpp. References mRelHeight, and Ogre::Real. |
|
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
Definition at line 128 of file OgreViewport.cpp. References mRelLeft, and Ogre::Real. |
|
Returns whether or not Overlay objects (created in the SceneManager) are displayed in this viewport.
Definition at line 231 of file OgreViewport.cpp. References mShowOverlays. Referenced by Ogre::SceneManager::_renderScene(). |
|
Retrieves a pointer to the render target for this viewport.
Definition at line 118 of file OgreViewport.cpp. References mTarget. Referenced by Ogre::SceneManager::_renderScene(), Ogre::GLRenderSystem::_setViewport(), Ogre::D3D9RenderSystem::_setViewport(), and Ogre::D3DRenderSystem::_setViewport(). |
|
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
Definition at line 133 of file OgreViewport.cpp. References mRelTop, and Ogre::Real. |
|
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
Definition at line 138 of file OgreViewport.cpp. References mRelWidth, and Ogre::Real. |
|
Gets the Z-Order of this viewport.
Definition at line 113 of file OgreViewport.cpp. References mZOrder. |
|
Sets the initial background colour of the viewport (before rendering).
Definition at line 186 of file OgreViewport.cpp. References mBackColour. Referenced by Ogre::SceneManager::prepareShadowTextures(). |
|
Sets the camera to use for rendering to this viewport.
Definition at line 220 of file OgreViewport.cpp. References mCamera. Referenced by Ogre::RenderTarget::_notifyCameraRemoved(). |
|
Determines whether to clear the viewport before rendering.
Definition at line 196 of file OgreViewport.cpp. References mClearEveryFrame. Referenced by Ogre::SceneManager::createShadowTextures(). |
|
Sets the dimensions (after creation).
|
|
Tells this viewport whether it should display Overlay objects.
Definition at line 226 of file OgreViewport.cpp. References mShowOverlays. Referenced by Ogre::SceneManager::createShadowTextures(). |
|
Instructs the viewport to updates its contents.
Definition at line 177 of file OgreViewport.cpp. References Ogre::Camera::_renderScene(), mCamera, and mShowOverlays. |
|
Definition at line 219 of file OgreViewport.h. Referenced by _updateDimensions(), getActualDimensions(), and getActualHeight(). |
|
Definition at line 219 of file OgreViewport.h. Referenced by _updateDimensions(), getActualDimensions(), and getActualLeft(). |
|
Definition at line 219 of file OgreViewport.h. Referenced by _updateDimensions(), getActualDimensions(), and getActualTop(). |
|
Definition at line 219 of file OgreViewport.h. Referenced by _updateDimensions(), getActualDimensions(), and getActualWidth(). |
|
Background options.
Definition at line 223 of file OgreViewport.h. Referenced by getBackgroundColour(), and setBackgroundColour(). |
|
Definition at line 214 of file OgreViewport.h. Referenced by _getNumRenderedFaces(), _updateDimensions(), getCamera(), setCamera(), and update(). |
|
Definition at line 224 of file OgreViewport.h. Referenced by getClearEveryFrame(), and setClearEveryFrame(). |
|
Definition at line 217 of file OgreViewport.h. Referenced by _updateDimensions(), and getHeight(). |
|
Definition at line 217 of file OgreViewport.h. Referenced by _updateDimensions(), and getLeft(). |
|
Definition at line 217 of file OgreViewport.h. Referenced by _updateDimensions(), and getTop(). |
|
Definition at line 217 of file OgreViewport.h. Referenced by _updateDimensions(), and getWidth(). |
|
Definition at line 226 of file OgreViewport.h. Referenced by getOverlaysEnabled(), setOverlaysEnabled(), and update(). |
|
Definition at line 215 of file OgreViewport.h. Referenced by _updateDimensions(), and getTarget(). |
|
Definition at line 225 of file OgreViewport.h. Referenced by _clearUpdatedFlag(), _isUpdated(), and _updateDimensions(). |
|
ZOrder.
Definition at line 221 of file OgreViewport.h. Referenced by getZOrder(). |
Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:47 2004