CameraPathGui

Description

sealed class Tinman.AddOns.Components.CameraPathGui

Derived from

Container
IUpdateableGui
IEventListenerGeneric<Component>

Full source code is included in the Tinman 3D SDK download.

A GUI component that allows the user to record and playback a camera path.

The following default Layout settings are defined for CameraPathGui objects:

Public / Constants

Label​Duration

[Localized]
public constant LabelDuration → ("Duration":string)

Label for the camera path duration.

Label​Load

[Localized]
public constant LabelLoad → ("Load":string)

Label of the button to load a camera path.

Label​Loop

[Localized]
public constant LabelLoop → ("Loop":string)

Label of the button to toggle looped playback.

Label​Play

[Localized]
public constant LabelPlay → ("Play":string)

Label of the button to playback the camera path.

Label​Record

[Localized]
public constant LabelRecord → ("Record":string)

Label of the button to record a camera path.

Label​Recording

[Localized]
public constant LabelRecording → ("recording":string)

Label to show instead of the time index while recording.

Label​Recording​Camera​Path

[Localized]
public constant LabelRecordingCameraPath → ("- recording camera path -":string)

Label to show as screen overlay while recording.

Label​Save

[Localized]
public constant LabelSave → ("Save":string)

Label of the button to save the camera path.

Label​Stop

[Localized]
public constant LabelStop → ("Stop":string)

Label of the button to stop playback / recording.

Label​Suspended​Camera​Control

[Localized]
public constant LabelSuspendedCameraControl → ("- no camera control -":string)

Label to show as screen overlay while suspended.

Label​Time

[Localized]
public constant LabelTime → ("Time":string)

Label of the time index display.

Public / Constructors

Camera​Path​Gui

public constructor CameraPathGui → ()

Creates a new instance of CameraPathGui.

Public / Methods

Load

public method Load → ()

Loads the saved camera path from the configured file.

If no file path has been configured (see FilePath), the method returns silently.

IOException

If an I/O error has occurred while loading the camera path file.

Render​Overlay

public method RenderOverlay → (1)

bounds in : Box2I

The terrain view bounds.

Draws an indicator when recording a camera path.

Save

public method Save → ()

Saves the saved camera path to the configured file.

If no file path has been configured (see FilePath), the method returns silently.

IOException

If an I/O error has occurred while saving the camera path file.

Public / Attributes

Camera

public attribute Camera → (get,set)

value : Camera

The camera or null.

The camera to update while path playback.

Camera​Path

public attribute CameraPath → (get)

value : CameraPath

[not-null]
The camera path helper object.

The camera path helper object that is used by this GUI component.

Control

public attribute Control → (get,set)

value : CameraControl

The camera control or null.

The camera control to suspend while path playback.

See also

CameraControl.Suspend

File​Path

public attribute FilePath → (get,set)

value : Path

The file path; null will be resolved to Path.Unknown, other values to their canonical form (see Path.Canonical).

The file path to use for saved camera path.