Jet  v1.3.3
Public Member Functions | Protected Member Functions | List of all members
jet::Animation Class Referenceabstract

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

#include <jet/animation.h>

Inheritance diagram for jet::Animation:
jet::PhysicsAnimation jet::GridFluidSolver2 jet::GridFluidSolver3 jet::ParticleSystemSolver2 jet::ParticleSystemSolver3 jet::GridSmokeSolver2 jet::LevelSetLiquidSolver2 jet::PicSolver2 jet::GridSmokeSolver3 jet::LevelSetLiquidSolver3 jet::PicSolver3 jet::SphSolver2 jet::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()

jet::Animation::Animation ( )

◆ ~Animation()

virtual jet::Animation::~Animation ( )
virtual

Member Function Documentation

◆ onUpdate()

virtual void jet::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 overrride this function and implement its logic for updating the animation state.

◆ update()

void jet::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: