Urho3D::Camera Class Reference

Camera component. More...

#include <Urho3D/Graphics/Camera.h>

Inheritance diagram for Urho3D::Camera:

Collaboration diagram for Urho3D::Camera:

Public Member Functions
	Camera (Context *context)
	Construct.
virtual	~Camera ()
	Destruct.
virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Visualize the component as debug geometry.
void	SetNearClip (float nearClip)
	Set near clip distance.
void	SetFarClip (float farClip)
	Set far clip distance.
void	SetFov (float fov)
	Set vertical field of view in degrees.
void	SetOrthoSize (float orthoSize)
	Set orthographic mode view uniform size.
void	SetOrthoSize (const Vector2 &orthoSize)
	Set orthographic mode view non-uniform size. Disables the auto aspect ratio -mode.
void	SetAspectRatio (float aspectRatio)
	Set aspect ratio manually. Disables the auto aspect ratio -mode.
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. Enabled by default.
void	SetProjectionOffset (const Vector2 &offset)
	Set projection offset. It needs to be calculated as (offset in pixels) / (viewport dimensions.)
void	SetUseReflection (bool enable)
	Set reflection mode.
void	SetReflectionPlane (const Plane &plane)
	Set reflection plane in world space for reflection mode.
void	SetUseClipping (bool enable)
	Set whether to use a custom clip plane.
void	SetClipPlane (const Plane &plane)
	Set custom clipping plane in world space.
void	SetFlipVertical (bool enable)
	Set vertical flipping mode. Called internally by View to resolve OpenGL / Direct3D9 rendertarget sampling differences.
void	SetProjection (const Matrix4 &projection)
	Set custom projection matrix, which should be specified in D3D convention with depth range 0 - 1. Disables auto aspect ratio. More...
float	GetFarClip () const
	Return far clip distance. If a custom projection matrix is in use, is calculated from it instead of the value assigned with SetFarClip().
float	GetNearClip () const
	Return near clip distance. If a custom projection matrix is in use, is calculated from it instead of the value assigned with SetNearClip().
float	GetFov () const
	Return vertical field of view in degrees.
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 Frustum &	GetFrustum () const
	Return frustum in world space.
Matrix4	GetProjection () const
	Return projection matrix. It's in D3D convention with depth range 0 - 1.
Matrix4	GetGPUProjection () const
	Return projection matrix converted to API-specific format for use as a shader parameter.
const Matrix3x4 &	GetView () const
	Return view matrix.
void	GetFrustumSize (Vector3 &near, Vector3 &far) const
	Return frustum near and far sizes. More...
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) const
	Return ray corresponding to normalized screen coordinates (0 - 1), with origin on the near clip plane.
Vector2	WorldToScreenPoint (const Vector3 &worldPos) const
	Convert a world space point to normalized screen coordinates (0 - 1).
Vector3	ScreenToWorldPoint (const Vector3 &screenPos) const
	Convert normalized screen coordinates (0 - 1) and distance along view Z axis (in Z coordinate) to a world space point. The distance can not be closer than the near clip plane. More...
const Vector2 &	GetProjectionOffset () const
	Return projection offset.
bool	GetUseReflection () const
	Return whether is using reflection.
const Plane &	GetReflectionPlane () const
	Return the reflection plane.
bool	GetUseClipping () const
	Return whether is using a custom clipping plane.
const Plane &	GetClipPlane () const
	Return the custom clipping plane.
bool	GetFlipVertical () const
	Return vertical flipping mode.
bool	GetReverseCulling () const
	Return whether to reverse culling; affected by vertical flipping and reflection.
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.
Quaternion	GetFaceCameraRotation (const Vector3 &position, const Quaternion &rotation, FaceCameraMode mode, float minAngle=0.0f)
	Return a world rotation for facing a camera on certain axes based on the existing world rotation.
Matrix3x4	GetEffectiveWorldTransform () const
	Get effective world transform for matrix and frustum calculations including reflection but excluding node scaling.
bool	IsProjectionValid () const
	Return if projection parameters are valid for rendering and raycasting.
void	SetAspectRatioInternal (float aspectRatio)
	Set aspect ratio without disabling the "auto aspect ratio" mode. Called internally by View.
void	SetOrthoSizeAttr (float orthoSize)
	Set orthographic size attribute without forcing the aspect ratio.
void	SetReflectionPlaneAttr (const Vector4 &value)
	Set reflection plane attribute.
Vector4	GetReflectionPlaneAttr () const
	Return reflection plane attribute.
void	SetClipPlaneAttr (const Vector4 &value)
	Set clipping plane attribute.
Vector4	GetClipPlaneAttr () const
	Return clipping plane attribute.
Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.
virtual	~Component ()
	Destruct.
virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.
virtual bool	Save (Serializer &dest) const
	Save as binary data. Return true if successful.
virtual bool	SaveXML (XMLElement &dest) const
	Save as XML data. Return true if successful.
