CameraPath

Description

sealed class Tinman.Engine.Components.CameraPath

Derived from

SerializableBase abstract
IUpdateableFrameTime

The CameraPath can record and play back the path of a Camera.

Public / Constructors

Camera​Path

2 overloads

public constructor CameraPath1 → ()

Creates a new instance of CameraPath.

public constructor CameraPath2 → (1)

framesPerSecond in : int32

[>0]
Number of frames to record per second.

Creates a new instance of CameraPath.

Public / Methods

Clear

public method Clear → ()

Clears the recorded camera path.

Frame

public method Frame → (2)

timeIndex in : float64

The time index of the frame (see Duration).

camera in : Camera

[not-null]
The camera to update.

Computes a camera path frame.

Play

public method Play → (2)

camera in : Camera

[not-null]
The camera to use for playback.

timeIndex opt : float64 = 0

The time index to start playback.

Begins to play the camera path.

Record

public method Record → (1)

camera in : Camera

[not-null]
The camera to record.

Begins to record a camera path.

Stop

public method Stop → ()

Stops playing resp. recording.

Public / Attributes

Duration

public attribute Duration → (get)

value : float64

[>=0]
The camera path duration, in seconds.

Duration of the camera path.

Is​Playing

public attribute IsPlaying → (get)

value : bool

true if camera path is playing, false if not.

Camera path is currently being played back?

See also

CameraPath.Play
CameraPath.Stop

Is​Recording

public attribute IsRecording → (get)

value : bool

true if camera path is recorded, false if not.

Camera path is currently being recorded?

See also

CameraPath.Record
CameraPath.Stop

Looped

public attribute Looped → (get,set)

value : bool

true to loop playback, false to play once only.

Camera path playback is looped?

Speed

public attribute Speed → (get,set)

value : float64

[>0]
The relative playback speed (1 is normal speed).

Relative playback speed.

Time

public attribute Time → (get,set)

value : float64

The time index, in seconds.

The current camera path time index.

Serialization

Serial​Id

public static readonly attribute SerialId → (ISerialTypeInfo)

Serialization information about this type.