Inheritance diagram for HPS.Animation:
HPS.Sprocket HPS.Object

Public Member Functions

HPS.Channel AddCameraPositionChannel (string in_name, HPS.PointSampler in_sampler)
 
HPS.Channel AddCameraTargetChannel (string in_name, HPS.PointSampler in_sampler)
 
HPS.Channel AddCameraUpChannel (string in_name, HPS.VectorSampler in_sampler)
 
HPS.Channel AddColorChannel (string in_name, HPS.KeyPath in_target, HPS.RGBColorSampler in_sampler)
 
HPS.Channel AddOpacityChannel (string in_name, HPS.KeyPath in_target, HPS.FloatSampler in_sampler)
 
HPS.Channel AddRotationChannel (string in_name, HPS.KeyPath in_target, HPS.QuaternionSampler in_sampler)
 
HPS.Channel AddScaleChannel (string in_name, HPS.KeyPath in_target, HPS.VectorSampler in_sampler)
 
HPS.Channel AddTranslationChannel (string in_name, HPS.KeyPath in_target, HPS.VectorSampler in_sampler)
 
Animation (HPS.Animation in_that)
 
void Assign (HPS.Animation in_that)
 
void Delete ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Animation in_that)
 
HPS.Channel [] GetChannels ()
 
override int GetHashCode ()
 
string GetName ()
 
override HPS.Type ObjectType ()
 
void RemoveChannel (HPS.Channel in_channel)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
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 ()
 

Static Public Member Functions

static bool operator!= (HPS.Animation a, HPS.Animation b)
 
static bool operator== (HPS.Animation a, HPS.Animation b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The Animation class is used to animate objects in the scene through the creation of one or more Channels. An Animation is owned by a Model, and as such needs to be created through the Model.CreateAnimation function. Animation objects are only valid for playback if they contain one or more Channel objects.

Member Function Documentation

◆ AddCameraPositionChannel()

HPS.Channel HPS.Animation.AddCameraPositionChannel ( string  in_name,
HPS.PointSampler  in_sampler 
)
inline

Creates a Channel suitable for animating the camera's position and adds it to this Animation.

Parameters
in_nameA name used to identify this Channel.
in_samplerA sampler containing Point keyframes, describing the changes to be applied to in_target over time.
Returns
The Channel that was just added to this Animation.

◆ AddCameraTargetChannel()

HPS.Channel HPS.Animation.AddCameraTargetChannel ( string  in_name,
HPS.PointSampler  in_sampler 
)
inline

Creates a Channel suitable for animating the camera's target and adds it to this Animation.

Parameters
in_nameA name used to identify this Channel.
in_samplerA sampler containing Point keyframes, describing the changes to be applied to in_target over time.
Returns
The Channel that was just added to this Animation.

◆ AddCameraUpChannel()

HPS.Channel HPS.Animation.AddCameraUpChannel ( string  in_name,
HPS.VectorSampler  in_sampler 
)
inline

Creates a Channel suitable for animating the camera's up vector and adds it to this Animation.

Parameters
in_nameA name used to identify this Channel.
in_samplerA sampler containing Vector keyframes, describing the changes to be applied to in_target over time.
Returns
The Channel that was just added to this Animation.

◆ AddColorChannel()

HPS.Channel HPS.Animation.AddColorChannel ( string  in_name,
HPS.KeyPath  in_target,
HPS.RGBColorSampler  in_sampler 
)
inline

Creates a Channel suitable for animating the target's color and adds it to this Animation.

Parameters
in_nameA name used to identify this Channel.
in_targetThe segment on which the changes described by this Channel will be applied during the Animation playback.
in_samplerA sampler containing RGBColor keyframes, describing the changes to be applied to in_target over time.
Returns
The Channel that was just added to this Animation.

◆ AddOpacityChannel()

HPS.Channel HPS.Animation.AddOpacityChannel ( string  in_name,
HPS.KeyPath  in_target,
HPS.FloatSampler  in_sampler 
)
inline

Creates a Channel suitable for animating the target's opacity and adds it to this Animation.

Parameters
in_nameA name used to identify this Channel.
in_targetThe segment on which the changes described by this Channel will be applied during the Animation playback.
in_samplerA sampler containing float keyframes, describing the changes to be applied to in_target over time.
Returns
The Channel that was just added to this Animation.

◆ AddRotationChannel()

HPS.Channel HPS.Animation.AddRotationChannel ( string  in_name,
HPS.KeyPath  in_target,
HPS.QuaternionSampler  in_sampler 
)
inline

Creates a Channel suitable for animating the target's rotation and adds it to this Animation.

Parameters
in_nameA name used to identify this Channel.
in_targetThe segment on which the changes described by this Channel will be applied during the Animation playback.
in_samplerA sampler containing Point keyframes, describing the changes to be applied to in_target over time.
Returns
The Channel that was just added to this Animation.

◆ AddScaleChannel()

HPS.Channel HPS.Animation.AddScaleChannel ( string  in_name,
HPS.KeyPath  in_target,
HPS.VectorSampler  in_sampler 
)
inline

Creates a Channel suitable for animating the target's scale and adds it to this Animation.

Parameters
in_nameA name used to identify this Channel.
in_targetThe segment on which the changes described by this Channel will be applied during the Animation playback.
in_samplerA sampler containing Vector keyframes, describing the changes to be applied to in_target over time.
Returns
The Channel that was just added to this Animation.

◆ AddTranslationChannel()

HPS.Channel HPS.Animation.AddTranslationChannel ( string  in_name,
HPS.KeyPath  in_target,
HPS.VectorSampler  in_sampler 
)
inline

Creates a Channel suitable for animating the target's position and adds it to this Animation.

Parameters
in_nameA name used to identify this Channel.
in_targetThe segment on which the changes described by this Channel will be applied during the Animation playback.
in_samplerA sampler containing Point keyframes, describing the changes to be applied to in_target over time.
Returns
The Channel that was just added to this Animation.

◆ Assign()

void HPS.Animation.Assign ( HPS.Animation  in_that)
inline

Share the underlying smart-pointer of the Animation source.

Parameters
in_thatThe Animation source of the assignment.
Returns
A reference to this Animation.

◆ Delete()

void HPS.Animation.Delete ( )
inline

Deletes this Animation.

◆ Equals()

bool HPS.Animation.Equals ( HPS.Animation  in_that)
inline

Check if the source Animation points to the same underlying impl as this Animation.

Parameters
in_thatThe source Animation to compare to this Animation.
Returns
true if the objects reference the same impl, false otherwise.

◆ ObjectType()

override HPS.Type HPS.Animation.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.

◆ RemoveChannel()

void HPS.Animation.RemoveChannel ( HPS.Channel  in_channel)
inline

Removes a Channel from this Animation and deletes it.

Parameters
in_channelThe channel to remove from this Animation.

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