Urho3D
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
Urho3D::Camera Class Reference

Camera component. More...

#include <Camera.h>

Inheritance diagram for Urho3D::Camera:
Urho3D::Component Urho3D::Serializable Urho3D::Object Urho3D::RefCounted

List of all members.

Public Member Functions

 Camera (Context *context)
 Construct.
virtual ~Camera ()
 Destruct.
void SetNearClip (float nearClip)
 Set near clip distance.
void SetFarClip (float farClip)
 Set far clip distance.
void SetFov (float fov)
 Set field of view.
void SetOrthoSize (float orthoSize)
 Set orthographic mode view uniform size.
void SetOrthoSize (const Vector2 &orthoSize)
 Set orthographic mode view size.
void SetAspectRatio (float aspectRatio)
 Set aspect ratio.
void SetFillMode (FillMode mode)
 Set polygon fill mode to use when rendering a scene.
void SetZoom (float zoom)
 Set zoom.
void SetLodBias (float bias)
 Set LOD bias.
void SetViewMask (unsigned mask)
 Set view mask. Will be and'ed with object's view mask to see if the object should be rendered.
void SetViewOverrideFlags (unsigned flags)
 Set view override flags.
void SetOrthographic (bool enable)
 Set orthographic mode enabled/disabled.
void SetAutoAspectRatio (bool enable)
 Set automatic aspect ratio based on viewport dimensions.
void SetProjectionOffset (const Vector2 &offset)
 Set projection offset. It needs to be calculated as (offset in pixels) / (viewport dimensions.)
void SetFlipVertical (bool enable)
 Set vertical flipping mode.
float GetFarClip () const
 Return far clip distance.
float GetNearClip () const
 Return near clip distance.
float GetFov () const
 Return field of view.
float GetOrthoSize () const
 Return orthographic mode size.
float GetAspectRatio () const
 Return aspect ratio.
float GetZoom () const
 Return zoom.
float GetLodBias () const
 Return LOD bias.
unsigned GetViewMask () const
 Return view mask.
unsigned GetViewOverrideFlags () const
 Return view override flags.
FillMode GetFillMode () const
 Return fill mode.
bool IsOrthographic () const
 Return orthographic flag.
bool GetAutoAspectRatio () const
 Return auto aspect ratio flag.
const FrustumGetFrustum () const
 Return frustum in world space.
const Matrix4GetProjection () const
 Return API-specific projection matrix.
Matrix4 GetProjection (bool apiSpecific) const
 Return either API-specific or API-independent (D3D convention) projection matrix.
void GetFrustumSize (Vector3 &near, Vector3 &far) const
 Return frustum near and far sizes.
float GetHalfViewSize () const
 Return half view size.
Frustum GetSplitFrustum (float nearClip, float farClip) const
 Return frustum split by custom near and far clip distances.
Frustum GetViewSpaceFrustum () const
 Return frustum in view space.
Frustum GetViewSpaceSplitFrustum (float nearClip, float farClip) const
 Return split frustum in view space.
Ray GetScreenRay (float x, float y)
 Return ray corresponding to screen coordinates (0.0 to 1.0.)
Vector3 GetForwardVector ()
 Return forward vector.
Vector3 GetRightVector ()
 Return right vector.
Vector3 GetUpVector ()
 Return up vector.
const Vector2GetProjectionOffset () const
 Return projection offset.
bool GetFlipVertical () const
 Return vertical flipping mode.
float GetDistance (const Vector3 &worldPos) const
 Return distance to position. In orthographic mode uses only Z coordinate.
float GetDistanceSquared (const Vector3 &worldPos) const
 Return squared distance to position. In orthographic mode uses only Z coordinate.
float GetLodDistance (float distance, float scale, float bias) const
 Return a scene node's LOD scaled distance.
bool IsProjectionValid () const
 Return if projection parameters are valid for rendering and raycasting.
const Matrix3x4GetInverseWorldTransform () const
 Return inverse world transform, also known as the view matrix.
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 Construct.
virtual ~Component ()
 Destruct.
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute write access.
virtual bool Save (Serializer &dest)
 Save as binary data. Return true if successful.
