Camera component. More...

#include <Urho3D/Graphics/Camera.h>

Inheritance diagram for Urho3D::Camera:

Classes
struct	CachedProjection
	Cached projection data. More...

struct	CachedViewProj
	Cached view-projection matrix. More...

Public Member Functions
	Camera (Context *context)
	Construct.

	~Camera () override
	Destruct.

void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
	Visualize the component as debug geometry.

void	SetMousePosition (const Vector2 &pos)
	Set current mouse position in normalized coordinates.

const Vector2 &	GetMousePosition () const

bool	HasMousePosition () const

void	SetNearClip (float nearClip)

void	SetFarClip (float farClip)

void	SetFov (float fov)

void	SetOrthoSize (float orthoSize)

void	SetOrthoSize (const Vector2 &orthoSize)
	Set orthographic mode view non-uniform size. Disables the auto aspect ratio -mode.

void	SetAspectRatio (float aspectRatio)

void	SetFillMode (FillMode mode)

void	SetZoom (float zoom)

void	SetLodBias (float bias)

void	SetPrimaryViewMask (unsigned mask)
	Set view mask for primary rendering.

void	SetShadowViewMask (unsigned mask)
	Set view mask for shadow casters.

void	SetViewMask (unsigned mask)
	Set view mask for everything.

void	SetZoneMask (unsigned mask)
	Set zone mask.

void	SetViewOverrideFlags (ViewOverrideFlags flags)

void	SetOrthographic (bool enable)

void	SetAutoAspectRatio (bool enable)

void	SetProjectionOffset (const Vector2 &offset)

void	SetUseReflection (bool enable)

void	SetReflectionPlane (const Plane &plane)

void	SetUseClipping (bool enable)

void	SetClipPlane (const Plane &plane)

void	SetFlipVertical (bool enable)
	Set vertical flipping mode. Called internally by View to resolve OpenGL rendertarget sampling differences.

void	SetProjection (const Matrix4 &projection)

void	SetDrawDebugGeometry (bool enable)
	Set whether to draw the debug geometry when rendering the scene from this camera.

float	GetFarClip () const

float	GetNearClip () const

float	GetFov () const

float	GetOrthoSize () const

float	GetAspectRatio () const

float	GetZoom () const

float	GetLodBias () const

unsigned	GetViewMask () const

unsigned	GetPrimaryViewMask () const
	Return view mask for primary rendering.

unsigned	GetShadowViewMask () const
	Return view mask for shadow casters.

unsigned	GetZoneMask () const
	Return zone mask.

ViewOverrideFlags	GetViewOverrideFlags () const

FillMode	GetFillMode () const

bool	IsOrthographic () const

bool	GetAutoAspectRatio () const

bool	GetDrawDebugGeometry () const
	Return whether to draw the debug geometry when rendering the scene from this camera.

const Frustum &	GetFrustum () const

Matrix4	GetProjection (bool ignoreFlip=false) const

Matrix4	GetGPUProjection (bool ignoreFlip=false) const

Matrix4	GetEffectiveGPUViewProjection (float constantDepthBias) const
	Return effective view-projection matrix with optionally applied depth bias.

const Matrix3x4 &	GetView () const

const Matrix4 &	GetViewProj () const
	Return view-projection matrix.

const Matrix4 &	GetInverseViewProj () const
	Return inverted view-projection matrix.

void	GetFrustumSize (Vector3 &nearSize, Vector3 &farSize) const
	Return frustum near and far sizes. More...

float	GetHalfViewSize () const

Vector2	GetViewSizeAt (float z) const
	Return dimensions of camera frustum at given distance.

Frustum	GetSplitFrustum (float nearClip, float farClip) const
	Return frustum split by custom near and far clip distances.

Frustum	GetViewSpaceFrustum () const

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.

Ray	GetScreenRayFromMouse () const
	Return ray corresponding to current mouse position, 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

bool	GetUseReflection () const

const Plane &	GetReflectionPlane () const

bool	GetUseClipping () const

const Plane &	GetClipPlane () const

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

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.

void	SetZone (Zone *zone)
	Set current zone.

Zone *	GetZone () const
	Return current zone.

const Color &	GetEffectiveAmbientColor () const
	Return effective ambient light color.

