C# Class TagTool.Sounds.WwiseObjectCollection

A collection of Wwise objects that can be referenced through an ID number.
Show file Open project: TheGuardians/TagTool Class Usage Examples

Public Methods

Method Description
Add ( IWwiseObject obj ) : void

Adds an object to the collection so that it can be referenced by its ID number.

Clear ( ) : void

Removes all objects from the collection.

Dispatch ( uint id, IWwiseObjectVisitor visitor ) : bool

Finds a Wwise object by ID number and then passes it to an IWwiseObjectVisitor.

Find ( uint id ) : IWwiseObject

Finds a Wwise object by ID number.

Import ( WwiseObjectCollection other ) : void

Imports objects from another collection into this collection.

Method Details

Add() public method

Adds an object to the collection so that it can be referenced by its ID number.
public Add ( IWwiseObject obj ) : void
obj IWwiseObject The IWwiseObject to store.
return void

Clear() public method

Removes all objects from the collection.
public Clear ( ) : void
return void

Dispatch() public method

Finds a Wwise object by ID number and then passes it to an IWwiseObjectVisitor.
public Dispatch ( uint id, IWwiseObjectVisitor visitor ) : bool
id uint The ID number of the object to find.
visitor IWwiseObjectVisitor The IWwiseObjectVisitor to pass the object to if it is found.
return bool

Find() public method

Finds a Wwise object by ID number.
public Find ( uint id ) : IWwiseObject
id uint The ID number of the object to find.
return IWwiseObject

Import() public method

Imports objects from another collection into this collection.
public Import ( WwiseObjectCollection other ) : void
other WwiseObjectCollection The WwiseObjectCollection to import objects from.
return void