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

Image Class Reference
[Managed Objects]

Image Class Definition. More...

#include <Image.h>

Inheritance diagram for Image:

Inheritance graph
[legend]
Collaboration diagram for Image:

Collaboration graph
[legend]
List of all members.

Public Methods

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

Detailed Description

Image Class Definition.

A Image is a can be used as a background for a Chapter or as an image for an Actor or an actor State.


Member Function Documentation

WDError Image::getPath (  char *    outPath,
int    inMaxLength
) 
 

Returns the path of the image

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

WDError Image::initNew (  ImageGroup *    inParent,
IObjectEventHandler *    inEventHandler
) 
 

Creates a new Image and adds it to the database

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

WDError Image::initRef (  ImageGroup *    inParent,
int    inIndex,
IObjectEventHandler *    inEventHandler
) 
 

Initializes an existing Image based on its parent

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

WDError Image::initRef (  void *    inNode,
IObjectManager *    inManager,
IObjectEventHandler *    inEventHandler
) 
 

Initializes an existing Image based on data node

Parameters:
inNode  Data node representing the Image
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 Image::setPath (  const char *    inPath ) 
 

Sets the path of the image

Parameters:
inPath  path to the image


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