float	GetEffectiveAmbientBrightness () const
	Return effective ambient light brightness.

const Color &	GetEffectiveFogColor () const
	Return effective fog color considering current zone.

float	GetEffectiveFogStart () const
	Return effective fog start distance considering current zone.

float	GetEffectiveFogEnd () const
	Return effective fog end distance considering current zone.

Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.

	~Component () override
	Destruct.

virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.

AttributeScopeHint	GetEffectiveScopeHint () const

bool	Save (Serializer &dest) const override
	Save as binary data. Return true if successful.

bool	SaveXML (XMLElement &dest) const override
	Save as XML data. Return true if successful.

bool	SaveJSON (JSONValue &dest) const override
	Save as JSON data. Return true if successful.

virtual void	GetDependencyNodes (ea::vector< Node * > &dest)
	Return the depended on nodes to order network updates.

virtual bool	HasAuxiliaryData () const

virtual void	SerializeAuxiliaryData (Archive &archive)
	Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.

void	SetEnabled (bool enable)

void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.

unsigned	GetID () const

Node *	GetNode () const

Scene *	GetScene () const
	Return the scene the node belongs to.

bool	IsEnabled () const

bool	IsEnabledEffective () const

ea::string	GetFullNameDebug () const
	Return full component name for debugging. Unique for each component in the scene. Slow!

Component *	GetComponent (StringHash 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.

unsigned	GetIndexInParent () const
	Return index of this component in the node.

Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.

	~Serializable () override
	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 ObjectReflection *	GetReflection () const
	Return reflection used for serialization.

virtual const ea::vector< AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.

void	SerializeInBlock (Archive &archive) override
	Serialize content from/to archive. May throw ArchiveException.

void	SerializeInBlock (Archive &archive, bool serializeTemporary)

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 bool	LoadJSON (const JSONValue &source)
	Load from JSON data. Return true if successful.

virtual bool	Load (const ea::string &resourceName)
	Load from binary resource.

virtual bool	LoadXML (const ea::string &resourceName)
	Load from XML resource.

virtual bool	LoadJSON (const ea::string &resourceName)
	Load from JSON resource.

virtual bool	LoadFile (const ea::string &resourceName)
	Load from resource of automatically detected type.

virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.

virtual bool	SaveDefaultAttributes (const AttributeInfo &attr) const
	Return whether should save default-valued attributes into XML. Default false.

bool	SetAttribute (unsigned index, const Variant &value)

bool	SetAttribute (const ea::string &name, const Variant &value)
	Set attribute by name. Return true if successfully set.

void	SetInstanceDefault (bool enable)
	(Internal use) Set instance-level default flag.

void	SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
	(Internal use) Set instance-level default value. Allocate the internal data structure as necessary.

virtual Variant	GetInstanceDefault (const ea::string &name) const
	(Internal use) Get instance-level default value.

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)

Variant	GetAttribute (unsigned index) const

Variant	GetAttribute (const ea::string &name) const
	Return attribute value by name. Return empty if not found.

Variant	GetAttributeDefault (unsigned index) const

Variant	GetAttributeDefault (const ea::string &name) const
	Return attribute default value by name. Return empty if not found.

unsigned	GetNumAttributes () const

void	CopyAttributes (const Serializable *source, bool resetToDefault=true)
	Copy all attributes from another serializable.

SharedPtr< Serializable >	Clone (bool resetToDefault=true) const
	Clone this serializable.

bool	IsTemporary () const

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

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	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

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.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &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 ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

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.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static void	RegisterObject (Context *context)

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Member Functions
void	OnNodeSet (Node previousNode, Node currentNode) override
	Handle node being assigned.

void	OnMarkedDirty (Node *node) override
	Handle node transform being dirtied.

Protected Member Functions inherited from Urho3D::Component
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)

void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.

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.

Private Member Functions
	URHO3D_OBJECT (Camera, Component)

void	UpdateProjection () const
	Recalculate projection matrix.

void	UpdateViewProjectionMatrices () const
	Recalculate view-projection matrices.

Private Attributes
ThreadSafeCache< Matrix3x4 >	cachedView_
	Cached view matrix.