virtual bool SaveXML (XMLElement &dest)
 Save as XML data. Return true if successful.
virtual void GetDependencyNodes (PODVector< Node * > &dest)
 Return the depended on nodes to order network updates.
virtual void DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
 Visualize the component as debug geometry.
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned GetID () const
 Return ID.
NodeGetNode () const
 Return scene node.
SceneGetScene () const
 Return the scene the node belongs to.
void GetComponents (PODVector< Component * > &dest, ShortStringHash type) const
 Return components in the same scene node by type.
ComponentGetComponent (ShortStringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
template<class T >
void GetComponents (PODVector< T * > &dest) const
 Template version of returning components in the same scene node by type.
void AddReplicationState (ComponentReplicationState *state)
 Add a replication state that is tracking this component.
void PrepareNetworkUpdate ()
 Prepare network update by comparing attributes and marking replication states dirty as necessary.
void CleanupConnection (Connection *connection)
 Clean up all references to a network connection that is about to be removed.
void MarkNetworkUpdate ()
 Mark for attribute check on the next network update.
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 Construct.
virtual ~Serializable ()
 Destruct.
virtual void OnGetAttribute (const AttributeInfo &attr, Variant &dest)
 Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
bool SetAttribute (unsigned index, const Variant &value)
 Set attribute by index. Return true if successfully set.
bool SetAttribute (const String &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
void AllocateNetworkState ()
 Allocate network attribute state.
void WriteInitialDeltaUpdate (Serializer &dest)
 Write initial delta network update.
void WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits)
 Write a delta network update according to dirty attribute bits.
void WriteLatestDataUpdate (Serializer &dest)
 Write a latest data network update.
void ReadDeltaUpdate (Deserializer &source)
 Read and apply a network delta update.
void ReadLatestDataUpdate (Deserializer &source)
 Read and apply a network latest data update.
Variant GetAttribute (unsigned index)
 Return attribute value by index. Return empty if illegal index.
Variant GetAttribute (const String &name)
 Return attribute value by name. Return empty if not found.
unsigned GetNumAttributes () const
 Return number of attributes.
unsigned GetNumNetworkAttributes () const
 Return number of network replication attributes.
const Vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
const Vector< AttributeInfo > * GetNetworkAttributes () const
 Return network replication attribute descriptions, or null if none defined.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual ShortStringHash GetType () const =0
 Return type hash.
virtual const 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.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (ShortStringHash 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.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
- 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.

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object factory.

Protected Member Functions

virtual void OnNodeSet (Node *node)
 Handle node being assigned.
virtual void OnMarkedDirty (Node *node)
 Handle node transform being dirtied.
- Protected Member Functions inherited from Urho3D::Component
void SetID (unsigned id)
 Set ID. Called by Scene.
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.

Private Member Functions

 OBJECT (Camera)

Private Attributes

Matrix3x4 inverseWorld_
 Cached inverse world transform matrix.
Matrix4 projection_
 Cached projection matrix.
Frustum frustum_
 Cached frustum.
bool inverseWorldDirty_
 Inverse world transform dirty flag.
bool projectionDirty_
 Projection matrix dirty flag.
bool frustumDirty_
 Frustum dirty flag.
bool orthographic_
 Orthographic mode flag.
float nearClip_
 Near clip distance.
float farClip_
 Far clip distance.
float fov_
 Field of view.
float orthoSize_
 Orthographic view size.
float aspectRatio_
 Aspect ratio.
float zoom_
 Zoom.
float lodBias_
 LOD bias.
unsigned viewMask_
 View mask.
unsigned viewOverrideFlags_
 View override flags.
FillMode fillMode_
 Fill mode.
Vector2 projectionOffset_
 Projection offset.
bool autoAspectRatio_
 Auto aspect ratio flag.
bool flipVertical_
 Flip vertical flag.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Component
Nodenode_
 Scene node.
unsigned id_
 Unique ID within the scene.
bool networkUpdate_
 Network update queued flag.
- Protected Attributes inherited from Urho3D::Serializable
NetworkStatenetworkState_
 Network attribute state.
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.

Detailed Description

Camera component.


The documentation for this class was generated from the following files: