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)
 ~AnimVideo () override
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.
void shouldResetItem (bool resetItem) override
 When this animation is playing as an action should a new animation be chosen for the item as soon as this one completes based on the item's activity? This is true by default, but setting it to false allows scripts to chose precisely the new animation to play, and to start it in the same frame as this one is removed.
void resetItem () override
 Remove this action animation for the item and select a new animation based on the item's current activity.
bool isAtTime (uint32 time) const override
 Checks if the elapsed time since the animation start is greater than a specified duration.
bool isDone () const override
 Is this animation done playing.

Protected Types

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

Protected Member Functions

void printData () override
Common::SeekableReadStreamopenOverrideFile (const Common::String &extension) const
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
bool _done
ItemVisual_actionItem
bool _shouldResetItem

Detailed Description

Displays a Smacker video.

Definition at line 230 of file anim.h.


Member Typedef Documentation

Definition at line 251 of file anim.h.

Definition at line 252 of file anim.h.


Constructor & Destructor Documentation

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

Definition at line 277 of file anim.cpp.

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

Definition at line 273 of file anim.cpp.


Member Function Documentation

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

Obtain the Visual to be used to render the animation.

Implements Stark::Resources::Anim.

Definition at line 408 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 440 of file anim.cpp.

bool Stark::Resources::AnimVideo::isDone (  )  const [inline, override, virtual]

Is this animation done playing.

Only valid for animations started with playAsAction.

Reimplemented from Stark::Resources::Anim.

Definition at line 248 of file anim.h.

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 315 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 400 of file anim.cpp.

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

Called once per game loop.

Reimplemented from Stark::Resources::Object.

Definition at line 366 of file anim.cpp.

Common::SeekableReadStream * Stark::Resources::AnimVideo::openOverrideFile ( const Common::String extension  )  const [protected]

Definition at line 346 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 427 of file anim.cpp.

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

Reimplemented from Stark::Resources::Anim.

Definition at line 455 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 290 of file anim.cpp.

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

Remove this action animation for the item and select a new animation based on the item's current activity.

Reimplemented from Stark::Resources::Anim.

Definition at line 390 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 445 of file anim.cpp.

void Stark::Resources::AnimVideo::shouldResetItem ( bool  resetItem  )  [override, virtual]

When this animation is playing as an action should a new animation be chosen for the item as soon as this one completes based on the item's activity? This is true by default, but setting it to false allows scripts to chose precisely the new animation to play, and to start it in the same frame as this one is removed.

Reimplemented from Stark::Resources::Anim.

Definition at line 423 of file anim.cpp.

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

Update the position of the video for the current frame.

Definition at line 412 of file anim.cpp.


Member Data Documentation

Definition at line 276 of file anim.h.

Definition at line 261 of file anim.h.

Definition at line 274 of file anim.h.

Definition at line 271 of file anim.h.

Definition at line 266 of file anim.h.

Definition at line 273 of file anim.h.

Definition at line 268 of file anim.h.

Definition at line 272 of file anim.h.

Definition at line 277 of file anim.h.

Definition at line 269 of file anim.h.

Definition at line 263 of file anim.h.

Definition at line 260 of file anim.h.

Definition at line 265 of file anim.h.


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


Generated on Sat Mar 23 2019 05:09:08 for ResidualVM by doxygen 1.7.1
curved edge   curved edge