CubbyFlow::Animation Class Referenceabstract

Abstract base class for animation-related class. More...

#include <Core/Animation/Animation.h>

Inheritance diagram for CubbyFlow::Animation:
CubbyFlow::PhysicsAnimation CubbyFlow::GridFluidSolver2 CubbyFlow::GridFluidSolver3 CubbyFlow::ParticleSystemSolver2 CubbyFlow::ParticleSystemSolver3 CubbyFlow::GridSmokeSolver2 CubbyFlow::LevelSetLiquidSolver2 CubbyFlow::PICSolver2 CubbyFlow::GridSmokeSolver3 CubbyFlow::LevelSetLiquidSolver3 CubbyFlow::PICSolver3 CubbyFlow::SPHSolver2 CubbyFlow::SPHSolver3

Public Member Functions

 Animation ()
 
virtual ~Animation ()
 
void Update (const Frame &frame)
 Updates animation state for given frame. More...
 

Protected Member Functions

virtual void OnUpdate (const Frame &frame)=0
 The implementation of this function should update the animation state for given Frame instance frame. More...
 

Detailed Description

Abstract base class for animation-related class.

This class represents the animation logic in very abstract level. Generally animation is a function of time and/or its previous state. This base class provides a virtual function update() which can be overriden by its sub-classes to implement their own state update logic.

Constructor & Destructor Documentation

◆ Animation()

CubbyFlow::Animation::Animation ( )

◆ ~Animation()

virtual CubbyFlow::Animation::~Animation ( )
virtual

Member Function Documentation

◆ OnUpdate()

virtual void CubbyFlow::Animation::OnUpdate ( const Frame frame)
protectedpure virtual

The implementation of this function should update the animation state for given Frame instance frame.

This function is called from Animation::update when state of this class instance needs to be updated. Thus, the inherited class should override this function and implement its logic for updating the animation state.

◆ Update()

void CubbyFlow::Animation::Update ( const Frame frame)

Updates animation state for given frame.

This function updates animation state by calling Animation::onUpdate function.


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