#include <OgreViewport.h>
Public Member Functions | |
| Viewport (Camera *camera, RenderTarget *target, Real left, Real top, Real width, Real height, int ZOrder) | |
| The usual constructor. | |
| virtual | ~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. | |
| Real | getLeft (void) const |
| Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. | |
| Real | getTop (void) const |
| Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. | |
| Real | getWidth (void) const |
| Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. | |
| Real | 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 (Real left, Real top, Real width, Real 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, unsigned int buffers=FBT_COLOUR|FBT_DEPTH) |
| Determines whether to clear the viewport before rendering. | |
| bool | getClearEveryFrame (void) const |
| Determines if the viewport is cleared before every frame. | |
| unsigned int | getClearBuffers (void) const |
| Gets which buffers are to be cleared each frame. | |
| void | setMaterialScheme (const String &schemeName) |
| Set the material scheme which the viewport should use. | |
| const String & | getMaterialScheme (void) const |
| Get the material scheme which the viewport should use. | |
| 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. | |
| unsigned int | _getNumRenderedBatches (void) const |
| Gets the number of rendered batches 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. | |
| void | setSkiesEnabled (bool enabled) |
| Tells this viewport whether it should display skies. | |
| bool | getSkiesEnabled (void) const |
| Returns whether or not skies (created in the SceneManager) are displayed in this viewport. | |
| void | setShadowsEnabled (bool enabled) |
| Tells this viewport whether it should display shadows. | |
| bool | getShadowsEnabled (void) const |
| Returns whether or not shadows (defined in the SceneManager) are displayed in this viewport. | |
| void | setVisibilityMask (uint32 mask) |
| Sets a per-viewport visibility mask. | |
| uint | getVisibilityMask (void) const |
| Gets a per-viewport visibility mask. | |
| virtual void | setRenderQueueInvocationSequenceName (const String &sequenceName) |
| Sets the use of a custom RenderQueueInvocationSequence for rendering this target. | |
| virtual const String & | getRenderQueueInvocationSequenceName (void) const |
| Gets the name of the render queue invocation sequence for this target. | |
| RenderQueueInvocationSequence * | _getRenderQueueInvocationSequence (void) |
| Get the invocation sequence - will return null if using standard. | |
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 |
| unsigned int | mClearBuffers |
| bool | mUpdated |
| bool | mShowOverlays |
| bool | mShowSkies |
| bool | mShowShadows |
| uint32 | mVisibilityMask |
| String | mRQSequenceName |
| RenderQueueInvocationSequence * | mRQSequence |
| String | mMaterialSchemeName |
| Material scheme. | |
a rendering region on a render target.
Definition at line 50 of file OgreViewport.h.
|
||||||||||||||||||||||||||||||||
|
The usual constructor.
|
|
|
Default destructor.
|
|
|
|
|
|
Gets the number of rendered batches in the last update.
|
|
|
Gets the number of rendered faces in the last update.
|
|
|
Get the invocation sequence - will return null if using standard.
|
|
|
|
|
|
Notifies the viewport of a possible change in dimensions.
|
|
||||||||||||||||||||
|
Access to actual dimensions (based on target size).
|
|
|
Gets one of the actual dimensions of the viewport, a value in pixels.
|
|
|
Gets one of the actual dimensions of the viewport, a value in pixels.
|
|
|
Gets one of the actual dimensions of the viewport, a value in pixels.
|
|
|
Gets one of the actual dimensions of the viewport, a value in pixels.
|
|
|
Gets the background colour.
|
|
|
Retrieves a pointer to the camera for this viewport.
|
|
|
Gets which buffers are to be cleared each frame.
|
|
|
Determines if the viewport is cleared before every frame.
|
|
|
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
|
|
|
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
|
|
|
Get the material scheme which the viewport should use.
Definition at line 205 of file OgreViewport.h. |
|
|
Returns whether or not Overlay objects (created in the SceneManager) are displayed in this viewport.
|
|
|
Gets the name of the render queue invocation sequence for this target.
|
|
|
Returns whether or not shadows (defined in the SceneManager) are displayed in this viewport.
|
|
|
Returns whether or not skies (created in the SceneManager) are displayed in this viewport.
|
|
|
Retrieves a pointer to the render target for this viewport.
|
|
|
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
|
|
|
Gets a per-viewport visibility mask.
Definition at line 284 of file OgreViewport.h. |
|
|
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
|
|
|
Gets the Z-Order of this viewport.
|
|
|
Sets the initial background colour of the viewport (before rendering).
|
|
|
Sets the camera to use for rendering to this viewport.
|
|
||||||||||||
|
Determines whether to clear the viewport before rendering.
|
|
||||||||||||||||||||
|
Sets the dimensions (after creation).
|
|
|
Set the material scheme which the viewport should use.
Definition at line 200 of file OgreViewport.h. |
|
|
Tells this viewport whether it should display Overlay objects.
|
|
|
Sets the use of a custom RenderQueueInvocationSequence for rendering this target.
|
|
|
Tells this viewport whether it should display shadows.
|
|
|
Tells this viewport whether it should display skies.
|
|
|
Sets a per-viewport visibility mask.
Definition at line 279 of file OgreViewport.h. |
|
|
Instructs the viewport to updates its contents.
|
|
|
Definition at line 310 of file OgreViewport.h. |
|
|
Definition at line 310 of file OgreViewport.h. |
|
|
Definition at line 310 of file OgreViewport.h. |
|
|
Definition at line 310 of file OgreViewport.h. |
|
|
Background options.
Definition at line 314 of file OgreViewport.h. |
|
|
Definition at line 305 of file OgreViewport.h. |
|
|
Definition at line 316 of file OgreViewport.h. |
|
|
Definition at line 315 of file OgreViewport.h. |
|
|
Material scheme.
Definition at line 326 of file OgreViewport.h. |
|
|
Definition at line 308 of file OgreViewport.h. |
|
|
Definition at line 308 of file OgreViewport.h. |
|
|
Definition at line 308 of file OgreViewport.h. |
|
|
Definition at line 308 of file OgreViewport.h. |
|
|
Definition at line 324 of file OgreViewport.h. |
|
|
Definition at line 323 of file OgreViewport.h. |
|
|
Definition at line 318 of file OgreViewport.h. |
|
|
Definition at line 320 of file OgreViewport.h. |
|
|
Definition at line 319 of file OgreViewport.h. |
|
|
Definition at line 306 of file OgreViewport.h. |
|
|
Definition at line 317 of file OgreViewport.h. |
|
|
Definition at line 321 of file OgreViewport.h. |
|
|
ZOrder.
Definition at line 312 of file OgreViewport.h. |
Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 30 10:54:08 2007