OgreViewport.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef __Viewport_H__
29#define __Viewport_H__
30
31#include "OgrePrerequisites.h"
32#include "OgreCommon.h"
33#include "OgreColourValue.h"
34#include "OgreFrustum.h"
35#include "OgreHeaderPrefix.h"
36
37namespace Ogre {
58 {
59 public:
62 {
63 public:
64 virtual ~Listener() {}
65
67 virtual void viewportCameraChanged(Viewport* viewport) {}
68
70 virtual void viewportDimensionsChanged(Viewport* viewport) {}
71
73 virtual void viewportDestroyed(Viewport* viewport) {}
74 };
75
92 Camera* camera,
93 RenderTarget* target,
94 Real left, Real top,
95 Real width, Real height,
96 int ZOrder);
97
100 virtual ~Viewport();
101
110
113 void update(void);
114
127 void clear(unsigned int buffers = FBT_COLOUR | FBT_DEPTH,
128 const ColourValue& colour = ColourValue::Black,
129 Real depth = 1.0f, unsigned short stencil = 0);
130
134
137 Camera* getCamera(void) const;
138
141
143 int getZOrder(void) const;
147 Real getLeft(void) const;
148
152 Real getTop(void) const;
153
158 Real getWidth(void) const;
163 Real getHeight(void) const;
168 int getActualLeft(void) const;
173 int getActualTop(void) const;
177 int getActualWidth(void) const;
182 int getActualHeight(void) const;
183
197 void setDimensions(Real left, Real top, Real width, Real height);
198
202
206
210
214
218 void setBackgroundColour(const ColourValue& colour);
219
223
227 void setDepthClear( Real depth );
228
231 Real getDepthClear(void) const;
232
242 void setClearEveryFrame(bool clear, unsigned int buffers = FBT_COLOUR | FBT_DEPTH);
243
246 bool getClearEveryFrame(void) const;
247
249 unsigned int getClearBuffers(void) const;
250
266 bool isAutoUpdated() const;
267
276 { mMaterialSchemeName = schemeName; }
277
280 const String& getMaterialScheme(void) const
281 { return mMaterialSchemeName; }
282
286 int &left, int &top, int &width, int &height ) const;
287
288 bool _isUpdated(void) const;
290
293 unsigned int _getNumRenderedFaces(void) const;
294
297 unsigned int _getNumRenderedBatches(void) const;
298
310
313 bool getOverlaysEnabled(void) const;
314
326
329 bool getSkiesEnabled(void) const;
330
340
343 bool getShadowsEnabled(void) const;
344
345
354 void setVisibilityMask(uint32 mask) { mVisibilityMask = mask; }
355
359 uint getVisibilityMask(void) const { return mVisibilityMask; }
360
378
383
388
389 protected:
393 float mRelLeft, mRelTop, mRelWidth, mRelHeight;
395 int mActLeft, mActTop, mActWidth, mActHeight;
402 unsigned int mClearBuffers;
408 // Render queue invocation sequence name
416
419
422 };
426}
427
428#include "OgreHeaderSuffix.h"
429
430#endif
#define _OgreExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
A viewpoint from which the scene will be rendered.
Definition OgreCamera.h:87
Class representing colour.
Class to hold a linear sequence of RenderQueueInvocation objects.
A 'canvas' which can receive the results of a rendering operation.
Reference-counted shared pointer, used for objects where implicit destruction is required.
Standard 2-dimensional vector.
Definition OgreVector2.h:52
Listener interface so you can be notified of Viewport changes.
virtual void viewportDimensionsChanged(Viewport *viewport)
Notification of when target listening Viewport's dimensions changed.
virtual void viewportDestroyed(Viewport *viewport)
Notification of when target listening Viewport's is destroyed.
virtual void viewportCameraChanged(Viewport *viewport)
Notification of when a new camera is set to target listening Viewport.
An abstraction of a viewport, i.e.
static void setDefaultOrientationMode(OrientationMode orientationMode)
Set the initial orientation mode of viewports.
void setOrientationMode(OrientationMode orientationMode, bool setDefault=true)
Set the orientation mode of the viewport.
Camera * getCamera(void) const
Retrieves a pointer to the camera for this viewport.
virtual void setRenderQueueInvocationSequenceName(const String &sequenceName)
Sets the use of a custom RenderQueueInvocationSequence for rendering this target.
bool _isUpdated(void) const
void setSkiesEnabled(bool enabled)
Tells this viewport whether it should display skies.
void setCamera(Camera *cam)
Sets the camera to use for rendering to this viewport.
void _updateDimensions(void)
Notifies the viewport of a possible change in dimensions.
RenderTarget * mTarget
void setDepthClear(Real depth)
Sets the initial depth buffer value of the viewport (before rendering).
unsigned int _getNumRenderedBatches(void) const
Gets the number of rendered batches in the last update.
ColourValue mBackColour
Background options.
void setBackgroundColour(const ColourValue &colour)
Sets the initial background colour of the viewport (before rendering).
void pointOrientedToScreen(const Vector2 &v, int orientationMode, Vector2 &outv)
Convert oriented input point coordinates to screen coordinates.
bool isAutoUpdated() const
Gets whether this viewport is automatically updated if Ogre's rendering loop or RenderTarget::update ...
Real getWidth(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.
uint getVisibilityMask(void) const
Gets a per-viewport visibility mask.
bool getOverlaysEnabled(void) const
Returns whether or not Overlay objects (created in the SceneManager) are displayed in this viewport.
unsigned int getClearBuffers(void) const
Gets which buffers are to be cleared each frame.
void pointOrientedToScreen(Real orientedX, Real orientedY, int orientationMode, Real &screenX, Real &screenY)
int getActualWidth(void) const
Gets one of the actual dimensions of the viewport, a value in pixels.
void setOverlaysEnabled(bool enabled)
Tells this viewport whether it should display Overlay objects.
Real getTop(void) const
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
Real getDepthClear(void) const
Gets the default depth buffer value to which the viewport is cleared.
const ColourValue & getBackgroundColour(void) const
Gets the background colour.
OrientationMode mOrientationMode
Viewport orientation mode.
bool getSkiesEnabled(void) const
Returns whether or not skies (created in the SceneManager) are displayed in this viewport.
int mZOrder
Z-order.
void setAutoUpdated(bool autoupdate)
Sets whether this viewport should be automatically updated if Ogre's rendering loop or RenderTarget::...
void _clearUpdatedFlag(void)
ListenerList mListeners
virtual ~Viewport()
Default destructor.
void getActualDimensions(int &left, int &top, int &width, int &height) const
Access to actual dimensions (based on target size).
int getActualTop(void) const
Gets one of the actual dimensions of the viewport, a value in pixels.
RenderQueueInvocationSequence * mRQSequence
void setMaterialScheme(const String &schemeName)
Set the material scheme which the viewport should use.
RenderTarget * getTarget(void) const
Retrieves a pointer to the render target for this viewport.
void removeListener(Listener *l)
Remove a listener to this camera.
Real getHeight(void) const
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
uint32 mVisibilityMask
OrientationMode getOrientationMode() const
Get the orientation mode of the viewport.
String mRQSequenceName
bool getClearEveryFrame(void) const
Determines if the viewport is cleared before every frame.
bool mIsAutoUpdated
Automatic rendering on/off.
void update(void)
Instructs the viewport to updates its contents.
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 addListener(Listener *l)
Add a listener to this camera.
virtual const String & getRenderQueueInvocationSequenceName(void) const
Gets the name of the render queue invocation sequence for this target.
unsigned int mClearBuffers
int getActualHeight(void) const
Gets one of the actual dimensions of the viewport, a value in pixels.
String mMaterialSchemeName
Material scheme.
void setVisibilityMask(uint32 mask)
Sets a per-viewport visibility mask.
RenderQueueInvocationSequence * _getRenderQueueInvocationSequence(void)
Get the invocation sequence - will return null if using standard.
void setClearEveryFrame(bool clear, unsigned int buffers=FBT_COLOUR|FBT_DEPTH)
Determines whether to clear the viewport before rendering.
unsigned int _getNumRenderedFaces(void) const
Gets the number of rendered faces in the last update.
int getZOrder(void) const
Gets the Z-Order of this viewport.
const String & getMaterialScheme(void) const
Get the material scheme which the viewport should use.
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.
static OrientationMode getDefaultOrientationMode()
Get the initial orientation mode of viewports.
static OrientationMode mDefaultOrientationMode
Viewport(Camera *camera, RenderTarget *target, Real left, Real top, Real width, Real height, int ZOrder)
The usual constructor.
void setDimensions(Real left, Real top, Real width, Real height)
Sets the dimensions (after creation).
Real getLeft(void) const
Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.
vector< Listener * >::type ListenerList
OrientationMode
Specifies orientation mode.
Definition OgreFrustum.h:50
_StringBase String
std::vector< T, A > type

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.