ScummVM API documentation
Public Member Functions | List of all members
Titanic::OSMovie Class Reference
Inheritance diagram for Titanic::OSMovie:
Titanic::CMovie Titanic::ListItem Titanic::CSaveableObject

Public Member Functions

 OSMovie (const CResourceKey &name, CVideoSurface *surface)
 
void play (uint flags, CGameObject *obj) override
 
void play (uint startFrame, uint endFrame, uint flags, CGameObject *obj) override
 
void play (uint startFrame, uint endFrame, uint initialFrame, uint flags, CGameObject *obj) override
 
bool playCutscene (const Rect &drawRect, uint startFrame, uint endFrame) override
 
void pause () override
 
void stop () override
 
void addEvent (int eventId, CGameObject *obj) override
 
void setFrame (uint frameNumber) override
 
bool handleEvents (CMovieEventList &events) override
 
int getFrame () const override
 
const CMovieRangeInfoList * getMovieRangeInfo () const override
 
void setSoundManager (CSoundManager *soundManager) override
 
void setFrameRate (double rate) override
 
void setPlaying (bool playingFlag) override
 
Graphics::ManagedSurface * duplicateTransparency () const override
 
- Public Member Functions inherited from Titanic::CMovie
void removeFromPlayingMovies ()
 
bool isActive () const
 
bool hasVideoFrame ()
 
- Public Member Functions inherited from Titanic::ListItem
void save (SimpleFile *file, int indent) override
 
void load (SimpleFile *file) override
 
- Public Member Functions inherited from Titanic::CSaveableObject
virtual ClassDef * getType () const
 
bool isInstanceOf (const ClassDef *classDef) const
 
virtual void saveHeader (SimpleFile *file, int indent)
 
virtual void saveFooter (SimpleFile *file, int indent)
 

Additional Inherited Members

- Static Public Member Functions inherited from Titanic::CMovie
static void init ()
 
static void deinit ()
 
- Static Public Member Functions inherited from Titanic::CSaveableObject
static void initClassList ()
 
static void freeClassList ()
 
static CSaveableObject * createInstance (const Common::String &name)
 
- Public Attributes inherited from Titanic::CMovie
bool _handled
 
bool _hasVideoFrame
 
- Public Attributes inherited from Titanic::ListItem
 CLASSDEF
 
- Static Public Attributes inherited from Titanic::CMovie
static CMovieList * _playingMovies
 
static CVideoSurface * _movieSurface
 
- Static Public Attributes inherited from Titanic::CSaveableObject
static ClassDef * _type
 
- Protected Member Functions inherited from Titanic::CMovie
void addToPlayingMovies ()
 

Member Function Documentation

◆ play() [1/3]

void Titanic::OSMovie::play ( uint  flags,
CGameObject *  obj 
)
overridevirtual

Starts playing the movie

Implements Titanic::CMovie.

◆ play() [2/3]

void Titanic::OSMovie::play ( uint  startFrame,
uint  endFrame,
uint  flags,
CGameObject *  obj 
)
overridevirtual

Starts playing the movie

Implements Titanic::CMovie.

◆ play() [3/3]

void Titanic::OSMovie::play ( uint  startFrame,
uint  endFrame,
uint  initialFrame,
uint  flags,
CGameObject *  obj 
)
overridevirtual

Starts playing the movie

Implements Titanic::CMovie.

◆ playCutscene()

bool Titanic::OSMovie::playCutscene ( const Rect &  drawRect,
uint  startFrame,
uint  endFrame 
)
overridevirtual

Plays a sub-section of a movie, and doesn't return until either the playback ends or a key has been pressed

Returns
True if the cutscene was not interrupted

Implements Titanic::CMovie.

◆ pause()

void Titanic::OSMovie::pause ( )
overridevirtual

Pauses a movie

Remarks
Acts a workaround for our video decoder, since some movies started as part of a scene load need to be paused until the scene is interactive, or else they get played back too quickly

Implements Titanic::CMovie.

◆ stop()

void Titanic::OSMovie::stop ( )
overridevirtual

Stops the movie

Implements Titanic::CMovie.

◆ addEvent()

void Titanic::OSMovie::addEvent ( int  eventId,
CGameObject *  obj 
)
overridevirtual

Add a playback event

Implements Titanic::CMovie.

◆ setFrame()

void Titanic::OSMovie::setFrame ( uint  frameNumber)
overridevirtual

Set the current frame number

Implements Titanic::CMovie.

◆ handleEvents()

bool Titanic::OSMovie::handleEvents ( CMovieEventList &  events)
overridevirtual

Handle any pending movie events

Implements Titanic::CMovie.

◆ getFrame()

int Titanic::OSMovie::getFrame ( ) const
overridevirtual

Get the current frame number

Implements Titanic::CMovie.

◆ getMovieRangeInfo()

const CMovieRangeInfoList* Titanic::OSMovie::getMovieRangeInfo ( ) const
overridevirtual

Return any movie range info associated with the movie

Implements Titanic::CMovie.

◆ setSoundManager()

void Titanic::OSMovie::setSoundManager ( CSoundManager *  soundManager)
overridevirtual

Set the sound manager reference

Implements Titanic::CMovie.

◆ setFrameRate()

void Titanic::OSMovie::setFrameRate ( double  rate)
overridevirtual

Set the frame rate for the movie

Implements Titanic::CMovie.

◆ setPlaying()

void Titanic::OSMovie::setPlaying ( bool  playingFlag)
overridevirtual

Sets whether the video is playing (versus paused)

Implements Titanic::CMovie.

◆ duplicateTransparency()

Graphics::ManagedSurface* Titanic::OSMovie::duplicateTransparency ( ) const
overridevirtual

Creates a duplicate of the transparency surface

Implements Titanic::CMovie.

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