Difference between revisions of "DOMCurvePlayerExtended"
From Virtual World Web Wiki
(Documentation for the DOMCurvePlayerExtended class) |
(Documentation for the DOMCurvePlayerExtended class) |
||
Line 1: | Line 1: | ||
+ | Represents a DOMCurvePlayer in JavaScript | ||
+ | |||
* '''Inherits class: [[DOMObjectExtended]]''' | * '''Inherits class: [[DOMObjectExtended]]''' | ||
* This is a JavaScript visible object | * This is a JavaScript visible object | ||
Line 21: | Line 23: | ||
===Events=== | ===Events=== | ||
:{{CSharp|OnKeyframeCrossed(EventHandler<FlexibleEventArgs>)}} | :{{CSharp|OnKeyframeCrossed(EventHandler<FlexibleEventArgs>)}} | ||
+ | :: | ||
+ | ::Fires when this keyframe is crossed by a player | ||
===Methods=== | ===Methods=== | ||
:{{CSharp|void JumpToKeyframe(DOMCurveKeyframeExtended keyframe)}} | :{{CSharp|void JumpToKeyframe(DOMCurveKeyframeExtended keyframe)}} | ||
+ | :: | ||
+ | ::Sets the time index of the player to that of the specified keyframe, fires the crossed events for the keyframe and player, and stops. | ||
:{{CSharp|void Reset()}} | :{{CSharp|void Reset()}} | ||
+ | :: | ||
+ | ::Stops the player from running and resets it to time index 0.0 by setting the Operation property to "Reset" | ||
:{{CSharp|void Run()}} | :{{CSharp|void Run()}} | ||
+ | :: | ||
+ | ::Starts the player running by setting the Operation property to "Run" | ||
:{{CSharp|void Step(int count)}} | :{{CSharp|void Step(int count)}} | ||
+ | :: | ||
+ | ::Increments the step count by ''count'' and sets the Operation property to "Step". The player will run until it consumes ''count' steps | ||
:{{CSharp|void Stop()}} | :{{CSharp|void Stop()}} | ||
+ | :: | ||
+ | ::Stops the player from running by setting the Operation property to "Stop" | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ |
Revision as of 00:44, 23 October 2016
Represents a DOMCurvePlayer in JavaScript
- Inherits class: DOMObjectExtended
- This is a JavaScript visible object
Remarks [edit]
Properties
- long JumpKeyframeID {get; set;} // Via attribution [[DOMCurvePlayer]]
- bool Loop {get; set;} // Via attribution [[DOMCurvePlayer]]
- DOMCurveOperation Operation {get; set;} // Via attribution [[DOMCurvePlayer]]
- bool Reverse {get; set;} // Via attribution [[DOMCurvePlayer]]
- string Selector {get; set;} // Via attribution [[DOMCurvePlayer]]
- int StepCount {get; set;} // Via attribution [[DOMCurvePlayer]]
- Single Time {get; set;} // Via attribution [[DOMCurvePlayer]]
Events
- OnKeyframeCrossed(EventHandler<FlexibleEventArgs>)
- Fires when this keyframe is crossed by a player
Methods
- void JumpToKeyframe(DOMCurveKeyframeExtended keyframe)
- Sets the time index of the player to that of the specified keyframe, fires the crossed events for the keyframe and player, and stops.
- void Reset()
- Stops the player from running and resets it to time index 0.0 by setting the Operation property to "Reset"
- void Run()
- Starts the player running by setting the Operation property to "Run"
- void Step(int count)
- Increments the step count by count and sets the Operation property to "Step". The player will run until it consumes count' steps
- void Stop()
- Stops the player from running by setting the Operation property to "Stop"