Inheritance diagram for HPS.AnimationControl:
HPS.SprocketControl HPS.Sprocket HPS.Object

Public Member Functions

 AnimationControl (HPS.View in_view)
 
 AnimationControl (HPS.AnimationControl in_that)
 
override void Dispose ()
 
double GetMillisecondsPerTick ()
 
override HPS.Type ObjectType ()
 
void Play (UInt32 in_start_tick, UInt32 in_end_tick)
 
void Play ()
 
void Resume ()
 
void SetAnimation (HPS.Animation in_animation)
 
void SetAnimations (ulong in_count, HPS.Animation in_animations)
 
void SetAnimations (HPS.Animation[] in_animations)
 
void SetMillisecondsPerTick (double in_duration)
 
bool ShowAnimations (out HPS.Animation[] out_animations)
 
void Stop ()
 
void Undo ()
 
void Wait ()
 
- Public Member Functions inherited from HPS.SprocketControl
override void Dispose ()
 
override HPS.Type ObjectType ()
 
SprocketControl (HPS.SprocketControl in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.SprocketControl
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ AnimationControl() [1/2]

HPS.AnimationControl.AnimationControl ( HPS.View  in_view)
inline

Initializes a control tied to the view in_view.

◆ AnimationControl() [2/2]

HPS.AnimationControl.AnimationControl ( HPS.AnimationControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ GetMillisecondsPerTick()

double HPS.AnimationControl.GetMillisecondsPerTick ( )
inline

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

Returns
The duration in milliseconds.

◆ ObjectType()

override HPS.Type HPS.AnimationControl.ObjectType ( )
inlinevirtual

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).

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

Reimplemented from HPS.Object.

◆ Play() [1/2]

void HPS.AnimationControl.Play ( UInt32  in_start_tick,
UInt32  in_end_tick 
)
inline

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.
If animation playback is already occuring this will throw an InvalidOperationException.
Parameters
in_start_tickThe tick to start playback from.
in_end_tickThe tick to stop playback at.

◆ Play() [2/2]

void HPS.AnimationControl.Play ( )
inline

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.
If animation playback is already occuring this will throw an InvalidOperationException.

◆ Resume()

void HPS.AnimationControl.Resume ( )
inline

Resumes playback that was previously halted with Stop().

◆ SetAnimation()

void HPS.AnimationControl.SetAnimation ( HPS.Animation  in_animation)
inline

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
Parameters
in_animationThe animation to use for playback.

◆ SetAnimations() [1/2]

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

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.
Parameters
in_countThe number of animations that will be associated with this AnimationControl.
in_animationsThe animations to use for playback.

◆ SetAnimations() [2/2]

void HPS.AnimationControl.SetAnimations ( HPS.Animation []  in_animations)
inline

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.
Parameters
in_animationsThe animations to use for playback.

◆ SetMillisecondsPerTick()

void HPS.AnimationControl.SetMillisecondsPerTick ( double  in_duration)
inline

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.
Parameters
in_durationThe duration in milliseconds.

◆ ShowAnimations()

bool HPS.AnimationControl.ShowAnimations ( out HPS.Animation []  out_animations)
inline

Shows the animations that are set on this AnimationControl.

Parameters
out_animationsThe animations that are currently set on this animation control.

◆ Stop()

void HPS.AnimationControl.Stop ( )
inline

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.

◆ Undo()

void HPS.AnimationControl.Undo ( )
inline

Reverts any changes made to the scene by playing animations.

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

◆ Wait()

void HPS.AnimationControl.Wait ( )
inline

Blocks until playback is complete.


The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.AnimationControl.cs