virtual bool	SaveJSON (JSONValue &dest) const
	Save as JSON data. Return true if successful.
virtual void	MarkNetworkUpdate ()
	Mark for attribute check on the next network update.
virtual void	GetDependencyNodes (PODVector< Node * > &dest)
	Return the depended on nodes to order network updates.
void	SetEnabled (bool enable)
	Set enabled/disabled state.
void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned	GetID () const
	Return ID.
Node *	GetNode () const
	Return scene node.
Scene *	GetScene () const
	Return the scene the node belongs to.
bool	IsEnabled () const
	Return whether is enabled.
bool	IsEnabledEffective () const
	Return whether is effectively enabled (node is also enabled.)
Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.
void	GetComponents (PODVector< Component * > &dest, StringHash type) const
	Return components in the same scene node by type.
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.
Public Member Functions inherited from Urho3D::Animatable
	Animatable (Context *context)
	Construct.
virtual	~Animatable ()
	Destruct.
virtual bool	LoadXML (const XMLElement &source, bool setInstanceDefault=false)
	Load from XML data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
virtual bool	LoadJSON (const JSONValue &source, bool setInstanceDefault=false)
	Load from JSON data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
void	SetAnimationEnabled (bool enable)
	Set automatic update of animation, default true.
void	SetAnimationTime (float time)
	Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.
void	SetObjectAnimation (ObjectAnimation *objectAnimation)
	Set object animation.
void	SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
	Set attribute animation.
void	SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode)
	Set attribute animation wrap mode.
void	SetAttributeAnimationSpeed (const String &name, float speed)
	Set attribute animation speed.
void	SetAttributeAnimationTime (const String &name, float time)
	Set attribute animation time position manually. Automatic update should be disabled in this case.
void	RemoveObjectAnimation ()
	Remove object animation. Same as calling SetObjectAnimation with a null pointer.
void	RemoveAttributeAnimation (const String &name)
	Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.
bool	GetAnimationEnabled () const
	Return animation enabled.
ObjectAnimation *	GetObjectAnimation () const
	Return object animation.
ValueAnimation *	GetAttributeAnimation (const String &name) const
	Return attribute animation.
WrapMode	GetAttributeAnimationWrapMode (const String &name) const
	Return attribute animation wrap mode.
float	GetAttributeAnimationSpeed (const String &name) const
	Return attribute animation speed.
float	GetAttributeAnimationTime (const String &name) const
	Return attribute animation time position.
void	SetObjectAnimationAttr (const ResourceRef &value)
	Set object animation attribute.
ResourceRef	GetObjectAnimationAttr () const
	Return object animation attribute.
Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.
virtual	~Serializable ()
	Destruct.
virtual void	OnSetAttribute (const AttributeInfo &attr, const Variant &src)
	Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void	OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
	Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual const Vector < AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.
virtual const Vector < AttributeInfo > *	GetNetworkAttributes () const
	Return network replication attribute descriptions, or null if none defined.
virtual bool	Load (Deserializer &source, bool setInstanceDefault=false)
	Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual bool	SaveDefaultAttributes () const
	Return whether should save default-valued attributes into XML. Default false.
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	ResetToDefault ()
	Reset all editable attributes to their default values.
void	RemoveInstanceDefault ()
	Remove instance's default values if they are set previously.
void	SetTemporary (bool enable)
	Set temporary flag. Temporary objects will not be saved.
void	SetInterceptNetworkUpdate (const String &attributeName, bool enable)
	Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.
void	AllocateNetworkState ()
	Allocate network attribute state.
void	WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp)
	Write initial delta network update.
void	WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp)
	Write a delta network update according to dirty attribute bits.
void	WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp)
	Write a latest data network update.
bool	ReadDeltaUpdate (Deserializer &source)
	Read and apply a network delta update. Return true if attributes were changed.
bool	ReadLatestDataUpdate (Deserializer &source)
	Read and apply a network latest data update. Return true if attributes were changed.
Variant	GetAttribute (unsigned index) const
	Return attribute value by index. Return empty if illegal index.
Variant	GetAttribute (const String &name) const
	Return attribute value by name. Return empty if not found.
Variant	GetAttributeDefault (unsigned index) const
	Return attribute default value by index. Return empty if illegal index.
Variant	GetAttributeDefault (const String &name) const
	Return attribute default value by name. Return empty if not found.
unsigned	GetNumAttributes () const
	Return number of attributes.
unsigned	GetNumNetworkAttributes () const
	Return number of network replication attributes.
bool	IsTemporary () const
	Return whether is temporary.
bool	GetInterceptNetworkUpdate (const String &attributeName) const
	Return whether an attribute's network updates are being intercepted.
NetworkState *	GetNetworkState () const
	Return the network attribute state, if allocated.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash.
virtual const String &	GetTypeName () const =0
	Return type name.
virtual const TypeInfo *	GetTypeInfo () 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.
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.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
	Return global variable based on key.
