class CameraPath in Tinman.AddOns.Components

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

sealed class	CameraPath	implements	IUpdateableFrameTime
		extends	SerializableBase

Serialization

SerialId

Serialization information about this type.

public static readonly field	SerialId
type	ISerialTypeInfo

Public / Attributes

Duration

Duration of the camera path.

public property	Duration { get }
type	float64
value	[>=0]	The camera path duration, in seconds.

IsPlaying

Camera path is currently being played back?

public property	IsPlaying { get }
type	bool
value		true if camera path is playing, false if not.

See also:

Play
Stop

IsRecording

Camera path is currently being recorded?

public property	IsRecording { get }
type	bool
value		true if camera path is recorded, false if not.

See also:

Record
Stop

Looped

Camera path playback is looped?

public property	Looped { get set }
type	bool
value		true to loop playback, false to play once only.

SerialType

Returns the serial type of this object.

public property	SerialType { get }
type	ISerialTypeInfo
value	[not-null]	The serial type.
inherited	SerializableBase.SerialType

SerialVersion

Returns the serial data version.

public virtual property	SerialVersion { get }
type	int32
value	[>=1]	The serial data version tag.
inherited	SerializableBase.SerialVersion

Remarks:

An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.

See also:

ISerializable.Serialize
ISerializable.Deserialize

Speed

Relative playback speed.

public property	Speed { get set }
type	float64
value	[>0]	The relative playback speed (1 is normal speed).

Time

The current camera path time index.

public property	Time { get set }
type	float64
value		The time index, in seconds.

Public / Constructors

CameraPath

Creates a new instance of CameraPath.

public constructor

CameraPath ()

---

Creates a new instance of CameraPath.

public constructor	CameraPath (int32 framesPerSecond)
params	framesPerSecond	[>0]	Number of frames to record per second. Defaults to 2.

Public / Methods

Clear

Clears the recorded camera path.

public method

Clear ()

Deserialize

Initializes the state of this object from the given data stream.

public override method	Deserialize (int32 serialVersion, ISerializer data)
type	ISerializable
params	serialVersion	[>=1]	The serial data version.
	data	[not-null]	The serial data stream.
returns		[not-null]	The deserialized object. This will typically be this, but in some circumstances, another instance may be returned (e.g. singletons).
overrides	SerializableBase.Deserialize

Remarks:

The Deserialize method will be called immediately after the object has been instantiated via its default constructor.

The provided serialVersion number is guaranteed to be equal to or less than the SerialVersion returned by this object (i.e. ISerializable object must provide backwards compatibility).

See also:

ISerializable.Serialize
ISerializable.SerialVersion

Frame

Computes a camera path frame.

public method	Frame (float64 timeIndex, Camera camera)
params	timeIndex		The time index of the frame (see Duration).
	camera	[not-null]	The camera to update.

Play

Begins to play the camera path.

public method	Play (Camera camera, float64 timeIndex = 0)
params	camera	[not-null]	The camera to use for playback.
	timeIndex		The time index to start playback. Defaults to 0.

Record

Begins to record a camera path.

public method	Record (Camera camera)
params	camera	[not-null]	The camera to record.

Serialize

Serializes the current state of this object to the given data stream.

public override method	Serialize (ISerializer data)
params	data	[not-null]	The serial data stream.
overrides	SerializableBase.Serialize

See also:

ISerializable.Deserialize
ISerializable.SerialVersion

Stop

Stops playing resp. recording.

public method

Stop ()

UpdateFrameTime

This method is called once per application frame.

public method	UpdateFrameTime (float32 time)
type	bool
params	time	[>0]	The amount of time that has elapsed since the last frame, in seconds.
returns			true if the object needs to be presented again, false if the current presentation is still valid.
implements	IUpdateableFrameTime.UpdateFrameTime