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

Displays a Smacker video. More...

#include <anim.h>

Inheritance diagram for Stark::Resources::AnimVideo:
Collaboration diagram for Stark::Resources::AnimVideo:

List of all members.

Public Member Functions

 AnimVideo (Object *parent, byte subType, uint16 index, const Common::String &name)
virtual ~AnimVideo ()
void readData (Formats::XRCReadStream *stream) override
 Deserialize the resource static data and initial state.
void onAllLoaded () override
 Called when the resource sub-tree is entirely loaded.
void onGameLoop () override
 Called once per game loop.
void onEnginePause (bool pause) override
 Called when ResidualVM pauses or resumes the engine.
void saveLoadCurrent (ResourceSerializer *serializer) override
 Persist / restore the resource state.
VisualgetVisual () override
 Obtain the Visual to be used to render the animation.
void playAsAction (ItemVisual *item) override
 Play the animation as an action for an item.
uint32 getDuration () const override
 Get the animation typical duration in milliseconds.
bool isAtTime (uint32 time) const override
 Checks if the elapsed time since the animation start is greater than a specified duration.

Protected Types

typedef Common::Array
< Common::Point
PointArray
typedef Common::Array
< Common::Rect
RectArray

Protected Member Functions

void printData () override
void updateSmackerPosition ()
 Update the position of the video for the current frame.

Protected Attributes

Common::String _smackerFile
Common::String _archiveName
VisualSmacker_smacker
uint32 _width
uint32 _height
PointArray _positions
RectArray _sizes
int32 _frameRateOverride
bool _preload
bool _loop
ItemVisual_actionItem

Detailed Description

Displays a Smacker video.

Definition at line 209 of file anim.h.


Member Typedef Documentation

Definition at line 228 of file anim.h.

Definition at line 229 of file anim.h.


Constructor & Destructor Documentation

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

Definition at line 271 of file anim.cpp.

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

Definition at line 267 of file anim.cpp.


Member Function Documentation

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

Get the animation typical duration in milliseconds.

Reimplemented from Stark::Resources::Anim.

Definition at line 362 of file anim.cpp.

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

Obtain the Visual to be used to render the animation.

Implements Stark::Resources::Anim.

Definition at line 351 of file anim.cpp.

bool Stark::Resources::AnimVideo::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 374 of file anim.cpp.

void Stark::Resources::AnimVideo::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 307 of file anim.cpp.

void Stark::Resources::AnimVideo::onEnginePause ( bool  pause  )  [override, virtual]

Called when ResidualVM pauses or resumes the engine.

Reimplemented from Stark::Resources::Object.

Definition at line 342 of file anim.cpp.

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

Called once per game loop.

Reimplemented from Stark::Resources::Object.

Definition at line 318 of file anim.cpp.

void Stark::Resources::AnimVideo::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 366 of file anim.cpp.

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

Reimplemented from Stark::Resources::Anim.

Definition at line 389 of file anim.cpp.

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

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Anim.

Definition at line 282 of file anim.cpp.

void Stark::Resources::AnimVideo::saveLoadCurrent ( ResourceSerializer serializer  )  [override, virtual]

Persist / restore the resource state.

Called only for active locations

Reimplemented from Stark::Resources::Object.

Definition at line 379 of file anim.cpp.

void Stark::Resources::AnimVideo::updateSmackerPosition (  )  [protected]

Update the position of the video for the current frame.

Definition at line 355 of file anim.cpp.


Member Data Documentation

Definition at line 251 of file anim.h.

Definition at line 237 of file anim.h.

Definition at line 247 of file anim.h.

Definition at line 242 of file anim.h.

Definition at line 249 of file anim.h.

Definition at line 244 of file anim.h.

Definition at line 248 of file anim.h.

Definition at line 245 of file anim.h.

Definition at line 239 of file anim.h.

Definition at line 236 of file anim.h.

Definition at line 241 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