Titanic::CMovie Class Reference

Inheritance diagram for Titanic::CMovie:

Public Member Functions
virtual void	play (uint flags, CGameObject *obj)=0
virtual void	play (uint startFrame, uint endFrame, uint flags, CGameObject *obj)=0
virtual void	play (uint startFrame, uint endFrame, uint initialFrame, uint flags, CGameObject *obj)=0
virtual bool	playCutscene (const Rect &drawRect, uint startFrame, uint endFrame)=0
virtual void	pause ()=0
virtual void	stop ()=0
virtual void	addEvent (int frameNumber, CGameObject *obj)=0
virtual void	setFrame (uint frameNumber)=0
virtual bool	handleEvents (CMovieEventList &events)=0
virtual const CMovieRangeInfoList *	getMovieRangeInfo () const =0
virtual void	setSoundManager (CSoundManager *soundManager)=0
virtual int	getFrame () const =0
virtual void	setFrameRate (double rate)=0
virtual void	setPlaying (bool playingFlag)=0
virtual Graphics::ManagedSurface *	duplicateTransparency () const =0
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)

Static Public Member Functions
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
bool	_handled
bool	_hasVideoFrame
Public Attributes inherited from Titanic::ListItem
	CLASSDEF

Static Public Attributes
static CMovieList *	_playingMovies
static CVideoSurface *	_movieSurface
Static Public Attributes inherited from Titanic::CSaveableObject
static ClassDef *	_type

Protected Member Functions
void	addToPlayingMovies ()

Member Function Documentation

addToPlayingMovies()

void Titanic::CMovie::addToPlayingMovies ( )

protected

Adds the movie to the list of currently playing movies

init()

static void Titanic::CMovie::init ( )

static

Initializes statics

deinit()

static void Titanic::CMovie::deinit ( )

static

Deinitializes statics

play() [1/3]

virtual void Titanic::CMovie::play ( uint  flags, CGameObject *  obj  )

pure virtual

Starts playing the movie

Implemented in Titanic::OSMovie.

play() [2/3]

virtual void Titanic::CMovie::play ( uint  startFrame, uint  endFrame, uint  flags, CGameObject *  obj  )

pure virtual

Starts playing the movie

Implemented in Titanic::OSMovie.

play() [3/3]

virtual void Titanic::CMovie::play ( uint  startFrame, uint  endFrame, uint  initialFrame, uint  flags, CGameObject *  obj  )

pure virtual

Starts playing the movie

Implemented in Titanic::OSMovie.

playCutscene()

virtual bool Titanic::CMovie::playCutscene ( const Rect &  drawRect, uint  startFrame, uint  endFrame  )

pure virtual

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

Implemented in Titanic::OSMovie.

pause()

virtual void Titanic::CMovie::pause ( )

pure virtual

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

Implemented in Titanic::OSMovie.

stop()

virtual void Titanic::CMovie::stop ( )

pure virtual

Stops the movie

Implemented in Titanic::OSMovie.

addEvent()

virtual void Titanic::CMovie::addEvent ( int  frameNumber, CGameObject *  obj  )

pure virtual

Add a playback event

Implemented in Titanic::OSMovie.

setFrame()

virtual void Titanic::CMovie::setFrame ( uint  frameNumber )

pure virtual

Set the current frame number

Implemented in Titanic::OSMovie.

handleEvents()

virtual bool Titanic::CMovie::handleEvents ( CMovieEventList &  events )

pure virtual

Handle any pending movie events

Implemented in Titanic::OSMovie.

getMovieRangeInfo()

virtual const CMovieRangeInfoList* Titanic::CMovie::getMovieRangeInfo ( ) const

pure virtual

Return any movie range info associated with the movie

Implemented in Titanic::OSMovie.

setSoundManager()

virtual void Titanic::CMovie::setSoundManager ( CSoundManager *  soundManager )

pure virtual

Set the sound manager reference

Implemented in Titanic::OSMovie.

getFrame()

virtual int Titanic::CMovie::getFrame ( ) const

pure virtual

Get the current movie frame

Implemented in Titanic::OSMovie.

setFrameRate()

virtual void Titanic::CMovie::setFrameRate ( double  rate )

pure virtual

Set the frame rate for the movie

Implemented in Titanic::OSMovie.

setPlaying()

virtual void Titanic::CMovie::setPlaying ( bool  playingFlag )

pure virtual

Sets whether the video is playing (versus paused)

Implemented in Titanic::OSMovie.

duplicateTransparency()

virtual Graphics::ManagedSurface* Titanic::CMovie::duplicateTransparency ( ) const

pure virtual

Creates a duplicate of the transparency surface

Implemented in Titanic::OSMovie.

removeFromPlayingMovies()

void Titanic::CMovie::removeFromPlayingMovies

(

)

Removes the movie from the list of currently playing movies

isActive()

bool Titanic::CMovie::isActive

(

)

const

Returns true if the movie is currently active

hasVideoFrame()

bool Titanic::CMovie::hasVideoFrame

(

)

Returns true if there's a video frame

---

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

• engines/titanic/support/movie.h