CriAtomAssetsLoader Class Reference

Cue Sheet management class from the Asset Support add-on More...

Classes
class	CueSheet
	Cue Sheet information class More...

Public Member Functions
CueSheet	GetCueSheet (CriAtomAcbAsset asset)
	Acquiring the Cue Sheet (by specifying the ACB asset) More...
CueSheet	GetCueSheet (string name)
	Acquiring the Cue Sheet (by specifying the Cue Sheet's name) More...
void	AddCueSheet (CriAtomAcbAsset acbAsset, string name)
	Loading the Cue Sheet (by specifying the Cue Sheet's name) More...
void	ReleaseCueSheet (CueSheet cueSheet, bool unloadImmediate)
	Releasing the Cue Sheet More...

Static Public Member Functions
static void	AddCueSheet (CriAtomAcbAsset acbAsset)
	Loading the Cue Sheet More...
static void	ReleaseCueSheet (CriAtomAcbAsset acbAsset, bool unloadImmediate=true)
	Releasing the Cue Sheet (by specifying the ACB asset) More...
static void	ReleaseCueSheet (string name, bool unloadImmediate=true)
	Releasing the Cue Sheet (by specifying the Cue Sheet's name) More...
static void	UnloadUnusedCueSheets ()
	Unloading unreferenced Cue Sheets More...

Properties
IEnumerable< CueSheet >	CueSheets [get]
	List of loaded Cue Sheets More...

Detailed Description

Cue Sheet management class from the Asset Support add-on

Description:

This class manages the ACBs loaded either automatically by a CriAtomSourceForAsset or manually from CriAtomAssets.
It keeps track of the reference count for each of the loaded ACBs.

Member Function Documentation

CueSheet GetCueSheet ( CriAtomAcbAsset  asset )

inline

Acquiring the Cue Sheet (by specifying the ACB asset)

Description:

Gets the information pertaining to the loaded Cue Sheet corresponding to the specified ACB asset.

CueSheet GetCueSheet ( string  name )

inline

Acquiring the Cue Sheet (by specifying the Cue Sheet's name)

Description:

Gets the information on the loaded Cue Sheet with the specified name.
For assets registered without specifying a Cue Sheet name, the asset name will be used as the Cue Sheet name.

void AddCueSheet ( CriAtomAcbAsset  acbAsset, string  name  )

inline

Loading the Cue Sheet (by specifying the Cue Sheet's name)

Description:

Loads an ACB asset. If already loaded, the Cue Sheet's reference count will be increased.
The Cue Sheet's information can be obtained by calling the GetCueSheet method with the name of the Cue Sheet of interest.

static void AddCueSheet ( CriAtomAcbAsset  acbAsset )

inlinestatic

Loading the Cue Sheet

Description:

Loads an ACB asset. If already loaded, the Cue Sheet's reference count will be increased.
The name of a Cue Sheet loaded with this method will be the same than the name of the asset.

static void ReleaseCueSheet ( CriAtomAcbAsset  acbAsset, bool  unloadImmediate = true  )

inlinestatic

Releasing the Cue Sheet (by specifying the ACB asset)

Description:

Releases an ACB asset. When the reference count reaches 0, the Cue Sheet will automatically be unloaded.
However, if unloadImmediate is set to false, UnloadUnusedCueSheets will need to be called later to unload it.

static void ReleaseCueSheet ( string  name, bool  unloadImmediate = true  )

inlinestatic

Releasing the Cue Sheet (by specifying the Cue Sheet's name)

Description:

Releases an ACB asset. When the reference count reaches 0, the Cue Sheet will automatically be unloaded.
However, if unloadImmediate is set to false, UnloadUnusedCueSheets will need to be called later to unload it.

void ReleaseCueSheet ( CueSheet  cueSheet, bool  unloadImmediate  )

inline

Releasing the Cue Sheet

Description:

Releases an ACB asset. When the reference count reaches 0, the Cue Sheet will automatically be unloaded.
However, if unloadImmediate is set to false, UnloadUnusedCueSheets will need to be called later to unload it.

static void UnloadUnusedCueSheets ( )

static

Unloading unreferenced Cue Sheets

Description:

Unloads all Cue Sheets with a reference count at 0 at once.
If the unloading is delayed, call this function at the appropriate time.

Property Documentation

IEnumerable<CueSheet> CueSheets

get

List of loaded Cue Sheets

Description:

Returns the list of the loaded Cue Sheets.

---

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

• CriAtomAssets.cs