W3D_Image Interface Reference

#include "dwf/w3dtk/BOpcodeHandler.h"

Inheritance diagram for W3D_Image:

Inheritance graph
[legend]
Collaboration diagram for W3D_Image:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles externally referenced named images.

Since:
1.0.1000
This class has been added to handle the extended W3DE_Image op-code. This op-code was added for use in the W3D stream to work with the DWF package format preference of storing images (especially for textures) as section resources rather than embedding them directly in the graphics stream.

Definition at line 7835 of file BOpcodeHandler.h.

Public Member Functions

 W3D_Image ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
void Reset (void) alter
void SetName (char const *string) alter
void SetName (int length) alter
char const * GetName (void) const
char alter * GetName (void) alter
void SetSize (int x, int y)
int const * GetSize (void) const
int alter * GetSize (void) alter
void SetBitDepth (char bpp)
char const GetBitDepth (void) const
char alter GetBitDepth (void) alter

Protected Member Functions

void set_name (char const *string) alter
 internal use
void set_name (int length) alter
 internal use

Protected Attributes

char * m_name
int m_name_length
int m_size [2]
char m_bpp


Constructor & Destructor Documentation

W3D_Image::W3D_Image  )  [inline]
 

constructor

Definition at line 7855 of file BOpcodeHandler.h.


Member Function Documentation

char alter* W3D_Image::GetName void   )  [inline]
 

Returns the image name string buffer, which may be modified directly

Definition at line 7875 of file BOpcodeHandler.h.

char const* W3D_Image::GetName void   )  const [inline]
 

Returns the image name string

Definition at line 7873 of file BOpcodeHandler.h.

TK_Status W3D_Image::Read BStreamFileToolkit tk  )  [virtual]
 

Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void W3D_Image::Reset void   )  [virtual]
 

Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

Reimplemented from BBaseOpcodeHandler.

void W3D_Image::SetName int  length  )  [inline]
 

Sets the name buffer. Allocates a buffer large enough to hold a string of 'length' characters

Definition at line 7871 of file BOpcodeHandler.h.

void W3D_Image::SetName char const *  string  )  [inline]
 

Sets the name of the image. Allocates the buffer and copies the string

Definition at line 7869 of file BOpcodeHandler.h.

TK_Status W3D_Image::Write BStreamFileToolkit tk  )  [virtual]
 

Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


Member Data Documentation

char* W3D_Image::m_name [protected]
 

internal use; name applied to image (if any)

Definition at line 7843 of file BOpcodeHandler.h.

int W3D_Image::m_name_length [protected]
 

internal use; Length of name

Definition at line 7844 of file BOpcodeHandler.h.


The documentation for this interface was generated from the following file:
Generated on Tue Jan 6 22:41:48 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5