ph::SceneDescription Class Reference

Data that describe a scene. Represents the result of running SDL commands. More...

#include <SceneDescription.h>

Inheritance diagram for ph::SceneDescription:

Public Member Functions
	SceneDescription ()
std::shared_ptr< ISdlResource >	get (std::string_view resourceName) const override
	Get a resource reference.
bool	has (std::string_view resourceName) const override
	Check the existence of a resource reference.
RawResourceCollection &	getResources ()
const RawResourceCollection &	getResources () const
RawResourceCollection &	getPhantoms ()
const RawResourceCollection &	getPhantoms () const
const Path &	getWorkingDirectory () const
void	setWorkingDirectory (Path directory)
Public Member Functions inherited from ph::ISdlReferenceGroup
	PH_DEFINE_INLINE_RULE_OF_5_MEMBERS_NO_DTOR (ISdlReferenceGroup)
virtual	~ISdlReferenceGroup ()=default
template<typename T >
std::shared_ptr< T >	getTyped (std::string_view resourceName) const
	Get a resource reference of type T with name resourceName.
template<typename T >
bool	hasTyped (std::string_view resourceName) const
	Check the existence of resource of type T.

Detailed Description

Data that describe a scene. Represents the result of running SDL commands.

Constructor & Destructor Documentation

SceneDescription()

ph::SceneDescription::SceneDescription

(

)

Member Function Documentation

get()

std::shared_ptr< ISdlResource > ph::SceneDescription::get ( std::string_view resourceName ) const

overridevirtual

Get a resource reference.

Parameters

resourceName

The name of the resource.

Returns

The resource requested. nullptr if not found.

Implements ph::ISdlReferenceGroup.

getPhantoms() [1/2]

RawResourceCollection & ph::SceneDescription::getPhantoms ( )

inline

getPhantoms() [2/2]

const RawResourceCollection & ph::SceneDescription::getPhantoms ( ) const

inline

getResources() [1/2]

RawResourceCollection & ph::SceneDescription::getResources ( )

inline

getResources() [2/2]

const RawResourceCollection & ph::SceneDescription::getResources ( ) const

inline

getWorkingDirectory()

const Path & ph::SceneDescription::getWorkingDirectory ( ) const

inline

has()

bool ph::SceneDescription::has ( std::string_view resourceName ) const

overridevirtual

Check the existence of a resource reference.

Parameters

resourceName

The name of the resource.

Implements ph::ISdlReferenceGroup.

setWorkingDirectory()

void ph::SceneDescription::setWorkingDirectory

(

Path

directory

)

---

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

• Source/SDL/SceneDescription.h
• Source/SDL/SceneDescription.cpp