Inheritance diagram for CCmpCinemaManager:

Collaboration diagram for CCmpCinemaManager:

[legend]

Public Member Functions
int	GetComponentTypeId () const override

void	Init (const CParamNode &paramNode) override

void	Deinit () override

void	Serialize (ISerializer &serializer) override

void	Deserialize (const CParamNode &paramNode, IDeserializer &deserializer) override

void	HandleMessage (const CMessage &msg, bool global) override

void	AddPath (const CCinemaPath &path) override
	Adds the path to the path list. More...

void	AddCinemaPathToQueue (const CStrW &name) override
	Adds the path to the playlist. More...

void	Play () override

void	Stop () override

bool	HasPath (const CStrW &name) const override
	Checks the path name in the path list. More...

void	ClearQueue () override
	Clears the playlist. More...

void	DeletePath (const CStrW &name) override

const std::map< CStrW, CCinemaPath > &	GetPaths () const override

void	SetPaths (const std::map< CStrW, CCinemaPath > &newPaths) override

const std::list< CCinemaPath > &	GetQueue () const override

bool	IsEnabled () const override

void	SetEnabled (bool enabled) override
	Sets enable state of the cinema manager (shows/hide gui, show/hide rings, etc) More...

void	PlayQueue (const float deltaRealTime, CCamera *camera) override

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 CSimContext &	GetSimContext () const

void	SetSimContext (const CSimContext &context)

virtual void	Serialize (ISerializer &serialize)=0

virtual void	Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0

