Channel

class HPS.Channel : public HPS.Sprocket

The Channel class describes part of an Animation through the use of a Sampler. A Channel is associated to an Animation, and as such needs to be created through one of the Animation.AddChannel functions. Each Channel is specific to a type of animation and targets a specific object in the scene graph.

Public Types

enum ChannelType

The type of Animation described by this Channel.

Values:

Translation

The target of this Channel will be translated in space.

Rotation

The target of this Channel will be rotated.

Scale

The target of this Channel will be scaled.

Color

The color of the target of this Channel will be changed.

Opacity

The opacity of the target of this Channel will be changed.

CameraPosition

The position of the camera present at the target segment will be changed.

CameraTarget

The target of the camera present at the target segment will be changed.

CameraUp

The up vector of the camera present at the target segment will be changed.

Public Functions

void Assign (HPS.Channel in_that)

Share the underlying smart-pointer of the Channel source.

Param in_that

The Channel source of the assignment.

Return

A reference to this Channel.

Channel ()

Channel (HPS.Channel in_that)

override void Dispose ()

bool Equals (HPS.Channel in_that)

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

Param in_that

The source Channel to compare to this Animation.

Return

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

override bool Equals (Object obj)

HPS.Channel.ChannelType GetChannelType ()

Returns the type of Animation which will be performed by this Channel

Return

The Channel Type

override int GetHashCode ()

string GetName ()

Returns the name given to this Channel when it was added to an Animation

Return

The name of this Channel

HPS.Sampler GetSampler ()

Returns the Sampler associated with this Channel

Return

The Sampler associated with this Channel

HPS.KeyPath GetTarget ()

Returns the target of this Channel. If this Channel is being used to animate a camera property this key path will be empty.

Return

The SegmentKey targeted by this Channel

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 SetSampler (HPS.Sampler sampler)

Sets the Sampler associated with this Channel

Public Static Functions

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

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