ThreadSafeCache< CachedProjection >	cachedProjection_
	Cached projection data.

ThreadSafeCache< CachedViewProj >	cachedViewProj_
	Cached view-projection matrices.

ThreadSafeCache< Frustum >	cachedFrustum_
	Cached world space frustum.

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	primaryViewMask_ {}
	View mask for primary rendering.

unsigned	shadowViewMask_ {}
	View mask for shadow casters.

unsigned	zoneMask_ {}
	Zone mask.

Zone *	zone_ {}
	Current zone containing camera.

ViewOverrideFlags	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	drawDebugGeometry_ {true}
	Whether to draw debug geometry when rendering from this camera.

Vector2	mousePosition_
	Current normalized mouse position supplied externally.

WeakPtr< Graphics >	graphics_

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

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::Serializable
ea::unique_ptr< VariantMap >	instanceDefaultValues_
	Attribute default value at each instance level.

bool	setInstanceDefault_
	When true, store the attribute value as instance's default value (internal use only).

bool	temporary_
	Temporary flag.

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Camera component.

Member Function Documentation

◆ GetAspectRatio()

float Urho3D::Camera::GetAspectRatio ( ) const

inline

Return aspect ratio.

◆ GetAutoAspectRatio()

bool Urho3D::Camera::GetAutoAspectRatio ( ) const

inline

Return auto aspect ratio flag.

◆ GetClipPlane()

const Plane& Urho3D::Camera::GetClipPlane ( ) const

inline

Return the custom clipping plane.

◆ GetEffectiveWorldTransform()

Matrix3x4 Urho3D::Camera::GetEffectiveWorldTransform ( ) const

Get effective world transform for matrix and frustum calculations including reflection but excluding node scaling.

◆ GetFarClip()

float Urho3D::Camera::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().

◆ GetFillMode()

FillMode Urho3D::Camera::GetFillMode ( ) const

inline

Return fill mode.

◆ GetFov()

float Urho3D::Camera::GetFov ( ) const

inline

Return vertical field of view in degrees.

◆ GetFrustum()

const Frustum & Urho3D::Camera::GetFrustum ( ) const

Return frustum in world space.

◆ GetFrustumSize()

void Urho3D::Camera::GetFrustumSize	(	Vector3 &	nearSize,
		Vector3 &	farSize
	)		const

Return frustum near and far sizes.

◆ GetGPUProjection()

Matrix4 Urho3D::Camera::GetGPUProjection ( bool ignoreFlip = false ) const

Return projection matrix converted to API-specific format for use as a shader parameter.

◆ GetHalfViewSize()

float Urho3D::Camera::GetHalfViewSize ( ) const

Return half view size.

◆ GetLodBias()

float Urho3D::Camera::GetLodBias ( ) const

inline

Return LOD bias.

◆ GetNearClip()

float Urho3D::Camera::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().

◆ GetOrthoSize()

float Urho3D::Camera::GetOrthoSize ( ) const

inline

Return orthographic mode size.

◆ GetProjection()

Matrix4 Urho3D::Camera::GetProjection ( bool ignoreFlip = false ) const

Return projection matrix. It's in D3D convention with depth range 0 - 1.

◆ GetProjectionOffset()

const Vector2& Urho3D::Camera::GetProjectionOffset ( ) const

inline

Return projection offset.

◆ GetReflectionPlane()

const Plane& Urho3D::Camera::GetReflectionPlane ( ) const

inline

Return the reflection plane.

◆ GetUseClipping()

bool Urho3D::Camera::GetUseClipping ( ) const

inline

Return whether is using a custom clipping plane.

◆ GetUseReflection()

bool Urho3D::Camera::GetUseReflection ( ) const

inline

Return whether is using reflection.

◆ GetView()

const Matrix3x4 & Urho3D::Camera::GetView ( ) const

Return view matrix.

◆ GetViewMask()

unsigned Urho3D::Camera::GetViewMask ( ) const

inline

Return view mask.

◆ GetViewOverrideFlags()

ViewOverrideFlags Urho3D::Camera::GetViewOverrideFlags ( ) const

inline

Return view override flags.

◆ GetViewSpaceFrustum()

Frustum Urho3D::Camera::GetViewSpaceFrustum ( ) const

