Pyrogenesis  trunk
Public Member Functions | List of all members
ICmpCinemaManager Class Referenceabstract

Component for CCinemaManager class TODO: write description. More...

#include <ICmpCinemaManager.h>

Inheritance diagram for ICmpCinemaManager:
Inheritance graph
[legend]
Collaboration diagram for ICmpCinemaManager:
Collaboration graph
[legend]

Public Member Functions

virtual void AddPath (const CCinemaPath &path)=0
 Adds the path to the path list. More...
 
virtual void AddCinemaPathToQueue (const CStrW &name)=0
 Adds the path to the playlist. More...
 
virtual void Play ()=0
 
virtual void Stop ()=0
 
virtual void PlayQueue (const float deltaRealTime, CCamera *camera)=0
 
virtual bool HasPath (const CStrW &name) const =0
 Checks the path name in the path list. More...
 
virtual void DeletePath (const CStrW &name)=0
 
virtual void ClearQueue ()=0
 Clears the playlist. More...
 
virtual const std::map< CStrW, CCinemaPath > & GetPaths () const =0
 
virtual void SetPaths (const std::map< CStrW, CCinemaPath > &newPaths)=0
 
virtual const std::list< CCinemaPath > & GetQueue () const =0
 
virtual bool IsEnabled () const =0
 
virtual void SetEnabled (bool enabled)=0
 Sets enable state of the cinema manager (shows/hide gui, show/hide rings, etc) More...
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
virtual void Init (const CParamNode &paramNode)=0
 
virtual void Deinit ()=0
 
virtual void HandleMessage (const CMessage &msg, bool global)
 
CEntityHandle GetEntityHandle () const
 
void SetEntityHandle (CEntityHandle ent)
 
entity_id_t GetEntityId () const
 
CEntityHandle GetSystemEntity () const
 
const CSimContextGetSimContext () const
 
void SetSimContext (const CSimContext &context)
 
virtual void Serialize (ISerializer &serialize)=0
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0
 
virtual bool NewJSObject (ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
 Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...
 
virtual JS::Value GetJSInstance () const
 
virtual int GetComponentTypeId () const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static u8 GetSerializationVersion ()
 

Detailed Description

Component for CCinemaManager class TODO: write description.

Member Function Documentation

virtual void ICmpCinemaManager::AddCinemaPathToQueue ( const CStrW &  name)
pure virtual

Adds the path to the playlist.

Parameters
namepath name

Implemented in CCmpCinemaManager.

virtual void ICmpCinemaManager::AddPath ( const CCinemaPath path)
pure virtual

Adds the path to the path list.

Parameters
CCinemaPathpath data

Implemented in CCmpCinemaManager.

virtual void ICmpCinemaManager::ClearQueue ( )
pure virtual

Clears the playlist.

Implemented in CCmpCinemaManager.

virtual void ICmpCinemaManager::DeletePath ( const CStrW &  name)
pure virtual

Implemented in CCmpCinemaManager.

virtual const std::map<CStrW, CCinemaPath>& ICmpCinemaManager::GetPaths ( ) const
pure virtual

Implemented in CCmpCinemaManager.

virtual const std::list<CCinemaPath>& ICmpCinemaManager::GetQueue ( ) const
pure virtual

Implemented in CCmpCinemaManager.

virtual bool ICmpCinemaManager::HasPath ( const CStrW &  name) const
pure virtual

Checks the path name in the path list.

Parameters
namepath name
Returns
true if path with that name exists, else false

Implemented in CCmpCinemaManager.

virtual bool ICmpCinemaManager::IsEnabled ( ) const
pure virtual

Implemented in CCmpCinemaManager.

virtual void ICmpCinemaManager::Play ( )
pure virtual

Implemented in CCmpCinemaManager.

virtual void ICmpCinemaManager::PlayQueue ( const float  deltaRealTime,
CCamera camera 
)
pure virtual

Implemented in CCmpCinemaManager.

virtual void ICmpCinemaManager::SetEnabled ( bool  enabled)
pure virtual

Sets enable state of the cinema manager (shows/hide gui, show/hide rings, etc)

Parameters
enablenew state

Implemented in CCmpCinemaManager.

virtual void ICmpCinemaManager::SetPaths ( const std::map< CStrW, CCinemaPath > &  newPaths)
pure virtual

Implemented in CCmpCinemaManager.

virtual void ICmpCinemaManager::Stop ( )
pure virtual

Implemented in CCmpCinemaManager.


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