impeller::scene::AnimationClip Class Reference

#include <animation_clip.h>

Public Member Functions
	AnimationClip (std::shared_ptr< Animation > animation, Node *bind_target)
	~AnimationClip ()
	AnimationClip (AnimationClip &&)
AnimationClip &	operator= (AnimationClip &&)
bool	IsPlaying () const
void	SetPlaying (bool playing)
void	Play ()
void	Pause ()
void	Stop ()
bool	GetLoop () const
void	SetLoop (bool looping)
Scalar	GetPlaybackTimeScale () const
void	SetPlaybackTimeScale (Scalar playback_speed)
	Sets the animation playback speed. Negative values make the clip play in reverse.
Scalar	GetWeight () const
void	SetWeight (Scalar weight)
SecondsF	GetPlaybackTime () const
	Get the current playback time of the animation.
void	Seek (SecondsF time)
	Move the animation to the specified time. The given time is clamped to the animation's playback range.
void	Advance (SecondsF delta_time)
	Advance the animation by delta_time seconds. Negative delta_time values do nothing.
void	ApplyToBindings (std::unordered_map< Node *, AnimationTransforms > &transform_decomps, Scalar weight_multiplier) const
	Applies the animation to all binded properties in the scene.

Detailed Description

Definition at line 22 of file animation_clip.h.

Constructor & Destructor Documentation

AnimationClip() [1/2]

impeller::scene::AnimationClip::AnimationClip	(	std::shared_ptr< Animation >	animation,
		Node *	bind_target
	)

Definition at line 17 of file animation_clip.cc.

    : animation_(std::move(animation)) {
  BindToTarget(bind_target);
}

~AnimationClip()

impeller::scene::AnimationClip::~AnimationClip ( )

default

AnimationClip() [2/2]

impeller::scene::AnimationClip::AnimationClip ( AnimationClip &&  )

default

Member Function Documentation

Advance()

void impeller::scene::AnimationClip::Advance

(

SecondsF

delta_time

)

Advance the animation by delta_time seconds. Negative delta_time values do nothing.

Handle looping behavior.

Definition at line 81 of file animation_clip.cc.

                                               {
  if (!playing_ || delta_time <= SecondsF::zero()) {
    return;
  }
  delta_time *= playback_time_scale_;
  playback_time_ += delta_time;
 
  /// Handle looping behavior.
 
  auto end_time = animation_->GetEndTime();
  if (end_time == SecondsF::zero()) {
    playback_time_ = SecondsF::zero();
    return;
  }
  if (!loop_ &&
      (playback_time_ < SecondsF::zero() || playback_time_ > end_time)) {
    // If looping is disabled, clamp to the end (or beginning, if playing in
    // reverse) and pause.
    Pause();
    playback_time_ = std::clamp(playback_time_, SecondsF::zero(), end_time);
  } else if (/* loop && */ playback_time_ > end_time) {
    // If looping is enabled and we ran off the end, loop to the beginning.
    playback_time_ =
        SecondsF(std::fmod(std::abs(playback_time_.count()), end_time.count()));
  } else if (/* loop && */ playback_time_ < SecondsF::zero()) {
    // If looping is enabled and we ran off the beginning, loop to the end.
    playback_time_ =
        end_time -
        SecondsF(std::fmod(std::abs(playback_time_.count()), end_time.count()));
  }
}

ApplyToBindings()

void impeller::scene::AnimationClip::ApplyToBindings	(	std::unordered_map< Node *, AnimationTransforms > &	transform_decomps,
		Scalar	weight_multiplier
	)		const

Applies the animation to all binded properties in the scene.

Definition at line 113 of file animation_clip.cc.

                                    {
  for (auto& binding : bindings_) {
    auto transforms = transform_decomps.find(binding.node);
    if (transforms == transform_decomps.end()) {
      continue;
    }
    binding.channel.resolver->Apply(transforms->second, playback_time_,
                                    weight_ * weight_multiplier);
  }
}

GetLoop()

bool impeller::scene::AnimationClip::GetLoop

(

)

const

Definition at line 49 of file animation_clip.cc.

                                  {
  return loop_;
}

GetPlaybackTime()

SecondsF impeller::scene::AnimationClip::GetPlaybackTime

(

)

const

Get the current playback time of the animation.

Definition at line 73 of file animation_clip.cc.

                                              {
  return playback_time_;
}

GetPlaybackTimeScale()

Scalar impeller::scene::AnimationClip::GetPlaybackTimeScale

(

)

const

Definition at line 57 of file animation_clip.cc.

                                                 {
  return playback_time_scale_;
}

GetWeight()

Scalar impeller::scene::AnimationClip::GetWeight

(

)

const

Definition at line 65 of file animation_clip.cc.

                                      {
  return weight_;
}

IsPlaying()

bool impeller::scene::AnimationClip::IsPlaying

(

)

const

Definition at line 28 of file animation_clip.cc.

                                    {
  return playing_;
}

operator=()

AnimationClip & impeller::scene::AnimationClip::operator= ( AnimationClip &&  )

default

Pause()

void impeller::scene::AnimationClip::Pause

(

)

Definition at line 40 of file animation_clip.cc.

                          {
  SetPlaying(false);
}

Play()

void impeller::scene::AnimationClip::Play

(

)

Definition at line 36 of file animation_clip.cc.

                         {
  SetPlaying(true);
}

Seek()

void impeller::scene::AnimationClip::Seek

(

SecondsF

time

)

Move the animation to the specified time. The given time is clamped to the animation's playback range.

Definition at line 77 of file animation_clip.cc.

                                      {
  playback_time_ = std::clamp(time, SecondsF::zero(), animation_->GetEndTime());
}

SetLoop()

void impeller::scene::AnimationClip::SetLoop

(

bool

looping

)

Definition at line 53 of file animation_clip.cc.

                                        {
  loop_ = looping;
}

SetPlaybackTimeScale()

void impeller::scene::AnimationClip::SetPlaybackTimeScale

(

Scalar

playback_speed

)

Sets the animation playback speed. Negative values make the clip play in reverse.

Definition at line 61 of file animation_clip.cc.

                                                              {
  playback_time_scale_ = playback_speed;
}

SetPlaying()

void impeller::scene::AnimationClip::SetPlaying

(

bool

playing

)

Definition at line 32 of file animation_clip.cc.

                                           {
  playing_ = playing;
}

SetWeight()

void impeller::scene::AnimationClip::SetWeight

(

Scalar

weight

)

Definition at line 69 of file animation_clip.cc.

                                           {
  weight_ = std::max(0.0f, weight);
}

Stop()

void impeller::scene::AnimationClip::Stop

(

)

Definition at line 44 of file animation_clip.cc.

                         {
  SetPlaying(false);
  Seek(SecondsF::zero());
}

---

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

• impeller/scene/animation/animation_clip.h
• impeller/scene/animation/animation_clip.cc