const VariantMap &	GetGlobalVars () const
	Return all global variables.
void	SetGlobalVar (StringHash key, const Variant &value)
	Set global variable with the respective key and value.
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () 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 String &	GetCategory () 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.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory.
Static Public Member Functions inherited from Urho3D::Animatable
static void	RegisterObject (Context *context)
	Register object factory.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

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
virtual void	OnAttributeAnimationAdded ()
	Handle attribute animation added.
virtual void	OnAttributeAnimationRemoved ()
	Handle attribute animation removed.
virtual void	OnSceneSet (Scene *scene)
	Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here.
virtual void	OnNodeSetEnabled (Node *node)
	Handle scene node enabled status changing.
void	SetID (unsigned id)
	Set ID. Called by Scene.
void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.
void	HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData)
	Handle scene attribute animation update event.
Component *	GetFixedUpdateSource ()
	Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
void	DoAutoRemove (AutoRemoveMode mode)
	Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.
Protected Member Functions inherited from Urho3D::Animatable
virtual Animatable *	FindAttributeAnimationTarget (const String &name, String &outName)
	Find target of an attribute animation from object hierarchy by name.
void	SetObjectAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed)
	Set object attribute animation internal.
void	OnObjectAnimationAdded (ObjectAnimation *objectAnimation)
	Handle object animation added.
void	OnObjectAnimationRemoved (ObjectAnimation *objectAnimation)
	Handle object animation removed.
void	UpdateAttributeAnimations (float timeStep)
	Update attribute animations.
bool	IsAnimatedNetworkAttribute (const AttributeInfo &attrInfo) const
	Is animated network attribute.
AttributeAnimationInfo *	GetAttributeAnimationInfo (const String &name) const
	Return attribute animation info.
void	HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData)
	Handle attribute animation added.
void	HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData)
	Handle attribute animation removed.

Private Member Functions
	URHO3D_OBJECT (Camera, Component)
void	UpdateProjection () const
	Recalculate projection matrix.

Private Attributes
Matrix3x4	view_
	Cached view matrix.
Matrix4	projection_
	Cached projection matrix.
Frustum	frustum_
	Cached world space frustum.
bool	viewDirty_
	View matrix dirty flag.
bool	projectionDirty_
	Projection matrix dirty flag.
bool	frustumDirty_
	Frustum dirty flag.
bool	orthographic_
	Orthographic mode flag.
float	projNearClip_
	Cached actual near clip distance.
float	projFarClip_
	Cached actual far clip distance.
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.
Plane	reflectionPlane_
	Reflection plane.
Plane	clipPlane_
	Clipping plane.
Matrix3x4	reflectionMatrix_
	Reflection matrix calculated from the plane.
bool	autoAspectRatio_
	Auto aspect ratio flag.
bool	flipVertical_
	Flip vertical flag.
bool	useReflection_
	Reflection mode enabled flag.
bool	useClipping_
	Use custom clip plane flag.
bool	customProjection_
	Use custom projection matrix flag. Used internally.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Component
Node *	node_
	Scene node.
unsigned	id_
	Unique ID within the scene.
bool	networkUpdate_
	Network update queued flag.
bool	enabled_
	Enabled flag.
Protected Attributes inherited from Urho3D::Animatable
bool	animationEnabled_
	Animation enabled.
SharedPtr< ObjectAnimation >	objectAnimation_
	Animation.
HashSet< const AttributeInfo * >	animatedNetworkAttributes_
	Animated network attribute set.
HashMap< String, SharedPtr < AttributeAnimationInfo > >	attributeAnimationInfos_
	Attribute animation infos.
Protected Attributes inherited from Urho3D::Serializable
UniquePtr< NetworkState >	networkState_
	Network attribute state.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Camera component.

Member Function Documentation

void Urho3D::Camera::GetFrustumSize	(	Vector3 &	near,
		Vector3 &	far
	)		const

Return frustum near and far sizes.

Todo:

Necessary? Explain this

Here is the call graph for this function:

Here is the caller graph for this function:

Vector3 Urho3D::Camera::ScreenToWorldPoint

(

const Vector3 &

screenPos

)

const

Convert normalized screen coordinates (0 - 1) and distance along view Z axis (in Z coordinate) to a world space point. The distance can not be closer than the near clip plane.

Note that a HitDistance() from the camera screen ray is not the same as distance along the view Z axis, as under a perspective projection the ray is likely to not be Z-aligned.

Here is the call graph for this function:

void Urho3D::Camera::SetProjection

(

const Matrix4 &

projection

)

Set custom projection matrix, which should be specified in D3D convention with depth range 0 - 1. Disables auto aspect ratio.

Change any of the standard view parameters (FOV, far clip, zoom etc.) to revert to the standard projection. Note that the custom projection is not serialized or replicated through the network.

Here is the call graph for this function:

---

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

• Source/Urho3D/Graphics/Camera.h
• Source/Urho3D/Graphics/Camera.cpp