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

#include <Viewport.h>

Inheritance diagram for Urho3D::Viewport:
Collaboration diagram for Urho3D::Viewport:

Public Member Functions

 Viewport (Context *context)
 Construct with defaults.
 Viewport (Context *context, Scene *scene, Camera *camera, RenderPath *renderPath=0)
 Construct with a full rectangle.
 Viewport (Context *context, Scene *scene, Camera *camera, const IntRect &rect, RenderPath *renderPath=0)
 Construct with a specified rectangle.
 ~Viewport ()
void SetScene (Scene *scene)
 Set scene.
void SetCamera (Camera *camera)
 Set camera.
void SetRect (const IntRect &rect)
 Set rectangle.
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.
SceneGetScene () const
 Return scene.
CameraGetCamera () const
 Return camera.
ViewGetView () const
 Return the internal rendering structure. May be null if the viewport has not been rendered yet.
const IntRectGetRect () const
 Return rectangle.
RenderPathGetRenderPath () const
 Return rendering path.
bool GetDrawDebug () const
 Return whether to draw debug geometry.
Ray GetScreenRay (int x, int y) const
 Return ray corresponding to normalized screen coordinates.
IntVector2 WorldToScreenPoint (const Vector3 &worldPos) const
Vector3 ScreenToWorldPoint (int x, int y, float depth) const
void AllocateView ()
 Allocate the view structure. Called by Renderer.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual Urho3D::StringHash GetType () const =0
 Return type hash.
virtual Urho3D::StringHash GetBaseType () const =0
 Return base class type hash.
virtual const Urho3D::StringGetTypeName () const =0
 Return type name.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
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 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. More...
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
ContextGetContext () const
 Return execution context.
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.
- 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

 OBJECT (Viewport)

Private Attributes

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

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
 Execution context.

Detailed Description

Viewport definition either for a render surface or the backbuffer.

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