Interface IPlotPointController
This class is responsible for the visual representation of the IPlotPointSequenceData.
Namespace: IdleKit.Framework
Assembly: cs.temp.dll.dll
Syntax
public interface IPlotPointControllerProperties
activeSequence
The current loaded IPlotPointSequenceData and can be or is being Play(IPlotPointSequenceData).
Declaration
IPlotPointSequenceData activeSequence { get; }Property Value
| Type | Description |
|---|---|
| IPlotPointSequenceData |
currentFrameIndex
Return the index of the current IPlotPointFrameData that is being played.
Declaration
int currentFrameIndex { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
isPlaying
Is the IPlotPointController currently playing a IPlotPointSequenceData.
Declaration
bool isPlaying { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
Cleanup()
Clear all the IPlotPointSequenceData and related assets such as IPlotPointFrameData, and IPlotPointAction that were loaded.
Declaration
void Cleanup()Pause()
Pause the IPlotPointController from playing the activeSequence so it can be resumed later with Play(IPlotPointSequenceData).
Declaration
void Pause()Play(IPlotPointSequenceData)
To queue the sequenceData and play the current activeSequence or the
IPlotPointSequenceData that is on top of the queue.
Declaration
void Play(IPlotPointSequenceData sequenceData = null)Parameters
| Type | Name | Description |
|---|---|---|
| IPlotPointSequenceData | sequenceData | The IPlotPointSequenceData to be queued to play. |
Resume()
Resume the IPlotPointController from Pause(). This needs to be called if Pause() is invoked and we wish to enable Play(IPlotPointSequenceData) again.
Declaration
void Resume()SetFrameIndex(Int32)
Set the current IPlotPointFrameData to be played on by providing an index.
Declaration
void SetFrameIndex(int index)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | The index of the IPlotPointFrameData specified in the frameIds |
Stop()
Stop() the IPlotPointController from playing any IPlotPointSequenceData and reset all the parameters of the IPlotPointController that is related to the playback.
Declaration
void Stop()Events
onFramePlayed
The C# event called when activeSequence plays the IPlotPointFrameData.
Declaration
event OnFramePlayed onFramePlayedEvent Type
| Type | Description |
|---|---|
| OnFramePlayed |
onFrameSet
The C# event called when activeSequence sets the IPlotPointFrameData
Declaration
event OnFrameSet onFrameSetEvent Type
| Type | Description |
|---|---|
| OnFrameSet |
onSequenceCompleted
Thw C# event called when activeSequence has finished playback.
Declaration
event OnSequenceCompleted onSequenceCompletedEvent Type
| Type | Description |
|---|---|
| OnSequenceCompleted |
onSequenceEnded
The C# event called when activeSequence playback has been ended with or without finishing playback.
Declaration
event OnSequenceEnded onSequenceEndedEvent Type
| Type | Description |
|---|---|
| OnSequenceEnded |
onSequenceLoaded
The C# event called when activeSequence is loaded and ready to Play(IPlotPointSequenceData)
Declaration
event OnSequenceLoaded onSequenceLoadedEvent Type
| Type | Description |
|---|---|
| OnSequenceLoaded |
onSequenceQueued
The C# event called when a IPlotPointSequenceData is queued with Play(IPlotPointSequenceData)
Declaration
event OnSequenceQueued onSequenceQueuedEvent Type
| Type | Description |
|---|---|
| OnSequenceQueued |
onSequenceStarted
The C# event called when activeSequence playback is started with Play(IPlotPointSequenceData)
Declaration
event OnSequenceStarted onSequenceStartedEvent Type
| Type | Description |
|---|---|
| OnSequenceStarted |