Difference between revisions of "DOMCurveKeyframe"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMCurveKeyframe class)
(Documentation for the DOMCurveKeyframe class)
Line 1: Line 1:
 +
Represents a point in time along a [[DOMCurve]] at which property values can be specified. The values of a [[DOMCurvePlayer]]'s properties which are being projected onto other nodes in the DOM will blend between the values at this node and the "next" keyframe's values. "next" depends on whether the player is looping, running in reverse, etc.
 +
 +
'''See also:''' [[DOM Curves]]
 +
 
*'''Inherits class: [[DOMObject]]'''
 
*'''Inherits class: [[DOMObject]]'''
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMCurveKeyframe Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMCurveKeyframe Remarks|action=edit}} edit]<nowiki>]</nowiki>===
Line 5: Line 9:
 
===Properties===
 
===Properties===
 
:{{CSharp|float Time {get; set;} }}
 
:{{CSharp|float Time {get; set;} }}
 +
::
 +
::The time offset of this keyframe from the beginning of the [[DOMCurve]] animation, in seconds.
  
 
===Events===
 
===Events===
 
:{{CSharp|PlayerCrossed(EventHandler<PlayerCrossedEventArgs>)}}
 
:{{CSharp|PlayerCrossed(EventHandler<PlayerCrossedEventArgs>)}}
 +
::
 +
::Fired when a [[DOMCurvePlayer]] reaches this keyframe
  
 
===Constructors===
 
===Constructors===
 
:{{CSharp|DOMCurveKeyframe()}}
 
:{{CSharp|DOMCurveKeyframe()}}
 +
::
 +
::Constructs a new DOMCurveKeyframe with default settings
  
 
:{{CSharp|DOMCurveKeyframe(DOMObject[] children)}}
 
:{{CSharp|DOMCurveKeyframe(DOMObject[] children)}}
 +
::
 +
::Constructs a new DOMCurveKeyframe, adding children at the same time
  
 
:{{CSharp|DOMCurveKeyframe(string title, DOMObject[] children)}}
 
:{{CSharp|DOMCurveKeyframe(string title, DOMObject[] children)}}
 +
::
 +
::Constructs a new DOMCurveKeyframe, setting a title and adding children at the same time
  
 
===Methods===
 
===Methods===

Revision as of 19:40, 4 April 2017

Represents a point in time along a DOMCurve at which property values can be specified. The values of a DOMCurvePlayer's properties which are being projected onto other nodes in the DOM will blend between the values at this node and the "next" keyframe's values. "next" depends on whether the player is looping, running in reverse, etc.

See also: DOM Curves

Remarks [edit]

Properties

float Time {get; set;}
The time offset of this keyframe from the beginning of the DOMCurve animation, in seconds.

Events

PlayerCrossed(EventHandler<PlayerCrossedEventArgs>)
Fired when a DOMCurvePlayer reaches this keyframe

Constructors

DOMCurveKeyframe()
Constructs a new DOMCurveKeyframe with default settings
DOMCurveKeyframe(DOMObject[] children)
Constructs a new DOMCurveKeyframe, adding children at the same time
DOMCurveKeyframe(string title, DOMObject[] children)
Constructs a new DOMCurveKeyframe, setting a title and adding children at the same time

Methods

bool CheckParent(DOMObject parent)
Called on DOMObject derived types just before they are added to the DOM to ensure their parent is appropriate.