virtual bool	NewJSObject (const 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

Static Public Member Functions
static void	ClassInit (CComponentManager &componentManager)

static IComponent *	Allocate (const ScriptInterface &, JS::HandleValue)

static void	Deallocate (IComponent *cmp)

static std::string	GetSchema ()

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

static void	RegisterComponentType (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)

static void	RegisterComponentTypeScriptWrapper (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)

static u8	GetSerializationVersion ()

Private Member Functions
void	SerializePath (const CCinemaPath &path, ISerializer &serializer)

CCinemaPath	DeserializePath (IDeserializer &deserializer)

Private Attributes
bool	m_Enabled

std::map< CStrW, CCinemaPath >	m_Paths

std::list< CCinemaPath >	m_PathQueue

bool	m_MapRevealed

fixed	m_ElapsedTime

fixed	m_TotalTime

fixed	m_CurrentPathElapsedTime

Additional Inherited Members
Public Types inherited from IComponent
using	AllocFunc = IComponent ()(const ScriptInterface &scriptInterface, JS::HandleValue ctor)

using	DeallocFunc = void()(IComponent )

Member Function Documentation

◆ AddCinemaPathToQueue()

void CCmpCinemaManager::AddCinemaPathToQueue ( const CStrW & name )

inlineoverridevirtual

Adds the path to the playlist.

Parameters

name path name

Implements ICmpCinemaManager.

◆ AddPath()

void CCmpCinemaManager::AddPath ( const CCinemaPath & path )

inlineoverridevirtual

Adds the path to the path list.

Parameters

CCinemaPath path data

Implements ICmpCinemaManager.

◆ Allocate()

static IComponent * CCmpCinemaManager::Allocate	(	const ScriptInterface &	,
		JS::HandleValue
	)

inlinestatic

◆ ClassInit()

static void CCmpCinemaManager::ClassInit ( CComponentManager & componentManager )

inlinestatic

◆ ClearQueue()

void CCmpCinemaManager::ClearQueue ( )

inlineoverridevirtual

Clears the playlist.

Implements ICmpCinemaManager.

◆ Deallocate()

static void CCmpCinemaManager::Deallocate ( IComponent * cmp )

inlinestatic

◆ Deinit()

void CCmpCinemaManager::Deinit ( )

inlineoverridevirtual

Implements IComponent.

◆ DeletePath()

void CCmpCinemaManager::DeletePath ( const CStrW & name )

inlineoverridevirtual

Implements ICmpCinemaManager.

◆ Deserialize()

void CCmpCinemaManager::Deserialize	(	const CParamNode &	paramNode,
		IDeserializer &	deserializer
	)

inlineoverridevirtual

Implements IComponent.

◆ DeserializePath()

CCinemaPath CCmpCinemaManager::DeserializePath ( IDeserializer & deserializer )

inlineprivate

◆ GetComponentTypeId()

int CCmpCinemaManager::GetComponentTypeId ( ) const

inlineoverridevirtual

Implements IComponent.

◆ GetPaths()

const std::map< CStrW, CCinemaPath > & CCmpCinemaManager::GetPaths ( ) const

inlineoverridevirtual

Implements ICmpCinemaManager.

◆ GetQueue()

const std::list< CCinemaPath > & CCmpCinemaManager::GetQueue ( ) const

inlineoverridevirtual

Implements ICmpCinemaManager.

◆ GetSchema()

static std::string CCmpCinemaManager::GetSchema ( )

inlinestatic

◆ HandleMessage()

void CCmpCinemaManager::HandleMessage	(	const CMessage &	msg,
		bool	global
	)

inlineoverridevirtual

Reimplemented from IComponent.

◆ HasPath()

bool CCmpCinemaManager::HasPath ( const CStrW & name ) const

inlineoverridevirtual

Checks the path name in the path list.

Parameters

name path name

Returns: true if path with that name exists, else false

Implements ICmpCinemaManager.

◆ Init()

void CCmpCinemaManager::Init ( const CParamNode & paramNode )

inlineoverridevirtual

Implements IComponent.

◆ IsEnabled()

bool CCmpCinemaManager::IsEnabled ( ) const

inlineoverridevirtual

Implements ICmpCinemaManager.

◆ Play()

void CCmpCinemaManager::Play ( )

inlineoverridevirtual

Implements ICmpCinemaManager.

◆ PlayQueue()

void CCmpCinemaManager::PlayQueue	(	const float	deltaRealTime,
		CCamera *	camera
	)

inlineoverridevirtual

Implements ICmpCinemaManager.

◆ Serialize()

void CCmpCinemaManager::Serialize ( ISerializer & serializer )

inlineoverridevirtual

Implements IComponent.

◆ SerializePath()

void CCmpCinemaManager::SerializePath	(	const CCinemaPath &	path,
		ISerializer &	serializer
	)

inlineprivate

◆ SetEnabled()

void CCmpCinemaManager::SetEnabled ( bool enabled )

inlineoverridevirtual

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

Parameters

enable new state

Implements ICmpCinemaManager.

◆ SetPaths()

void CCmpCinemaManager::SetPaths ( const std::map< CStrW, CCinemaPath > & newPaths )

inlineoverridevirtual

Implements ICmpCinemaManager.

◆ Stop()

void CCmpCinemaManager::Stop ( )

inlineoverridevirtual

Implements ICmpCinemaManager.

Member Data Documentation

◆ m_CurrentPathElapsedTime

fixed CCmpCinemaManager::m_CurrentPathElapsedTime

private

◆ m_ElapsedTime

fixed CCmpCinemaManager::m_ElapsedTime

private

◆ m_Enabled

bool CCmpCinemaManager::m_Enabled

private

◆ m_MapRevealed

bool CCmpCinemaManager::m_MapRevealed

private

◆ m_PathQueue

std::list<CCinemaPath> CCmpCinemaManager::m_PathQueue

private

◆ m_Paths

std::map<CStrW, CCinemaPath> CCmpCinemaManager::m_Paths

private

◆ m_TotalTime

fixed CCmpCinemaManager::m_TotalTime

private

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

/home/docker/jenkins/workspace/technical-docs/source/simulation2/components/CCmpCinemaManager.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ AddCinemaPathToQueue()

◆ AddPath()

◆ Allocate()

◆ ClassInit()

◆ ClearQueue()

◆ Deallocate()

◆ Deinit()

◆ DeletePath()

◆ Deserialize()

◆ DeserializePath()

◆ GetComponentTypeId()

◆ GetPaths()

◆ GetQueue()

◆ GetSchema()

◆ HandleMessage()

◆ HasPath()

◆ Init()

◆ IsEnabled()

◆ Play()

◆ PlayQueue()

◆ Serialize()

◆ SerializePath()

◆ SetEnabled()

◆ SetPaths()

◆ Stop()

Member Data Documentation

◆ m_CurrentPathElapsedTime

◆ m_ElapsedTime

◆ m_Enabled

◆ m_MapRevealed

◆ m_PathQueue

◆ m_Paths

◆ m_TotalTime