ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Stark::Resources::AnimSkeleton Class Reference

Animates a 3D mesh skeleton. More...

#include <anim.h>

Inheritance diagram for Stark::Resources::AnimSkeleton:
Collaboration diagram for Stark::Resources::AnimSkeleton:

List of all members.

Public Member Functions

 AnimSkeleton (Object *parent, byte subType, uint16 index, const Common::String &name)
virtual ~AnimSkeleton ()
void readData (Formats::XRCReadStream *stream) override
 Deserialize the resource static data and initial state.
void onPostRead () override
 Called when the node's initialization is complete.
void onAllLoaded () override
 Called when the resource sub-tree is entirely loaded.
void onGameLoop () override
 Called once per game loop.
void onExitLocation () override
 Called when exiting a location.
void onPreDestroy () override
 Called before a resource sub-tree is unloaded.
void applyToItem (Item *item) override
 Associate the animation to an Item.
void removeFromItem (Item *item) override
 Dissociate the animation from an item.
VisualgetVisual () override
 Obtain the Visual to be used to render the animation.
uint32 getDuration () const override
 Get the animation typical duration in milliseconds.
void playAsAction (ItemVisual *item) override
 Play the animation as an action for an item.
bool isAtTime (uint32 time) const override
 Checks if the elapsed time since the animation start is greater than a specified duration.
uint32 getMovementSpeed () const override
 Get the anim movement speed in units per seconds.
uint32 getIdleActionFrequency () const override
 Get the chance the animation has to play among other idle actions from the same anim hierarchy.
uint32 getRemainingTime () const override
 Get the duration in milliseconds before the animation loops ends.
uint32 getCurrentTime () const
 Get the position in the animation loop in milliseconds.

Protected Member Functions

void printData () override

Protected Attributes

bool _castsShadow
Common::String _archiveName
Common::String _animFilename
bool _loop
uint32 _movementSpeed
uint32 _idleActionFrequency
uint32 _totalTime
uint32 _currentTime
SkeletonAnim_seletonAnim
VisualActor_visual
ItemVisual_actionItem

Detailed Description

Animates a 3D mesh skeleton.

Definition at line 257 of file anim.h.


Constructor & Destructor Documentation

Stark::Resources::AnimSkeleton::AnimSkeleton ( Object parent,
byte  subType,
uint16  index,
const Common::String name 
)

Definition at line 418 of file anim.cpp.

Stark::Resources::AnimSkeleton::~AnimSkeleton (  )  [virtual]

Definition at line 413 of file anim.cpp.


Member Function Documentation

void Stark::Resources::AnimSkeleton::applyToItem ( Item item  )  [override, virtual]

Associate the animation to an Item.

Reimplemented from Stark::Resources::Anim.

Definition at line 431 of file anim.cpp.

uint32 Stark::Resources::AnimSkeleton::getCurrentTime (  )  const

Get the position in the animation loop in milliseconds.

Definition at line 553 of file anim.cpp.

uint32 Stark::Resources::AnimSkeleton::getDuration (  )  const [override, virtual]

Get the animation typical duration in milliseconds.

Reimplemented from Stark::Resources::Anim.

Definition at line 549 of file anim.cpp.

uint32 Stark::Resources::AnimSkeleton::getIdleActionFrequency (  )  const [override, virtual]

Get the chance the animation has to play among other idle actions from the same anim hierarchy.

Reimplemented from Stark::Resources::Anim.

Definition at line 574 of file anim.cpp.

uint32 Stark::Resources::AnimSkeleton::getMovementSpeed (  )  const [override, virtual]

Get the anim movement speed in units per seconds.

Reimplemented from Stark::Resources::Anim.

Definition at line 545 of file anim.cpp.

uint32 Stark::Resources::AnimSkeleton::getRemainingTime (  )  const [override, virtual]

Get the duration in milliseconds before the animation loops ends.

Reimplemented from Stark::Resources::Anim.

Definition at line 557 of file anim.cpp.

Visual * Stark::Resources::AnimSkeleton::getVisual (  )  [override, virtual]

Obtain the Visual to be used to render the animation.

Implements Stark::Resources::Anim.

Definition at line 462 of file anim.cpp.

bool Stark::Resources::AnimSkeleton::isAtTime ( uint32  time  )  const [override, virtual]

Checks if the elapsed time since the animation start is greater than a specified duration.

Reimplemented from Stark::Resources::Anim.

Definition at line 570 of file anim.cpp.

void Stark::Resources::AnimSkeleton::onAllLoaded (  )  [override, virtual]

Called when the resource sub-tree is entirely loaded.

Allows to load data from other nodes.

Reimplemented from Stark::Resources::Object.

Definition at line 505 of file anim.cpp.

void Stark::Resources::AnimSkeleton::onExitLocation (  )  [override, virtual]

Called when exiting a location.

Reimplemented from Stark::Resources::Object.

Definition at line 530 of file anim.cpp.

void Stark::Resources::AnimSkeleton::onGameLoop (  )  [override, virtual]

Called once per game loop.

Reimplemented from Stark::Resources::Object.

Definition at line 512 of file anim.cpp.

void Stark::Resources::AnimSkeleton::onPostRead (  )  [override, virtual]

Called when the node's initialization is complete.

Allows to load additional data from file.

Reimplemented from Stark::Resources::Object.

Definition at line 496 of file anim.cpp.

void Stark::Resources::AnimSkeleton::onPreDestroy (  )  [override, virtual]

Called before a resource sub-tree is unloaded.

Reimplemented from Stark::Resources::Object.

Definition at line 536 of file anim.cpp.

void Stark::Resources::AnimSkeleton::playAsAction ( ItemVisual item  )  [override, virtual]

Play the animation as an action for an item.

This sets up a callback to the item for when the animation completes.

Reimplemented from Stark::Resources::Anim.

Definition at line 562 of file anim.cpp.

void Stark::Resources::AnimSkeleton::printData (  )  [override, protected, virtual]

Reimplemented from Stark::Resources::Anim.

Definition at line 578 of file anim.cpp.

void Stark::Resources::AnimSkeleton::readData ( Formats::XRCReadStream stream  )  [override, virtual]

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Anim.

Definition at line 466 of file anim.cpp.

void Stark::Resources::AnimSkeleton::removeFromItem ( Item item  )  [override, virtual]

Dissociate the animation from an item.

Reimplemented from Stark::Resources::Anim.

Definition at line 456 of file anim.cpp.


Member Data Documentation

Definition at line 300 of file anim.h.

Definition at line 288 of file anim.h.

Definition at line 287 of file anim.h.

Definition at line 295 of file anim.h.

Definition at line 292 of file anim.h.

Definition at line 290 of file anim.h.

Definition at line 291 of file anim.h.

Definition at line 297 of file anim.h.

Definition at line 294 of file anim.h.

Definition at line 298 of file anim.h.


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


Generated on Sat Jan 12 2019 05:05:18 for ResidualVM by doxygen 1.7.1
curved edge   curved edge