FreeCamera Class

Delta Engine Documentation

A camera that can be moved in any direction and rotated around any axis View code on GitHub

Inheritance Hierarchy

System Object
  DeltaEngine.Entities Entity
    DeltaEngine.Rendering3D.Cameras Camera
      DeltaEngine.Rendering3D.Cameras FreeCamera
        DeltaEngine.Editor.LevelEditor LevelEditorCamera

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 class FreeCamera : Camera

public class FreeCamera : Camera

Public Class FreeCamera 
	Inherits Camera

Public Class FreeCamera 
	Inherits Camera

public ref class FreeCamera : public Camera

public ref class FreeCamera : public Camera

type FreeCamera =  
    class 
        inherit Camera 
    end

type FreeCamera =  
    class 
        inherit Camera 
    end

The FreeCamera type exposes the following members.

Constructors

	Name	Description
	FreeCamera	Initializes a new instance of the FreeCamera class

Top

Methods

	Name	Description
	Add T	(Inherited from Entity.)
	AddTag	View code on GitHub (Inherited from Entity.)
	AdjustPitch	View code on GitHub
	AdjustRoll	View code on GitHub
	AdjustYaw	View code on GitHub
	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	(Inherited from Camera.)
	ForceProjectionMatrixUpdate	(Inherited from Camera.)
	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	(Inherited from Camera.)
	GetCurrentViewMatrix	(Overrides Camera GetCurrentViewMatrix .)
	GetOrDefault T	(Inherited from Entity.)
	GetTags	View code on GitHub (Inherited from Entity.)
	Initialize	View code on GitHub (Inherited from Camera.)
	Move(Vector3D)	View code on GitHub
	Move(Vector3D, Single)
	MoveBackward	View code on GitHub
	MoveDown	View code on GitHub
	MoveForward	View code on GitHub
	MoveLeft	View code on GitHub
	MoveRight	View code on GitHub
	MoveUp	View code on GitHub
	OnViewportSizeChanged	(Inherited from Camera.)
	Remove T	(Inherited from Entity.)
	RemoveTag	View code on GitHub (Inherited from Entity.)
	ResetDefaults	(Overrides Camera ResetDefaults .)
	Rotate
	ScreenPointToRay	(Inherited from Camera.)
	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.)
	WorldToScreenPoint	View code on GitHub (Inherited from Camera.)

Top

Fields

	Name	Description
	components	(Inherited from Entity.)
	window	(Inherited from Camera.)

Top

Properties

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

Top

Remarks

Tests: DeltaEngine.Rendering3D.Tests.Cameras.FreeCameraTests

Examples

12 unit tests call DeltaEngine.Rendering3D.Cameras.FreeCamera

Copy to Clipboard Print

[Test]
public void MoveFreeCamera()
{
    new Grid3D(new Size(100));
    RegisterCommand(Key.J, () => camera.MoveLeft(MoveDistance));
    RegisterCommand(Key.L, () => camera.MoveRight(MoveDistance));
    RegisterCommand(Key.I, () => camera.MoveUp(MoveDistance));
    RegisterCommand(Key.K, () => camera.MoveDown(MoveDistance));
    RegisterCommand(Key.U, () => camera.MoveForward(MoveDistance));
    RegisterCommand(Key.O, () => camera.MoveBackward(MoveDistance));
    RegisterCommand(Key.A, () => camera.AdjustYaw(RotationAngle));
    RegisterCommand(Key.D, () => camera.AdjustYaw(-RotationAngle));
    RegisterCommand(Key.W, () => camera.AdjustPitch(RotationAngle));
    RegisterCommand(Key.S, () => camera.AdjustPitch(-RotationAngle));
    RegisterCommand(Key.Q, () => camera.AdjustRoll(-RotationAngle));
    RegisterCommand(Key.E, () => camera.AdjustRoll(RotationAngle));
}

[Test]
public void MoveFreeCamera()
{
    new Grid3D(new Size(100));
    RegisterCommand(Key.J, () => camera.MoveLeft(MoveDistance));
    RegisterCommand(Key.L, () => camera.MoveRight(MoveDistance));
    RegisterCommand(Key.I, () => camera.MoveUp(MoveDistance));
    RegisterCommand(Key.K, () => camera.MoveDown(MoveDistance));
    RegisterCommand(Key.U, () => camera.MoveForward(MoveDistance));
    RegisterCommand(Key.O, () => camera.MoveBackward(MoveDistance));
    RegisterCommand(Key.A, () => camera.AdjustYaw(RotationAngle));
    RegisterCommand(Key.D, () => camera.AdjustYaw(-RotationAngle));
    RegisterCommand(Key.W, () => camera.AdjustPitch(RotationAngle));
    RegisterCommand(Key.S, () => camera.AdjustPitch(-RotationAngle));
    RegisterCommand(Key.Q, () => camera.AdjustRoll(-RotationAngle));
    RegisterCommand(Key.E, () => camera.AdjustRoll(RotationAngle));
}

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void Move()
{
    camera.Move(Vector3D.UnitX, 1.0f);
    Assert.AreEqual(new Vector3D(1.0f, 5.0f, 5.0f), camera.Position);
}

[Test, CloseAfterFirstFrame]
public void Move()
{
    camera.Move(Vector3D.UnitX, 1.0f);
    Assert.AreEqual(new Vector3D(1.0f, 5.0f, 5.0f), camera.Position);
}

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void AdjustPitch()
{
    camera.AdjustPitch(45.0f);
    Assert.AreEqual(new EulerAngles(45.0f, 0.0f, 0.0f), camera.Rotation.ToEuler());
}

[Test, CloseAfterFirstFrame]
public void AdjustPitch()
{
    camera.AdjustPitch(45.0f);
    Assert.AreEqual(new EulerAngles(45.0f, 0.0f, 0.0f), camera.Rotation.ToEuler());
}