You.i Engine
Classes | Public Member Functions | Protected Member Functions | Friends | List of all members
CYIAssetManifest Class Reference
Assets

Detailed Description

Stores information for the asset manifest.

The information stored by this object is composed of the following:

  • Manifest version
  • Minimum supported You.i Engine version
  • Maximum supported You.i Engine version
  • A tree representation of the asset directory structure

#include <asset/YiAssetManifest.h>

Classes

class  Node
 Node for the manifest. More...
 

Public Member Functions

 CYIAssetManifest ()
 
virtual ~CYIAssetManifest ()
 
const CYIVersion & GetManifestVersion () const
 
const CYIVersion & GetMinimumEngineVersion () const
 
const CYIVersion & GetMaximumEngineVersion () const
 
const Node & GetRootNode () const
 
void SetRootNode (const Node &manifestItem)
 
bool IsEmpty () const
 
uint32_t GetApproximateCPUSize () const
 

Protected Member Functions

void SetManifestVersion (const CYIVersion &manifestVersion)
 
void SetMinimumEngineVersion (const CYIVersion &minimumVersion)
 
void SetMaximumEngineVersion (const CYIVersion &maximumVersion)
 

Friends

class CYIAssetManifestParser
 

Constructor & Destructor Documentation

CYIAssetManifest::CYIAssetManifest ( )
virtual CYIAssetManifest::~CYIAssetManifest ( )
virtual

Member Function Documentation

uint32_t CYIAssetManifest::GetApproximateCPUSize ( ) const

Calculates and returns the approximate number of bytes currently used by this manifest on the CPU.

Note
This function returns an approximate memory consumption as the exact memory consumption varies depending on the used C++ libraries and on the specific drivers used by the system.
const CYIVersion& CYIAssetManifest::GetManifestVersion ( ) const

Returns the version of the manifest file.

const CYIVersion& CYIAssetManifest::GetMaximumEngineVersion ( ) const

Returns the maximum engine version supported for this manifest.

const CYIVersion& CYIAssetManifest::GetMinimumEngineVersion ( ) const

Returns the minimum engine version supported for this manifest.

const Node& CYIAssetManifest::GetRootNode ( ) const

Returns the root node of the asset tree.

bool CYIAssetManifest::IsEmpty ( ) const

Returns true if this manifest has no assets in it.

void CYIAssetManifest::SetManifestVersion ( const CYIVersion &  manifestVersion)
protected

Sets the manifest file version.

void CYIAssetManifest::SetMaximumEngineVersion ( const CYIVersion &  maximumVersion)
protected

Sets the maximum engine version supported for this manifest.

void CYIAssetManifest::SetMinimumEngineVersion ( const CYIVersion &  minimumVersion)
protected

Sets the minimum engine version supported for this manifest.

void CYIAssetManifest::SetRootNode ( const Node &  manifestItem)

Sets the root node for the asset tree.

Friends And Related Function Documentation

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