CYIAssetViewTemplate Class Reference

Detailed Description

ViewTemplate asset. Wrapper around a CYIViewTemplate.

#include <asset/YiAssetViewTemplate.h>

Inheritance diagram for CYIAssetViewTemplate:

Public Member Functions
	CYIAssetViewTemplate ()
	CYIAssetViewTemplate (const CYIString &path, PATH_TYPE ePathType=PATH_RELATIVE)
virtual	~CYIAssetViewTemplate ()
const std::shared_ptr< CYIViewTemplate > &	GetTemplate ()
std::unique_ptr< CYISceneView >	BuildView (CYISceneManager *pSceneManager)
Public Member Functions inherited from CYIAsset
virtual	~CYIAsset ()
const CYIString &	GetPath () const
CYIAssetLoadParams *	GetLoadParameters () const
virtual std::pair< uint32_t, uint32_t >	GetApproximateSize () const
bool	SetName (const CYIString &name)
const CYIString &	GetName () const
bool	Load ()
void	Unload ()
bool	IsLoaded () const
bool	Equals (const std::shared_ptr< CYIAsset > &pAsset)
virtual bool	Prepare ()
Public Member Functions inherited from CYIScriptableRTTIObject
	CYIScriptableRTTIObject ()
virtual	~CYIScriptableRTTIObject ()
virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const override
Public Member Functions inherited from CYIScriptableObject
	CYIScriptableObject ()
	CYIScriptableObject (const CYIScriptableObject &other)
CYIScriptableObject &	operator= (const CYIScriptableObject &other)
virtual	~CYIScriptableObject ()
CYIBindingImplementation *	GetBindingImplementation () const
void	SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)

Protected Member Functions
virtual void	OnUnload () override
void	SetTemplate (const std::shared_ptr< CYIViewTemplate > &pViewTemplate)
Protected Member Functions inherited from CYIAsset
	CYIAsset ()
ssize_t	GetID () const
void	SetPath (const CYIString &path, PATH_TYPE ePathType)
void	SetApproximateSize (uint32_t nSize)
void	SetLoaded (bool bAssetLoaded)
void	SetLoadParameters (std::unique_ptr< CYIAssetLoadParams > pParams)
virtual void	OnLoad ()
Protected Member Functions inherited from CYIScriptableRTTIObject
virtual std::pair< const CYIRuntimeTypeInfo *, const void * >	GetRuntimeTypeInfoWithObject () const =0

Friends
class	CYIAssetDecoderTemplate

Additional Inherited Members
Public Types inherited from CYIAsset
enum	PATH_TYPE {   PATH_ABSOLUTE = 0,   PATH_RELATIVE }
Static Protected Attributes inherited from CYIAsset
static ssize_t	INVALID_ID

Constructor & Destructor Documentation

CYIAssetViewTemplate::CYIAssetViewTemplate

(

)

CYIAssetViewTemplate::CYIAssetViewTemplate	(	const CYIString &	path,
		PATH_TYPE	ePathType = PATH_RELATIVE
	)

virtual CYIAssetViewTemplate::~CYIAssetViewTemplate ( )

virtual

Member Function Documentation

std::unique_ptr<CYISceneView> CYIAssetViewTemplate::BuildView

(

CYISceneManager *

pSceneManager

)

Constructs a new view instance from the view template. Before a CYISceneView is ready to be used, the Init() method must also be called.

Consider the following example to construct and initialize a CYISceneView:

std::shared_ptr<CYIAssetViewTemplate> pAssetViewTemplate      = CYIViewTemplate::GetViewTemplate("CustomViews_CustomButton");
pSceneView = pAssetViewTemplate->BuildView(m_pSceneManager);
pSceneView->Init();

The caller is responsible for destroying the view.

const std::shared_ptr<CYIViewTemplate>& CYIAssetViewTemplate::GetTemplate

(

)

Returns the view template object. The template will be reloaded if necessary.

virtual void CYIAssetViewTemplate::OnUnload ( )

overrideprotectedvirtual

Reimplemented from CYIAsset.

void CYIAssetViewTemplate::SetTemplate ( const std::shared_ptr< CYIViewTemplate > &  pViewTemplate )

protected

Friends And Related Function Documentation

friend class CYIAssetDecoderTemplate

friend

---

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

• asset/YiAssetViewTemplate.h