Describes the camera projection and view. More...

Inheritance diagram for SiliconStudio.Paradox.Engine.CameraComponent:

Public Member Functions
	CameraComponent ()
	Create a new CameraComponent instance. More...

	CameraComponent (Entity target, float nearPlane, float farPlane)
	Create a new CameraComponent instance with the provided target, near plane and far plane. More...

CameraComponent	WithEntity (string name)
	Associates an entity with this camera component. More...

void	Calculate (out Matrix projection, out Matrix viewMatrix)
	Calculates the projection matrix and view matrix. More...

Public Member Functions inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
	EntityComponent ()
	Initializes a new instance of the EntityComponent class. More...

Static Public Attributes
static PropertyKey < CameraComponent >	Key = new PropertyKey<CameraComponent>("Key", typeof(CameraComponent))
	The property key of this component. More...

Properties
float	VerticalFieldOfView `[get, set]`
	Gets or sets the vertical field of view. More...

float	NearPlane `[get, set]`
	Gets or sets the near plane distance. More...

float	FarPlane `[get, set]`
	Gets or sets the far plane distance. More...

float	AspectRatio `[get, set]`
	Gets or sets the aspect ratio. More...

Entity	Target `[get, set]`
	Gets or sets the target this camera is pointing to. May be null. More...

Vector3	TargetUp `[get, set]`
	Gets or sets the up direction when using a target (for LookAt). More...

bool	AutoFocus `[get, set]`
	Gets or sets a value indicating whether [auto focus]. More...

float	FocusDistance `[get, set]`
	Gets or sets the focus distance. More...

bool	UseViewMatrix `[get, set]`
	Gets or sets a value indicating whether to use custom ViewMatrix. Default is `false` More...

Matrix	ViewMatrix `[get, set]`
	Gets or sets the local view matrix, only used when UseViewMatrix is `true`. More...

bool	UseProjectionMatrix `[get, set]`
	Gets or sets a value indicating whether to use custom ProjectionMatrix. Default is `false` More...

Matrix	ProjectionMatrix `[get, set]`
	Gets or sets the local projection matrix, only used when UseProjectionMatrix is `true`. More...

Vector3	Position `[get, set]`
	Gets or sets the position. More...

override PropertyKey	DefaultKey `[get]`

Properties inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
Entity	Entity `[get, set]`
	Gets or sets the owner entity. More...

Entity	EnsureEntity `[get]`
	Gets the entity and throws an exception if the entity is null. More...

virtual PropertyKey	DefaultKey `[get]`
	The default key this component is associated to. More...

Properties inherited from SiliconStudio.Core.IContentUrl
string	Url `[get, set]`
	The URL of this asset. More...

Additional Inherited Members
Static Public Member Functions inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
static PropertyKey	GetDefaultKey< T > ()
	Gets the default key for the specified entity component type. More...

Detailed Description

Describes the camera projection and view.

Definition at line 17 of file CameraComponent.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Engine.CameraComponent.CameraComponent ( )

Create a new CameraComponent instance.

Definition at line 29 of file CameraComponent.cs.

SiliconStudio.Paradox.Engine.CameraComponent.CameraComponent	(	Entity	target,
		float	nearPlane,
		float	farPlane
	)

Create a new CameraComponent instance with the provided target, near plane and far plane.

Parameters

target	The entity to use as target.
nearPlane	The near plane value
farPlane	The far plane value

Definition at line 40 of file CameraComponent.cs.

Member Function Documentation

void SiliconStudio.Paradox.Engine.CameraComponent.Calculate	(	out Matrix	projection,
		out Matrix	viewMatrix
	)

Calculates the projection matrix and view matrix.

Parameters

projection	The projection matrix.
viewMatrix	The view matrix.

Definition at line 212 of file CameraComponent.cs.

CameraComponent SiliconStudio.Paradox.Engine.CameraComponent.WithEntity ( string name )

Associates an entity with this camera component.

Parameters

name	The name of entity.

Returns: This CameraComponent.

Definition at line 56 of file CameraComponent.cs.

Member Data Documentation

PropertyKey<CameraComponent> SiliconStudio.Paradox.Engine.CameraComponent.Key = new PropertyKey<CameraComponent>("Key", typeof(CameraComponent))

static

The property key of this component.

Definition at line 24 of file CameraComponent.cs.

Property Documentation

float SiliconStudio.Paradox.Engine.CameraComponent.AspectRatio

getset

Gets or sets the aspect ratio.

The aspect ratio.

Definition at line 101 of file CameraComponent.cs.

bool SiliconStudio.Paradox.Engine.CameraComponent.AutoFocus

getset

Gets or sets a value indicating whether [auto focus].

true if [auto focus]; otherwise, false.

Definition at line 124 of file CameraComponent.cs.

override PropertyKey SiliconStudio.Paradox.Engine.CameraComponent.DefaultKey

get

Definition at line 251 of file CameraComponent.cs.

float SiliconStudio.Paradox.Engine.CameraComponent.FarPlane

getset

Gets or sets the far plane distance.

The far plane distance.

Definition at line 92 of file CameraComponent.cs.

float SiliconStudio.Paradox.Engine.CameraComponent.FocusDistance

getset

Gets or sets the focus distance.

The focus distance.

Definition at line 132 of file CameraComponent.cs.

float SiliconStudio.Paradox.Engine.CameraComponent.NearPlane

getset

Gets or sets the near plane distance.

The near plane distance.

Definition at line 83 of file CameraComponent.cs.

Vector3 SiliconStudio.Paradox.Engine.CameraComponent.Position

getset

Gets or sets the position.

The position.

Definition at line 195 of file CameraComponent.cs.

Matrix SiliconStudio.Paradox.Engine.CameraComponent.ProjectionMatrix

getset

Gets or sets the local projection matrix, only used when UseProjectionMatrix is true.

The local projection matrix.

Definition at line 188 of file CameraComponent.cs.

Entity SiliconStudio.Paradox.Engine.CameraComponent.Target

getset

Gets or sets the target this camera is pointing to. May be null.

The target.

Definition at line 108 of file CameraComponent.cs.

Vector3 SiliconStudio.Paradox.Engine.CameraComponent.TargetUp

getset

Gets or sets the up direction when using a target (for LookAt).

The up direction when using a target (for LookAt).

Definition at line 117 of file CameraComponent.cs.

bool SiliconStudio.Paradox.Engine.CameraComponent.UseProjectionMatrix

getset

Gets or sets a value indicating whether to use custom ProjectionMatrix. Default is false

true if use custom ProjectionMatrix; otherwise, false.

Definition at line 181 of file CameraComponent.cs.

bool SiliconStudio.Paradox.Engine.CameraComponent.UseViewMatrix

getset

Gets or sets a value indicating whether to use custom ViewMatrix. Default is false

true if use custom ViewMatrix; otherwise, false.

Definition at line 167 of file CameraComponent.cs.

float SiliconStudio.Paradox.Engine.CameraComponent.VerticalFieldOfView

getset

Gets or sets the vertical field of view.

The vertical field of view.

Definition at line 74 of file CameraComponent.cs.

Matrix SiliconStudio.Paradox.Engine.CameraComponent.ViewMatrix

getset

Gets or sets the local view matrix, only used when UseViewMatrix is true.

The local view matrix.

Definition at line 174 of file CameraComponent.cs.

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

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/engine/SiliconStudio.Paradox.Engine/Engine/CameraComponent.cs

Public Member Functions

Static Public Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation