Animation

class HPS.Animation : public HPS.Sprocket

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.

Public Functions

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

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

Param in_name

A name used to identify this Channel.

Param in_sampler

A sampler containing Point keyframes, describing the changes to be applied to in_target over time.

Return

The Channel that was just added to this Animation.

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

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

Param in_name

A name used to identify this Channel.

Param in_sampler

A sampler containing Point keyframes, describing the changes to be applied to in_target over time.

Return

The Channel that was just added to this Animation.

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

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

Param in_name

A name used to identify this Channel.

Param in_sampler

A sampler containing Vector keyframes, describing the changes to be applied to in_target over time.

Return

The Channel that was just added to this Animation.

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

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

Param in_name

A name used to identify this Channel.

Param in_target

The segment on which the changes described by this Channel will be applied during the Animation playback.

Param in_sampler

A sampler containing RGBColor keyframes, describing the changes to be applied to in_target over time.

Return

The Channel that was just added to this Animation.

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

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

Param in_name

A name used to identify this Channel.

Param in_target

The segment on which the changes described by this Channel will be applied during the Animation playback.

Param in_sampler

A sampler containing float keyframes, describing the changes to be applied to in_target over time.

Return

The Channel that was just added to this Animation.

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

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

Param in_name

A name used to identify this Channel.

Param in_target

The segment on which the changes described by this Channel will be applied during the Animation playback.

Param in_sampler

A sampler containing Point keyframes, describing the changes to be applied to in_target over time.

Return

The Channel that was just added to this Animation.

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

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

Param in_name

A name used to identify this Channel.

Param in_target

The segment on which the changes described by this Channel will be applied during the Animation playback.

Param in_sampler

A sampler containing Vector keyframes, describing the changes to be applied to in_target over time.

Return

The Channel that was just added to this Animation.

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

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

Param in_name

A name used to identify this Channel.

Param in_target

The segment on which the changes described by this Channel will be applied during the Animation playback.

Param in_sampler

A sampler containing Point keyframes, describing the changes to be applied to in_target over time.

Return

The Channel that was just added to this Animation.

Animation ()

Animation (HPS.Animation in_that)

void Assign (HPS.Animation in_that)

Share the underlying smart-pointer of the Animation source.

Param in_that

The Animation source of the assignment.

Return

A reference to this Animation.

void Delete ()

Deletes this Animation.

override void Dispose ()

bool Equals (HPS.Animation in_that)

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

Param in_that

The source Animation to compare to this Animation.

Return

true if the objects reference the same impl, false otherwise.

override bool Equals (Object obj)

HPS.Channel[] GetChannels ()

Returns a list of Channels currently associated with this Animation.

Return

a list of Channels currently associated with this Animation.

override int GetHashCode ()

string GetName ()

Returns the name given to this Animation when it was created.

Return

The name of this Animation.

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.

void RemoveChannel (HPS.Channel in_channel)

Removes a Channel from this Animation and deletes it.

Param in_channel

The channel to remove from this Animation.

Public Static Functions

bool operator!= (HPS.Animation a, HPS.Animation b)

bool operator== (HPS.Animation a, HPS.Animation b)