CBaldurProjector Class¶
Overview¶
Note
The CBaldurProjector class handles playing chapter movies
The structure used for this class is CBaldurProjector
Quick Reference¶
Quick Ref |
void CBaldurProjector::CBaldurProjector() |
virtual void CBaldurProjector::~CBaldurProjector() |
virtual int CBaldurProjector::CheckMouseLButton() |
virtual void CBaldurProjector::EngineActivated() |
virtual void CBaldurProjector::EngineDeactivated() |
virtual void CBaldurProjector::EngineGameInit() |
virtual void CBaldurProjector::EngineGameUninit() |
virtual CKeyInfo* CBaldurProjector::GetVirtualKeys() |
virtual int* CBaldurProjector::GetVirtualKeysFlags() |
virtual short CBaldurProjector::GetNumVirtualKeys() |
virtual bool CBaldurProjector::OnEvent(SDL_Event* e) |
virtual void CBaldurProjector::OnKeyUp(int nKeyFlags) |
virtual void CBaldurProjector::OnLButtonUp(CPoint cPoint) |
void CBaldurProjector::PlayMovie(CResRef& cResRef) |
void CBaldurProjector::PlayMovieInternal(CResRef& cResRef, int bAsynchThread) |
void CBaldurProjector::PlayMovieNext(CResRef& cResRef) |
virtual int CBaldurProjector::StopMusic() |
virtual void CBaldurProjector::TimerAsynchronousUpdate() |
virtual void CBaldurProjector::TimerSynchronousUpdate() |
Constructors¶
Name |
Description |
Constructs a |
|
Destroys a |
CBaldurProjector::CBaldurProjector¶
Constructs a CBaldurProjector
object
void CBaldurProjector::CBaldurProjector();
Remarks
Constructs a CBaldurProjector
object
CBaldurProjector::~CBaldurProjector¶
Destroys the CBaldurProjector
object
virtual void CBaldurProjector::~CBaldurProjector();
Remarks
Destroys the CBaldurProjector
object
Methods¶
Name |
Description |
Checks if left mouse button is down |
|
Event signalling for when CBaldurProjector is activated |
|
Event signalling for when CBaldurProjector is deactivated |
|
Initialize CBaldurProjector |
|
Uninitialize CBaldurProjector |
|
Key press event processing |
|
Key press event processing for key flags |
|
Returns number of keys supported by keyboard for key event processing |
|
Event handling using SDL library |
|
Key press event for when a key has been pressed and released |
|
Mouse button event for when the left mouse has been clicked and released |
|
Plays the WEBM movie as specified by the resource reference |
|
Plays the WEBM movie as specified by the resource reference |
|
Play the next movie |
|
Stop the movie music/sound/voice-over curently playing |
|
Timer asynchronous update |
|
Timer synchronous update |
CBaldurProjector::EngineActivated¶
Event signalling for when CBaldurProjector is activated
virtual void CBaldurProjector::EngineActivated();
Remarks
CBaldurProjector::EngineDeactivated¶
Event signalling for when CBaldurProjector is deactivated
virtual void CBaldurProjector::EngineDeactivated();
Remarks
CBaldurProjector::EngineGameInit¶
Initialize CBaldurProjector
virtual void CBaldurProjector::EngineGameInit();
Remarks
CBaldurProjector::EngineGameUninit¶
Uninitialize CBaldurProjector
virtual void CBaldurProjector::EngineGameUninit();
Remarks
CBaldurProjector::GetVirtualKeys¶
Return keyCode and other information for current keypress
virtual CKeyInfo* CBaldurProjector::GetVirtualKeys();
Return Value
Returns CKeyInfo*
Remarks
CKeyInfo contains keyCode and other keyboard information: repeatCount, repeatDelay and repeatRate
CBaldurProjector::GetVirtualKeysFlags¶
Key press event processing for key flags
virtual int* CBaldurProjector::GetVirtualKeysFlags();
Return Value
Returns int
*
Remarks
CBaldurProjector::GetNumVirtualKeys¶
Returns number of keys supported by keyboard for key event processing
virtual short CBaldurProjector::GetNumVirtualKeys();
Return Value
Returns a short
value indicating number of keys supported
Remarks
CBaldurProjector::OnEvent¶
Event handling using SDL library
virtual bool CBaldurProjector::OnEvent(SDL_Event* e);
Parameters
SDL_Event
* e - SDL event
Return Value
Returns bool
Remarks
CBaldurProjector::OnKeyUp¶
Key press event for when a key has been pressed (down) and released (up)
virtual void CBaldurProjector::OnKeyUp(int nKeyFlags);
Parameters
int
nKeyFlags -
Remarks
CBaldurProjector::PlayMovie¶
Plays the WEBM movie as specified by the resource reference
void CBaldurProjector::PlayMovie(CResRef& cResRef);
Parameters
CResRef& cResRef - WBM movie resource reference to play
Remarks
Calls CBaldurProjector::PlayMovieInternal which handles the internals of playing the movie
CBaldurProjector::PlayMovieInternal¶
Plays the WEBM movie as specified by the resource reference
void CBaldurProjector::PlayMovieInternal(
CResRef& cResRef,
int bAsynchThread);
Parameters
CResRef& cResRef - WBM movie resource reference to play
int
bAsynchThread - boolean indicating the use of an asynchronous thread (true) or a synchronous thread instead (false)
Remarks
Called from CBaldurProjector::PlayMovie. Depending on the thread type specified by bAsyncThread determines the update used: CBaldurProjector::TimerAsynchronousUpdate or CBaldurProjector::TimerSynchronousUpdate
CBaldurProjector::PlayMovieNext¶
Play the next movie. Adds movie to queue to play next?
void CBaldurProjector::PlayMovieNext(CResRef& cResRef);
Parameters
CResRef& cResRef - WBM movie resource reference to play next
Remarks
CBaldurProjector::StopMusic¶
Stop the movie music/sound/voice-over curently playing
virtual int CBaldurProjector::StopMusic();
Return Value
Returns int
Remarks
CBaldurProjector::TimerAsynchronousUpdate¶
Timer asynchronous update
virtual void CBaldurProjector::TimerAsynchronousUpdate();
Remarks
CBaldurProjector::TimerSynchronousUpdate¶
Timer synchronous update
virtual void CBaldurProjector::TimerSynchronousUpdate();
Remarks