Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members  

Sound Class Reference
[Managed Objects]

Sound Class Definition. More...

#include <Sound.h>

Inheritance diagram for Sound:

Inheritance graph
[legend]
Collaboration diagram for Sound:

Collaboration graph
[legend]
List of all members.

Public Methods

WDError initRef (void *inNode, IObjectManager *inManager, IObjectEventHandler *inEventHandler)
WDError initRef (SoundGroup *inParent, int inIndex, IObjectEventHandler *inEventHandler)
WDError initNew (SoundGroup *inParent, IObjectEventHandler *inEventHandler)
WDError setPath (const char *inPath)
WDError getPath (char *outPath, int inMaxLength)

Detailed Description

Sound Class Definition.

A Sound is a can be used as a music for a Chapter or as a sound for an actor State.


Member Function Documentation

WDError Sound::getPath char *    outPath,
int    inMaxLength
 

Returns the path of the Sound

Parameters:
outPath  path to the Sound
inMaxLength  the size of the character buffer

WDError Sound::initNew SoundGroup   inParent,
IObjectEventHandler   inEventHandler
 

Creates a new Sound and adds it to the database

Parameters:
inParent  SoundGroup in which the Sound is to be added
inEventHandler  EventHandler which listens to changes on the data node (can be NULL)

WDError Sound::initRef SoundGroup   inParent,
int    inIndex,
IObjectEventHandler   inEventHandler
 

Initializes an existing Sound based on its parent

Parameters:
inParent  SoundGroup in which the Sound is
inIndex  Index of the Sound in the SoundGroup
inEventHandler  EventHandler which listens to changes on the data node (can be NULL)

WDError Sound::initRef void *    inNode,
IObjectManager   inManager,
IObjectEventHandler   inEventHandler
 

Initializes an existing Sound based on data node

Parameters:
inNode  Data node representing the Sound
inManager  Database from which the data node was taken
inEventHandler  EventHandler which listens to changes on the data node (can be NULL)

Reimplemented from ManagedObject.

WDError Sound::setPath const char *    inPath
 

Sets the path of the Sound

Parameters:
inPath  path to the Sound


The documentation for this class was generated from the following file:
Generated on Mon Apr 15 15:23:21 2002 for WhiteDwarf by doxygen1.2.15