Difference between revisions of "DOMCurvePlayer"
From Virtual World Web Wiki
(Documentation for the DOMCurvePlayer class) |
(Documentation for the DOMCurvePlayer class) |
||
Line 7: | Line 7: | ||
:{{CSharp|long JumpKeyframeID {get; set;} }} | :{{CSharp|long JumpKeyframeID {get; set;} }} | ||
+ | :: | ||
+ | ::The ID of the keyframe objet the curve player should snap to on it's next update (If Operation == JumpToKeyframe) | ||
:{{CSharp|bool Loop {get; set;} }} | :{{CSharp|bool Loop {get; set;} }} | ||
+ | :: | ||
+ | ::Whether or not the curve player loops back around to the first keyframe after crossing the last one | ||
:{{CSharp|DOMCurveOperation Operation {get; set;} }} | :{{CSharp|DOMCurveOperation Operation {get; set;} }} | ||
+ | :: | ||
+ | ::Which operation the curve player is currently executing | ||
:{{CSharp|bool Reverse {get; set;} }} | :{{CSharp|bool Reverse {get; set;} }} | ||
+ | :: | ||
+ | ::True if the curve player is playing in reverse | ||
:{{CSharp|string Selector {get; set;} }} | :{{CSharp|string Selector {get; set;} }} | ||
+ | :: | ||
+ | ::The CSS-style selector used to identify the nodes which should be affected by the curve player | ||
+ | |||
+ | :{{CSharp|DOMSelectorViewMode SelectorViewMode {get; set;} }} | ||
+ | :: | ||
+ | ::The CSS-style selector used to identify the nodes which should be affected by the curve player | ||
:{{CSharp|int StepCount {get; set;} }} | :{{CSharp|int StepCount {get; set;} }} | ||
+ | :: | ||
+ | ::The number of keyframe steps the curve player should run for before stopping (If Operation == Step) | ||
:{{CSharp|Single Time {get; set;} }} | :{{CSharp|Single Time {get; set;} }} | ||
+ | :: | ||
+ | ::Returns the curve player's current time index in seconds | ||
===Events=== | ===Events=== | ||
:{{CSharp|KeyframeCrossed(EventHandler<KeyframeCrossedEventArgs>)}} | :{{CSharp|KeyframeCrossed(EventHandler<KeyframeCrossedEventArgs>)}} | ||
+ | :: | ||
+ | ::Fires when a keyframe is crossed by the player | ||
===Constructors=== | ===Constructors=== | ||
:{{CSharp|DOMCurvePlayer()}} | :{{CSharp|DOMCurvePlayer()}} | ||
+ | :: | ||
+ | ::Constructs a new DOMCurvePlayer object | ||
:{{CSharp|DOMCurvePlayer(string title)}} | :{{CSharp|DOMCurvePlayer(string title)}} | ||
+ | :: | ||
+ | ::Constructs a new DOMCurvePlayer object with the specified title | ||
===Methods=== | ===Methods=== | ||
Line 34: | Line 58: | ||
:{{CSharp|void Update()}} | :{{CSharp|void Update()}} | ||
+ | :: | ||
+ | ::Called by the infrastructure to run this curve player. Usually called once per keyframe or update cycle on the server. | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ |
Revision as of 13:39, 24 October 2016
- Inherits class: DOMObject
Remarks [edit]
Properties
- DOMCurve Curve {get;}
- long JumpKeyframeID {get; set;}
- The ID of the keyframe objet the curve player should snap to on it's next update (If Operation == JumpToKeyframe)
- bool Loop {get; set;}
- Whether or not the curve player loops back around to the first keyframe after crossing the last one
- DOMCurveOperation Operation {get; set;}
- Which operation the curve player is currently executing
- bool Reverse {get; set;}
- True if the curve player is playing in reverse
- string Selector {get; set;}
- The CSS-style selector used to identify the nodes which should be affected by the curve player
- DOMSelectorViewMode SelectorViewMode {get; set;}
- The CSS-style selector used to identify the nodes which should be affected by the curve player
- int StepCount {get; set;}
- The number of keyframe steps the curve player should run for before stopping (If Operation == Step)
- Single Time {get; set;}
- Returns the curve player's current time index in seconds
Events
- KeyframeCrossed(EventHandler<KeyframeCrossedEventArgs>)
- Fires when a keyframe is crossed by the player
Constructors
- DOMCurvePlayer()
- Constructs a new DOMCurvePlayer object
- DOMCurvePlayer(string title)
- Constructs a new DOMCurvePlayer object with the specified title
Methods
- bool CheckParent(DOMObject parent)
- Called on DOMObject derived types just before they are added to the DOM to ensure their parent is appropriate.
- void Update()
- Called by the infrastructure to run this curve player. Usually called once per keyframe or update cycle on the server.