Return frustum in view space.

◆ GetZoom()

float Urho3D::Camera::GetZoom ( ) const

inline

Return zoom.

◆ IsOrthographic()

bool Urho3D::Camera::IsOrthographic ( ) const

inline

Return orthographic flag.

◆ RegisterObject()

void Urho3D::Camera::RegisterObject ( Context * context )

static

Register object factory.

◆ ScreenToWorldPoint()

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.

◆ SetAspectRatio()

void Urho3D::Camera::SetAspectRatio ( float aspectRatio )

Set aspect ratio manually. Disables the auto aspect ratio -mode.

◆ SetAutoAspectRatio()

void Urho3D::Camera::SetAutoAspectRatio ( bool enable )

Set automatic aspect ratio based on viewport dimensions. Enabled by default.

◆ SetClipPlane()

void Urho3D::Camera::SetClipPlane ( const Plane & plane )

Set custom clipping plane in world space.

◆ SetFarClip()

void Urho3D::Camera::SetFarClip ( float farClip )

Set far clip distance.

◆ SetFillMode()

void Urho3D::Camera::SetFillMode ( FillMode mode )

Set polygon fill mode to use when rendering a scene.

◆ SetFov()

void Urho3D::Camera::SetFov ( float fov )

Set vertical field of view in degrees.

◆ SetLodBias()

void Urho3D::Camera::SetLodBias ( float bias )

Set LOD bias.

◆ SetNearClip()

void Urho3D::Camera::SetNearClip ( float nearClip )

Set near clip distance.

◆ SetOrthographic()

void Urho3D::Camera::SetOrthographic ( bool enable )

Set orthographic mode enabled/disabled.

◆ SetOrthoSize()

void Urho3D::Camera::SetOrthoSize ( float orthoSize )

Set orthographic mode view uniform size.

◆ SetProjection()

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.

◆ SetProjectionOffset()

void Urho3D::Camera::SetProjectionOffset ( const Vector2 & offset )

Set projection offset. It needs to be calculated as (offset in pixels) / (viewport dimensions).

◆ SetReflectionPlane()

void Urho3D::Camera::SetReflectionPlane ( const Plane & plane )

Set reflection plane in world space for reflection mode.

◆ SetUseClipping()

void Urho3D::Camera::SetUseClipping ( bool enable )

Set whether to use a custom clip plane.

◆ SetUseReflection()

void Urho3D::Camera::SetUseReflection ( bool enable )

Set reflection mode.

◆ SetViewOverrideFlags()

void Urho3D::Camera::SetViewOverrideFlags ( ViewOverrideFlags flags )

Set view override flags.

◆ SetZoom()

void Urho3D::Camera::SetZoom ( float zoom )

Set zoom.

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

Urho3D/Graphics/Camera.h
Urho3D/Graphics/Camera.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetAspectRatio()

◆ GetAutoAspectRatio()

◆ GetClipPlane()

◆ GetEffectiveWorldTransform()

◆ GetFarClip()

◆ GetFillMode()

◆ GetFov()

◆ GetFrustum()

◆ GetFrustumSize()

◆ GetGPUProjection()

◆ GetHalfViewSize()

◆ GetLodBias()

◆ GetNearClip()

◆ GetOrthoSize()

◆ GetProjection()

◆ GetProjectionOffset()

◆ GetReflectionPlane()

◆ GetUseClipping()

◆ GetUseReflection()

◆ GetView()

◆ GetViewMask()

◆ GetViewOverrideFlags()

◆ GetViewSpaceFrustum()

◆ GetZoom()

◆ IsOrthographic()

◆ RegisterObject()

◆ ScreenToWorldPoint()

◆ SetAspectRatio()

◆ SetAutoAspectRatio()

◆ SetClipPlane()

◆ SetFarClip()

◆ SetFillMode()

◆ SetFov()

◆ SetLodBias()

◆ SetNearClip()

◆ SetOrthographic()

◆ SetOrthoSize()

◆ SetProjection()

◆ SetProjectionOffset()

◆ SetReflectionPlane()

◆ SetUseClipping()

◆ SetUseReflection()

◆ SetViewOverrideFlags()

◆ SetZoom()