An abstraction of a viewport, i.e. More...
#include <OgreViewport.h>
Classes | |
class | Listener |
Listener interface so you can be notified of Viewport changes. More... | |
Public Member Functions | |
Viewport (Camera *camera, RenderTarget *target, Real left, Real top, Real width, Real height, int ZOrder) | |
The usual constructor. More... | |
virtual | ~Viewport () |
Default destructor. More... | |
void | _clearUpdatedFlag (void) |
unsigned int | _getNumRenderedBatches (void) const |
Gets the number of rendered batches in the last update. More... | |
unsigned int | _getNumRenderedFaces (void) const |
Gets the number of rendered faces in the last update. More... | |
RenderQueueInvocationSequence * | _getRenderQueueInvocationSequence (void) |
Get the invocation sequence - will return null if using standard. More... | |
bool | _isUpdated (void) const |
void | _updateDimensions (void) |
Notifies the viewport of a possible change in dimensions. More... | |
void | addListener (Listener *l) |
Add a listener to this camera. More... | |
void | clear (unsigned int buffers=FBT_COLOUR|FBT_DEPTH, const ColourValue &colour=ColourValue::Black, Real depth=1.0f, unsigned short stencil=0) |
Instructs the viewport to clear itself, without performing an update. More... | |
void | getActualDimensions (int &left, int &top, int &width, int &height) const |
Access to actual dimensions (based on target size). More... | |
int | getActualHeight (void) const |
Gets one of the actual dimensions of the viewport, a value in pixels. More... | |
int | getActualLeft (void) const |
Gets one of the actual dimensions of the viewport, a value in pixels. More... | |
int | getActualTop (void) const |
Gets one of the actual dimensions of the viewport, a value in pixels. More... | |
int | getActualWidth (void) const |
Gets one of the actual dimensions of the viewport, a value in pixels. More... | |
const ColourValue & | getBackgroundColour (void) const |
Gets the background colour. More... | |
Camera * | getCamera (void) const |
Retrieves a pointer to the camera for this viewport. More... | |
unsigned int | getClearBuffers (void) const |
Gets which buffers are to be cleared each frame. More... | |
bool | getClearEveryFrame (void) const |
Determines if the viewport is cleared before every frame. More... | |
Real | getDepthClear (void) const |
Gets the default depth buffer value to which the viewport is cleared. More... | |
Real | getHeight (void) const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. More... | |
Real | getLeft (void) const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. More... | |
const String & | getMaterialScheme (void) const |
Get the material scheme which the viewport should use. More... | |
OrientationMode | getOrientationMode () const |
Get the orientation mode of the viewport. More... | |
bool | getOverlaysEnabled (void) const |
Returns whether or not Overlay objects (created in the SceneManager) are displayed in this viewport. More... | |
virtual const String & | getRenderQueueInvocationSequenceName (void) const |
Gets the name of the render queue invocation sequence for this target. More... | |
bool | getShadowsEnabled (void) const |
Returns whether or not shadows (defined in the SceneManager) are displayed in this viewport. More... | |
bool | getSkiesEnabled (void) const |
Returns whether or not skies (created in the SceneManager) are displayed in this viewport. More... | |
RenderTarget * | getTarget (void) const |
Retrieves a pointer to the render target for this viewport. More... | |
Real | getTop (void) const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. More... | |
uint | getVisibilityMask (void) const |
Gets a per-viewport visibility mask. More... | |
Real | getWidth (void) const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. More... | |
int | getZOrder (void) const |
Gets the Z-Order of this viewport. More... | |
bool | isAutoUpdated () const |
Gets whether this viewport is automatically updated if Ogre's rendering loop or RenderTarget::update is being used. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
void | pointOrientedToScreen (const Vector2 &v, int orientationMode, Vector2 &outv) |
Convert oriented input point coordinates to screen coordinates. More... | |
void | pointOrientedToScreen (Real orientedX, Real orientedY, int orientationMode, Real &screenX, Real &screenY) |
void | removeListener (Listener *l) |
Remove a listener to this camera. More... | |
void | setAutoUpdated (bool autoupdate) |
Sets whether this viewport should be automatically updated if Ogre's rendering loop or RenderTarget::update is being used. More... | |
void | setBackgroundColour (const ColourValue &colour) |
Sets the initial background colour of the viewport (before rendering). More... | |
void | setCamera (Camera *cam) |
Sets the camera to use for rendering to this viewport. More... | |
void | setClearEveryFrame (bool clear, unsigned int buffers=FBT_COLOUR|FBT_DEPTH) |
Determines whether to clear the viewport before rendering. More... | |
void | setDepthClear (Real depth) |
Sets the initial depth buffer value of the viewport (before rendering). More... | |
void | setDimensions (Real left, Real top, Real width, Real height) |
Sets the dimensions (after creation). More... | |
void | setMaterialScheme (const String &schemeName) |
Set the material scheme which the viewport should use. More... | |
void | setOrientationMode (OrientationMode orientationMode, bool setDefault=true) |
Set the orientation mode of the viewport. More... | |
void | setOverlaysEnabled (bool enabled) |
Tells this viewport whether it should display Overlay objects. More... | |
virtual void | setRenderQueueInvocationSequenceName (const String &sequenceName) |
Sets the use of a custom RenderQueueInvocationSequence for rendering this target. More... | |
void | setShadowsEnabled (bool enabled) |
Tells this viewport whether it should display shadows. More... | |
void | setSkiesEnabled (bool enabled) |
Tells this viewport whether it should display skies. More... | |
void | setVisibilityMask (uint32 mask) |
Sets a per-viewport visibility mask. More... | |
void | update (void) |
Instructs the viewport to updates its contents. More... | |
Static Public Member Functions | |
static OrientationMode | getDefaultOrientationMode () |
Get the initial orientation mode of viewports. More... | |
static void | setDefaultOrientationMode (OrientationMode orientationMode) |
Set the initial orientation mode of viewports. More... | |
Protected Types | |
typedef vector< Listener * >::type | ListenerList |
Protected Attributes | |
int | mActHeight |
int | mActLeft |
Actual dimensions, based on target dimensions. More... | |
int | mActTop |
int | mActWidth |
ColourValue | mBackColour |
Background options. More... | |
Camera * | mCamera |
unsigned int | mClearBuffers |
bool | mClearEveryFrame |
Real | mDepthClearValue |
bool | mIsAutoUpdated |
Automatic rendering on/off. More... | |
ListenerList | mListeners |
String | mMaterialSchemeName |
Material scheme. More... | |
OrientationMode | mOrientationMode |
Viewport orientation mode. More... | |
float | mRelHeight |
float | mRelLeft |
Relative dimensions, irrespective of target dimensions (0..1) More... | |
float | mRelTop |
float | mRelWidth |
RenderQueueInvocationSequence * | mRQSequence |
String | mRQSequenceName |
bool | mShowOverlays |
bool | mShowShadows |
bool | mShowSkies |
RenderTarget * | mTarget |
bool | mUpdated |
uint32 | mVisibilityMask |
int | mZOrder |
Z-order. More... | |
Static Protected Attributes | |
static OrientationMode | mDefaultOrientationMode |
An abstraction of a viewport, i.e.
a rendering region on a render target.
Definition at line 57 of file OgreViewport.h.
|
protected |
Definition at line 420 of file OgreViewport.h.
Ogre::Viewport::Viewport | ( | Camera * | camera, |
RenderTarget * | target, | ||
Real | left, | ||
Real | top, | ||
Real | width, | ||
Real | height, | ||
int | ZOrder | ||
) |
The usual constructor.
camera | Pointer to a camera to be the source for the image. |
target | Pointer to the render target to be the destination for the rendering. |
left,top,width,height | Dimensions of the viewport, expressed as a value between 0 and 1. This allows the dimensions to apply irrespective of changes in the target's size: e.g. to fill the whole area, values of 0,0,1,1 are appropriate. |
ZOrder | Relative Z-order on the target. Lower = further to the front. |
|
virtual |
Default destructor.
void Ogre::Viewport::_clearUpdatedFlag | ( | void | ) |
unsigned int Ogre::Viewport::_getNumRenderedBatches | ( | void | ) | const |
Gets the number of rendered batches in the last update.
unsigned int Ogre::Viewport::_getNumRenderedFaces | ( | void | ) | const |
Gets the number of rendered faces in the last update.
RenderQueueInvocationSequence* Ogre::Viewport::_getRenderQueueInvocationSequence | ( | void | ) |
Get the invocation sequence - will return null if using standard.
bool Ogre::Viewport::_isUpdated | ( | void | ) | const |
void Ogre::Viewport::_updateDimensions | ( | void | ) |
Notifies the viewport of a possible change in dimensions.
void Ogre::Viewport::addListener | ( | Listener * | l | ) |
Add a listener to this camera.
void Ogre::Viewport::clear | ( | unsigned int | buffers = FBT_COLOUR|FBT_DEPTH , |
const ColourValue & | colour = ColourValue::Black , |
||
Real | depth = 1.0f , |
||
unsigned short | stencil = 0 |
||
) |
Instructs the viewport to clear itself, without performing an update.
buffers | Bitmask identifying which buffer elements to clear |
colour | The colour value to clear to, if FBT_COLOUR is included |
depth | The depth value to clear to, if FBT_DEPTH is included |
stencil | The stencil value to clear to, if FBT_STENCIL is included |
void Ogre::Viewport::getActualDimensions | ( | int & | left, |
int & | top, | ||
int & | width, | ||
int & | height | ||
) | const |
Access to actual dimensions (based on target size).
int Ogre::Viewport::getActualHeight | ( | void | ) | const |
Gets one of the actual dimensions of the viewport, a value in pixels.
int Ogre::Viewport::getActualLeft | ( | void | ) | const |
Gets one of the actual dimensions of the viewport, a value in pixels.
int Ogre::Viewport::getActualTop | ( | void | ) | const |
Gets one of the actual dimensions of the viewport, a value in pixels.
int Ogre::Viewport::getActualWidth | ( | void | ) | const |
Gets one of the actual dimensions of the viewport, a value in pixels.
const ColourValue& Ogre::Viewport::getBackgroundColour | ( | void | ) | const |
Gets the background colour.
Camera* Ogre::Viewport::getCamera | ( | void | ) | const |
Retrieves a pointer to the camera for this viewport.
unsigned int Ogre::Viewport::getClearBuffers | ( | void | ) | const |
Gets which buffers are to be cleared each frame.
bool Ogre::Viewport::getClearEveryFrame | ( | void | ) | const |
Determines if the viewport is cleared before every frame.
|
static |
Get the initial orientation mode of viewports.
Real Ogre::Viewport::getDepthClear | ( | void | ) | const |
Gets the default depth buffer value to which the viewport is cleared.
Real Ogre::Viewport::getHeight | ( | void | ) | const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
Real Ogre::Viewport::getLeft | ( | void | ) | const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
|
inline |
Get the material scheme which the viewport should use.
Definition at line 280 of file OgreViewport.h.
OrientationMode Ogre::Viewport::getOrientationMode | ( | ) | const |
Get the orientation mode of the viewport.
bool Ogre::Viewport::getOverlaysEnabled | ( | void | ) | const |
Returns whether or not Overlay objects (created in the SceneManager) are displayed in this viewport.
|
virtual |
Gets the name of the render queue invocation sequence for this target.
bool Ogre::Viewport::getShadowsEnabled | ( | void | ) | const |
Returns whether or not shadows (defined in the SceneManager) are displayed in this viewport.
bool Ogre::Viewport::getSkiesEnabled | ( | void | ) | const |
Returns whether or not skies (created in the SceneManager) are displayed in this viewport.
RenderTarget* Ogre::Viewport::getTarget | ( | void | ) | const |
Retrieves a pointer to the render target for this viewport.
Real Ogre::Viewport::getTop | ( | void | ) | const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
|
inline |
Gets a per-viewport visibility mask.
Definition at line 359 of file OgreViewport.h.
Real Ogre::Viewport::getWidth | ( | void | ) | const |
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
int Ogre::Viewport::getZOrder | ( | void | ) | const |
Gets the Z-Order of this viewport.
bool Ogre::Viewport::isAutoUpdated | ( | ) | const |
Gets whether this viewport is automatically updated if Ogre's rendering loop or RenderTarget::update is being used.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
void Ogre::Viewport::pointOrientedToScreen | ( | const Vector2 & | v, |
int | orientationMode, | ||
Vector2 & | outv | ||
) |
Convert oriented input point coordinates to screen coordinates.
void Ogre::Viewport::pointOrientedToScreen | ( | Real | orientedX, |
Real | orientedY, | ||
int | orientationMode, | ||
Real & | screenX, | ||
Real & | screenY | ||
) |
void Ogre::Viewport::removeListener | ( | Listener * | l | ) |
Remove a listener to this camera.
void Ogre::Viewport::setAutoUpdated | ( | bool | autoupdate | ) |
Sets whether this viewport should be automatically updated if Ogre's rendering loop or RenderTarget::update is being used.
autoupdate | If true, the viewport is updated during the automatic render loop or when RenderTarget::update() is called. If false, the viewport is only updated when its update() method is called explicitly. |
void Ogre::Viewport::setBackgroundColour | ( | const ColourValue & | colour | ) |
Sets the initial background colour of the viewport (before rendering).
void Ogre::Viewport::setCamera | ( | Camera * | cam | ) |
Sets the camera to use for rendering to this viewport.
void Ogre::Viewport::setClearEveryFrame | ( | bool | clear, |
unsigned int | buffers = FBT_COLOUR|FBT_DEPTH |
||
) |
Determines whether to clear the viewport before rendering.
clear | Whether or not to clear any buffers |
buffers | One or more values from FrameBufferType denoting which buffers to clear, if clear is set to true. Note you should not clear the stencil buffer here unless you know what you're doing. |
|
static |
Set the initial orientation mode of viewports.
void Ogre::Viewport::setDepthClear | ( | Real | depth | ) |
Sets the initial depth buffer value of the viewport (before rendering).
Default is 1
Sets the dimensions (after creation).
left | Left point of viewport. |
top | Top point of the viewport. |
width | Width of the viewport. |
height | Height of the viewport. |
|
inline |
Set the material scheme which the viewport should use.
Definition at line 275 of file OgreViewport.h.
void Ogre::Viewport::setOrientationMode | ( | OrientationMode | orientationMode, |
bool | setDefault = true |
||
) |
Set the orientation mode of the viewport.
void Ogre::Viewport::setOverlaysEnabled | ( | bool | enabled | ) |
Tells this viewport whether it should display Overlay objects.
enabled | If true, any overlays are displayed, if false they are not. |
|
virtual |
Sets the use of a custom RenderQueueInvocationSequence for rendering this target.
sequenceName | The name of the RenderQueueInvocationSequence to use. If you specify a blank string, behaviour will return to the default render queue management. |
void Ogre::Viewport::setShadowsEnabled | ( | bool | enabled | ) |
Tells this viewport whether it should display shadows.
enabled | If true, any shadows are displayed, if false they are not. |
void Ogre::Viewport::setSkiesEnabled | ( | bool | enabled | ) |
Tells this viewport whether it should display skies.
enabled | If true, any skies are displayed, if false they are not. |
|
inline |
Sets a per-viewport visibility mask.
Definition at line 354 of file OgreViewport.h.
void Ogre::Viewport::update | ( | void | ) |
Instructs the viewport to updates its contents.
|
protected |
Definition at line 395 of file OgreViewport.h.
|
protected |
Actual dimensions, based on target dimensions.
Definition at line 395 of file OgreViewport.h.
|
protected |
Definition at line 395 of file OgreViewport.h.
|
protected |
Definition at line 395 of file OgreViewport.h.
|
protected |
Background options.
Definition at line 399 of file OgreViewport.h.
|
protected |
Definition at line 390 of file OgreViewport.h.
|
protected |
Definition at line 402 of file OgreViewport.h.
|
protected |
Definition at line 401 of file OgreViewport.h.
|
staticprotected |
Definition at line 415 of file OgreViewport.h.
|
protected |
Definition at line 400 of file OgreViewport.h.
|
protected |
Automatic rendering on/off.
Definition at line 418 of file OgreViewport.h.
|
protected |
Definition at line 421 of file OgreViewport.h.
|
protected |
Material scheme.
Definition at line 412 of file OgreViewport.h.
|
protected |
Viewport orientation mode.
Definition at line 414 of file OgreViewport.h.
|
protected |
Definition at line 393 of file OgreViewport.h.
|
protected |
Relative dimensions, irrespective of target dimensions (0..1)
Definition at line 393 of file OgreViewport.h.
|
protected |
Definition at line 393 of file OgreViewport.h.
|
protected |
Definition at line 393 of file OgreViewport.h.
|
protected |
Definition at line 410 of file OgreViewport.h.
|
protected |
Definition at line 409 of file OgreViewport.h.
|
protected |
Definition at line 404 of file OgreViewport.h.
|
protected |
Definition at line 406 of file OgreViewport.h.
|
protected |
Definition at line 405 of file OgreViewport.h.
|
protected |
Definition at line 391 of file OgreViewport.h.
|
protected |
Definition at line 403 of file OgreViewport.h.
|
protected |
Definition at line 407 of file OgreViewport.h.
|
protected |
Z-order.
Definition at line 397 of file OgreViewport.h.