AnimationControl

class HPS.AnimationControl : HPS.SprocketControl 

The AnimationControl class is a smart pointer that is tied to a database object. This control allows you to conduct playback for animations on the associated view.

Public Functions

AnimationControl (HPS.AnimationControl in_that): Initializes a control tied to the same object as in_that.

AnimationControl (HPS.View in_view): Initializes a control tied to the view in_view.

override void Dispose ()

UInt32 GetCurrentTick ()

Gets the current tick of the playback range.

Return:	The current tick.

UInt32 GetEndTick ()

Gets the end tick of the playback range.

Return:	The end tick.

double GetMillisecondsPerTick ()

Gets the duration of time in milliseconds between each tick described by the keyframes of the attached animations.

Return:	The duration in milliseconds.

UInt32 GetStartTick ()

Gets the start tick of the playback range.

Return:	The start tick.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:	The declared type of the object in question, which may differ from the true, underlying type.

HPS.AnimationControl Play ()

Starts playback of the attached animation(s) executing from tick 0 up to the last tick specified by the attached animation(s). Any playback currently stopped on this AnimationControl cannot be resumed after this call.

Warning

If SetAnimations hasn’t been called on this AnimationControl this function will throw an InvalidOperationException.

Warning

If animation playback is already occuring this will throw an InvalidOperationException.

Return:	A reference to this AnimationControl.

HPS.AnimationControl Play (UInt32 in_start_tick)

Starts playback of the attached animation(s) executing from tick 0 up to the last tick specified by the attached animation(s). Any playback currently stopped on this AnimationControl cannot be resumed after this call.

Warning

If SetAnimations hasn’t been called on this AnimationControl this function will throw an InvalidOperationException.

Warning

If animation playback is already occuring this will throw an InvalidOperationException.

Param in_start_tick:
	Optional tick to start playback from default.
Return:	A reference to this AnimationControl.

HPS.AnimationControl Play (UInt32 in_start_tick, UInt32 in_end_tick)

Asynchronously starts playback of the attached animation(s) executing from in_start_tick up to in_end_tick. If in_end_tick is lesser than in_start_tick playback will occur in reverse. Any playback currently stopped on this AnimationControl cannot be resumed after this call.

Warning

If SetAnimations hasn’t been called on this AnimationControl this function will throw an InvalidOperationException.

Warning

If animation playback is already occuring this will throw an InvalidOperationException.

Param in_start_tick:
	The tick to start playback from.
Param in_end_tick:
	The tick to stop playback at.
Return:	A reference to this AnimationControl.

HPS.AnimationControl Resume ()

Resumes playback that was previously halted with Stop().

Return:	A reference to this AnimationControl.

HPS.AnimationControl SetAnimation (HPS.Animation in_animation)

Sets the animation to apply during playback on the view associated with this AnimationControl. This will override any previous animation(s) set on this AnimationControl.

Warning

If animation playback is already occuring this will throw an InvalidOperationException

Param in_animation:
	The animation to use for playback.
Return:	A reference to this AnimationControl.

HPS.AnimationControl SetAnimations (HPS.Animation[] in_animations)

Sets the animations to apply during playback on the view associated with this AnimationControl. Playback of multiple animations will occur simultaneously. This will override any previous animation(s) set on this AnimationControl.

Warning

If animation playback is already occuring this will throw an InvalidOperationException.

Param in_animations:
	The animations to use for playback.
Return:	A reference to this AnimationControl.

HPS.AnimationControl SetAnimations (ulong in_count, HPS.Animation in_animations)

Sets the animations to apply during playback on the view associated with this AnimationControl. Playback of multiple animations will occur simultaneously. This will override any previous animation(s) set on this AnimationControl.

Warning

If animation playback is already occuring this will throw an InvalidOperationException.

Param in_animations:
Param in_count:	The number of animations that will be associated with this AnimationControl.
	The animations to use for playback.
Return:	A reference to this AnimationControl.

HPS.AnimationControl SetMillisecondsPerTick (double in_duration)

Sets the duration of time in milliseconds between each tick described by the keyframes of the attached animations.

Warning

If animation playback is already occuring this will throw an InvalidOperationException.

Param in_duration:
	The duration in milliseconds.
Return:	A reference to this AnimationControl.

bool ShowAnimations (out HPS.Animation[] out_animations)

Shows the animations that are set on this AnimationControl.

Param out_animations:
	The animations that are currently set on this animation control.

HPS.AnimationControl Stop ()

Stops playback. The playback can be resumed later by calling Resume().

Warning

If SetAnimations hasn’t been called on this AnimationControl this function will throw an InvalidOperationException.

Return:	A reference to this AnimationControl.

HPS.AnimationControl Undo ()

Reverts any changes made to the scene by playing animations.

Warning

If animation playback is already occuring this will throw an InvalidOperationException.

Return:	A reference to this AnimationControl.

HPS.AnimationControl Wait ()

Blocks until playback is complete.

Return:	A reference to this AnimationControl.

AnimationControl

Hello! I'm HOOPSY