Viewport definition either for a render surface or the backbuffer. More...

#include <Urho3D/Graphics/Viewport.h>

Inheritance diagram for Urho3D::Viewport:
[legend]
Collaboration diagram for Urho3D::Viewport:
[legend]

Public Member Functions

 Viewport (Context *context)
 Construct with defaults.
 
 Viewport (Context *context, Scene *scene, Camera *camera, RenderPath *renderPath=nullptr)
 Construct with a full rectangle.
 
 Viewport (Context *context, Scene *scene, Camera *camera, const IntRect &rect, RenderPath *renderPath=nullptr)
 Construct with a specified rectangle.
 
virtual ~Viewport () override
 Destruct.
 
void SetScene (Scene *scene)
 Set scene.
 
void SetCamera (Camera *camera)
 Set viewport camera.
 
void SetRect (const IntRect &rect)
 Set view rectangle. A zero rectangle (0 0 0 0) means to use the rendertarget's full dimensions.
 
void SetRenderPath (RenderPath *path)
 Set rendering path.
 
void SetRenderPath (XMLFile *file)
 Set rendering path from an XML file.
 
void SetDrawDebug (bool enable)
 Set whether to render debug geometry. Default true.
 
void SetCullCamera (Camera *camera)
 Set separate camera to use for culling. Sharing a culling camera between several viewports allows to prepare the view only once, saving in CPU use. The culling camera's frustum should cover all the viewport cameras' frusta or else objects may be missing from the rendered view.
 
SceneGetScene () const
 Return scene.
 
CameraGetCamera () const
 Return viewport camera.
 
ViewGetView () const
 Return the internal rendering structure. May be null if the viewport has not been rendered yet.
 
const IntRectGetRect () const
 Return view rectangle. A zero rectangle (0 0 0 0) means to use the rendertarget's full dimensions. In this case you could fetch the actual view rectangle from View object, though it will be valid only after the first frame.
 
RenderPathGetRenderPath () const
 Return rendering path.
 
bool GetDrawDebug () const
 Return whether to draw debug geometry.
 
CameraGetCullCamera () const
 Return the culling camera. If null, the viewport camera will be used for culling (normal case.)
 
Ray GetScreenRay (int x, int y) const
 Return ray corresponding to normalized screen coordinates.
 
IntVector2 WorldToScreenPoint (const Vector3 &worldPos) const
 Convert a world space point to normalized screen coordinates. More...
 
Vector3 ScreenToWorldPoint (int x, int y, float depth) const
 Convert screen coordinates and depth to a world space point. More...
 
void AllocateView ()
 Allocate the view structure. Called by Renderer.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
virtual ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash.
 
virtual const StringGetTypeName () const =0
 Return type name.
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
 
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
 
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
 
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
 
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
 
void SubscribeToEvent (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
void SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to a specific sender's event.
 
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
 
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
 
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
 
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
 
void UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
 Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
 
template<typename... Args>
void SendEvent (StringHash eventType, Args...args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and value.
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
 
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
 
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
 
bool HasEventHandlers () const
 Return whether has subscribed to any event.
 
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
 
const StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
 
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
 
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
 
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
 
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
 
int Refs () const
 Return reference count.
 
int WeakRefs () const
 Return weak reference count.
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Private Member Functions

 URHO3D_OBJECT (Viewport, Object)
 

Private Attributes

WeakPtr< Scenescene_
 Scene pointer.
 
WeakPtr< Cameracamera_
 Camera pointer.
 
WeakPtr< CameracullCamera_
 Culling camera pointer.
 
IntRect rect_
 Viewport rectangle.
 
SharedPtr< RenderPathrenderPath_
 Rendering path.
 
SharedPtr< Viewview_
 Internal rendering structure.
 
bool drawDebug_
 Debug draw flag.
 

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.
 

Detailed Description

Viewport definition either for a render surface or the backbuffer.

Member Function Documentation

Vector3 Urho3D::Viewport::ScreenToWorldPoint ( int  x,
int  y,
float  depth 
) const

Convert screen coordinates and depth to a world space point.

Todo:
This is incorrect if the viewport is used on a texture rendertarget instead of the backbuffer, as it may have different dimensions.

Here is the call graph for this function:

Here is the caller graph for this function:

IntVector2 Urho3D::Viewport::WorldToScreenPoint ( const Vector3 worldPos) const

Convert a world space point to normalized screen coordinates.

Todo:
This is incorrect if the viewport is used on a texture rendertarget instead of the backbuffer, as it may have different dimensions.

Here is the call graph for this function:


The documentation for this class was generated from the following files:
  • Source/Urho3D/Graphics/Viewport.h
  • Source/Urho3D/Graphics/Viewport.cpp