Camera Class

Delta Engine Documentation

Provides some useful constants and properties that are commonly used in most camera classes. The current camera can be assigned using Camera.Use. View code on GitHub

Inheritance Hierarchy

System Object
  DeltaEngine.Entities Entity
    DeltaEngine.Rendering3D.Cameras Camera
      DeltaEngine.Rendering3D.Cameras FreeCamera
      DeltaEngine.Rendering3D.Cameras PathCamera
      DeltaEngine.Rendering3D.Cameras TargetedCamera

Namespace: DeltaEngine.Rendering3D.Cameras
Assembly: DeltaEngine.Rendering3D (in DeltaEngine.Rendering3D.dll) Version: 1.1.1.0 (1.1.1)

Syntax

C++

Copy to Clipboard Print

public abstract class Camera : Entity

public abstract class Camera : Entity

Public MustInherit Class Camera 
	Inherits Entity

Public MustInherit Class Camera 
	Inherits Entity

public ref class Camera abstract : public Entity

public ref class Camera abstract : public Entity

[<AbstractClassAttribute>]
type Camera =  
    class 
        inherit Entity 
    end

[<AbstractClassAttribute>]
type Camera =  
    class 
        inherit Entity 
    end

The Camera type exposes the following members.

Constructors

	Name	Description
	Camera	Initializes a new instance of the Camera class

Top

Methods

	Name	Description
	Add T	(Inherited from Entity.)
	AddTag	View code on GitHub (Inherited from Entity.)
	ClearTags	View code on GitHub (Inherited from Entity.)
	Contains T	(Inherited from Entity.)
	ContainsBehavior T	(Inherited from Entity.)
	ContainsTag	View code on GitHub (Inherited from Entity.)
	Deactivate	(Inherited from Entity.)
	Dispose	Releases all resources used by the Camera (Overrides Entity Dispose .)
	ForceProjectionMatrixUpdate
	Get T	Gets a specific component, derived classes can return faster cached values (e.g. Entity2D) View code on GitHub (Inherited from Entity.)
	GetActiveBehaviors	(Inherited from Entity.)
	GetComponentsForSaving	(Inherited from Entity.)
	GetCurrentProjectionMatrix
	GetCurrentViewMatrix
	GetOrDefault T	(Inherited from Entity.)
	GetTags	View code on GitHub (Inherited from Entity.)
	Initialize	View code on GitHub
	OnViewportSizeChanged
	Remove T	(Inherited from Entity.)
	RemoveTag	View code on GitHub (Inherited from Entity.)
	ResetDefaults
	ScreenPointToRay
	Set	View code on GitHub (Inherited from Entity.)
	SetComponents	(Inherited from Entity.)
	Start T	(Inherited from Entity.)
	Stop T	(Inherited from Entity.)
	ToString	View code on GitHub (Inherited from Entity.)
	Use T
	WorldToScreenPoint	View code on GitHub

Top

Fields

	Name	Description
	components	(Inherited from Entity.)
	DefaultFarPlane
	DefaultFieldOfView
	DefaultNearPlane
	window

Top

Properties

	Name	Description
	Current
	FarPlane
	FieldOfView
	IsActive	View code on GitHub (Inherited from Entity.)
	IsInitialized	View code on GitHub
	IsPauseable	View code on GitHub (Inherited from Entity.)
	NearPlane
	NumberOfComponents	View code on GitHub (Inherited from Entity.)
	Position	View code on GitHub
	UpdatePriority	View code on GitHub (Inherited from Entity.)

Top

Remarks

Tests: DeltaEngine.Rendering3D.Tests.Cameras.CameraTests

Examples

2 unit tests call DeltaEngine.Rendering3D.Cameras.Camera

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void AfterSetupACameraTheAmbientContextShouldBeInitialized()
{
    Assert.IsTrue(Camera.IsInitialized);
}

[Test, CloseAfterFirstFrame]
public void AfterSetupACameraTheAmbientContextShouldBeInitialized()
{
    Assert.IsTrue(Camera.IsInitialized);
}

Copy to Clipboard Print

[Test, ApproveFirstFrameScreenshot]
public void CameraShouldBeAbleToHandleViewportChanges()
{
    new Grid3D(new Size(5));
    usedDevice = Resolve<Device>();
    usedWindow = Resolve<Window>();
    Matrix originalProjectionMatrix = usedDevice.CameraProjectionMatrix;
    usedWindow.ViewportPixelSize = new Size(400, 300);
    usedDevice.Set3DMode();
    Assert.AreNotEqual(originalProjectionMatrix, usedDevice.CameraProjectionMatrix);
}

[Test, ApproveFirstFrameScreenshot]
public void CameraShouldBeAbleToHandleViewportChanges()
{
    new Grid3D(new Size(5));
    usedDevice = Resolve<Device>();
    usedWindow = Resolve<Window>();
    Matrix originalProjectionMatrix = usedDevice.CameraProjectionMatrix;
    usedWindow.ViewportPixelSize = new Size(400, 300);
    usedDevice.Set3DMode();
    Assert.AreNotEqual(originalProjectionMatrix, usedDevice.CameraProjectionMatrix);
}