#include <sprk.h>

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

Public Types

enum  ChannelType {
ChannelType::Translation, ChannelType::Rotation, ChannelType::Scale, ChannelType::Color,
ChannelType::Opacity, ChannelType::CameraPosition, ChannelType::CameraTarget, ChannelType::CameraUp
}


 

Public Member Functions

void Assign (Channel const &in_that)
 
Channel (Channel const &in_that)
 
bool Equals (Channel const &in_that) const
 
ChannelType GetChannelType () const
 
UTF8GetName () const
 
Sampler const & GetSampler () const
 
SamplerGetSampler ()
 
KeyPath const & GetTarget () const
 
HPS::Type ObjectType () const
 
bool operator!= (Channel const &in_that) const
 
Channeloperator= (Channel const &in_that)
 
Channeloperator= (Channel &&in_that)
 
bool operator== (Channel const &in_that) const
 
void SetSampler (Sampler const &sampler)
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::Channel
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

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 ( Channel const &  in_that)

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 ( Channel const &  in_that) const

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

ChannelType HPS::Channel::GetChannelType ( ) const

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

Returns
The Channel Type

◆ GetName()

UTF8& HPS::Channel::GetName ( ) const

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

Returns
The name of this Channel

◆ GetSampler() [1/2]

Sampler const& HPS::Channel::GetSampler ( ) const

Returns the Sampler associated with this Channel

Returns
The Sampler associated with this Channel

◆ GetSampler() [2/2]

Sampler& HPS::Channel::GetSampler ( )

Returns the Sampler associated with this Channel

Returns
The Sampler associated with this Channel

◆ GetTarget()

KeyPath const& HPS::Channel::GetTarget ( ) const

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

HPS::Type HPS::Channel::ObjectType ( ) const
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.

◆ operator!=()

bool HPS::Channel::operator!= ( Channel const &  in_that) const

Check if the source Channel points to a different impl than this Channel.

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

◆ operator==()

bool HPS::Channel::operator== ( Channel const &  in_that) const

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

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

◆ SetSampler()

void HPS::Channel::SetSampler ( Sampler const &  sampler)

Sets the Sampler associated with this Channel

Parameters
in_thatThe source Sampler to use.

The documentation for this class was generated from the following file: