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

Public Types

enum  ChannelType {
ChannelType.Translation = 0, ChannelType.Rotation = 1, ChannelType.Scale = 2, ChannelType.Color = 3,
ChannelType.Opacity = 4, ChannelType.CameraPosition = 5, ChannelType.CameraTarget = 6, ChannelType.CameraUp = 7
}


 

Public Member Functions

void Assign (HPS.Channel in_that)
 
Channel (HPS.Channel in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Channel in_that)
 
HPS.Channel.ChannelType GetChannelType ()
 
override int GetHashCode ()
 
string GetName ()
 
HPS.Sampler GetSampler ()
 
HPS.KeyPath GetTarget ()
 
override HPS.Type ObjectType ()
 
void SetSampler (HPS.Sampler sampler)
 
- 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.Channel a, HPS.Channel b)
 
static bool operator== (HPS.Channel a, HPS.Channel 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 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.

Member Enumeration Documentation

◆ ChannelType

The type of Animation described by this Channel.

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

Member Function Documentation

◆ Assign()

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

Share the underlying smart-pointer of the Channel source.

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

◆ Equals()

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

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

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

◆ GetChannelType()

HPS.Channel.ChannelType HPS.Channel.GetChannelType ( )
inline

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

Returns
The Channel Type

◆ GetName()

string HPS.Channel.GetName ( )
inline

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

Returns
The name of this Channel

◆ GetSampler()

HPS.Sampler HPS.Channel.GetSampler ( )
inline

Returns the Sampler associated with this Channel

Returns
The Sampler associated with this Channel

◆ GetTarget()

HPS.KeyPath HPS.Channel.GetTarget ( )
inline

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

Returns
The SegmentKey targeted by this Channel

◆ ObjectType()

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

◆ SetSampler()

void HPS.Channel.SetSampler ( HPS.Sampler  sampler)
inline

Sets the Sampler associated with this Channel


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