PathCamera Class

Delta Engine Documentation

Follows a path as if on rails. Can be started and stopped. Updates at 60fps View code on GitHub

Inheritance Hierarchy

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

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 sealed class PathCamera : Camera, 
	RapidUpdateable

public sealed class PathCamera : Camera, 
	RapidUpdateable

Public NotInheritable Class PathCamera 
	Inherits Camera 
	Implements RapidUpdateable

Public NotInheritable Class PathCamera 
	Inherits Camera 
	Implements RapidUpdateable

public ref class PathCamera sealed : public Camera, 
	RapidUpdateable

public ref class PathCamera sealed : public Camera, 
	RapidUpdateable

[<SealedAttribute>]
type PathCamera =  
    class 
        inherit Camera 
        interface RapidUpdateable 
    end

[<SealedAttribute>]
type PathCamera =  
    class 
        inherit Camera 
        interface RapidUpdateable 
    end

The PathCamera type exposes the following members.

Constructors

	Name	Description
	PathCamera(Device, Window)	Initializes a new instance of the PathCamera class
	PathCamera(Device, Window, CameraPath)	Initializes a new instance of the PathCamera 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	(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.)
	OnViewportSizeChanged	(Inherited from Camera.)
	RapidUpdate
	Remove T	(Inherited from Entity.)
	RemoveTag	View code on GitHub (Inherited from Entity.)
	ResetDefaults	(Overrides Camera ResetDefaults .)
	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
	CurrentFrame	View code on GitHub
	FarPlane	(Inherited from Camera.)
	FieldOfView	(Inherited from Camera.)
	IsActive	View code on GitHub (Inherited from Entity.)
	IsMoving	View code on GitHub
	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.)
	UpdatePriority	View code on GitHub (Inherited from Entity.)

Top

Remarks

Tests: DeltaEngine.Rendering3D.Tests.Cameras.PathCameraTests

Examples

10 unit tests call DeltaEngine.Rendering3D.Cameras.PathCamera

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void ThrowExceptionIfNoTrackPositionIsSpecified()
{
    Assert.Throws<PathCamera.NoTrackSpecified>(() => CreatePathCamera(null));
    Assert.Throws<PathCamera.NoTrackSpecified>(() => CreatePathCamera(new Matrix[0]));
    Assert.Throws<PathCamera.NoTrackSpecified>(() => CreatePathCamera(new[] { Matrix.Identity }));
}

[Test, CloseAfterFirstFrame]
public void ThrowExceptionIfNoTrackPositionIsSpecified()
{
    Assert.Throws<PathCamera.NoTrackSpecified>(() => CreatePathCamera(null));
    Assert.Throws<PathCamera.NoTrackSpecified>(() => CreatePathCamera(new Matrix[0]));
    Assert.Throws<PathCamera.NoTrackSpecified>(() => CreatePathCamera(new[] { Matrix.Identity }));
}

Copy to Clipboard Print

[Test]
public void CameraCanBeMovedOnLinearTrackWithScrollWheel()
{
    new Grid3D(new Size(GridDimension));
    PathCamera camera = CreatePathCamera(GetLinearViewMatrixTrack(GridDimension));
    Command.Register(Command.Zoom, new MouseZoomTrigger());
    new Command(Command.Zoom, zoomAmount => camera.CurrentFrame += (int)(zoomAmount * 10));
}

[Test]
public void CameraCanBeMovedOnLinearTrackWithScrollWheel()
{
    new Grid3D(new Size(GridDimension));
    PathCamera camera = CreatePathCamera(GetLinearViewMatrixTrack(GridDimension));
    Command.Register(Command.Zoom, new MouseZoomTrigger());
    new Command(Command.Zoom, zoomAmount => camera.CurrentFrame += (int)(zoomAmount * 10));
}

Copy to Clipboard Print

[Test]
public void AutomatedCameraMoveOnLinearTrackOnMiddleClick()
{
    var linearTrack = GetLinearViewMatrixTrack(GridDimension);
    MoveCameraAutomatedOnTrack(linearTrack);
}

[Test]
public void AutomatedCameraMoveOnLinearTrackOnMiddleClick()
{
    var linearTrack = GetLinearViewMatrixTrack(GridDimension);
    MoveCameraAutomatedOnTrack(linearTrack);
}