#include <sprk.h>
|
static const HPS::Type | staticType = HPS::Type::Channel |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
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.
◆ 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.
|
◆ Assign()
void HPS::Channel::Assign |
( |
Channel const & |
in_that | ) |
|
Share the underlying smart-pointer of the Channel source.
- Parameters
-
in_that | The 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
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ GetChannelType()
◆ GetName()
UTF8& HPS::Channel::GetName |
( |
| ) |
const |
◆ GetSampler() [1/2]
Sampler const& HPS::Channel::GetSampler |
( |
| ) |
const |
◆ GetSampler() [2/2]
Sampler& HPS::Channel::GetSampler |
( |
| ) |
|
◆ 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
-
- 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
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ SetSampler()
void HPS::Channel::SetSampler |
( |
Sampler const & |
sampler | ) |
|
The documentation for this class was generated from the following file: