DX::IDXFileSystem Struct Reference

#include <IDXFileSystem.h>

Inherits DX::IDXUserData, and DX::IDXModelOwned.

Collaboration diagram for DX::IDXFileSystem:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual uint DXMCALL GetNumFiles () const =0
virtual DXError DXMCALL GetFile (uint index, IDXFilePtr *out) const =0
virtual DXError DXMCALL GetFile (const wchar_t *name, IDXFilePtr *out) const =0
virtual DXError DXMCALL GetFiles (IDXFileArray out) const =0
virtual DXError DXMCALL GetFiles (uint start, uint count, IDXFileArray out) const =0
virtual DXError DXMCALL GetFileIndex (IDXFilePtr file, uint *out) const =0
virtual DXError DXMCALL GetFileIndex (const wchar_t *name, uint *out) const =0
virtual DXError DXMCALL AddInt32File (int *data, uint length, const wchar_t *destinationName, IDXFileInt32Ptr *out=0)=0
virtual DXError DXMCALL AddInt32File (const wchar_t *destinationName, IDXFileInt32Ptr *out=0)=0
virtual DXError DXMCALL AddInt32File (const wchar_t *source, const wchar_t *destinationName, IDXFileInt32Ptr *out=0)=0
virtual DXError DXMCALL AddFloat32File (float *data, uint length, const wchar_t *destinationName, IDXFileFloat32Ptr *out=0)=0
virtual DXError DXMCALL AddFloat32File (const wchar_t *destinationName, IDXFileFloat32Ptr *out=0)=0
virtual DXError DXMCALL AddFloat32File (const wchar_t *source, const wchar_t *destinationName, IDXFileFloat32Ptr *out=0)=0
virtual DXError DXMCALL AddResourceFile (const wchar_t *source, const wchar_t *destinationName, IDXFileResourcePtr *out=0)=0
virtual DXError DXMCALL AddResourceFile (const wchar_t *destinationName, IDXFileResourcePtr *out=0)=0
virtual DXError DXMCALL AddResourceFile (ByteArray data, uint length, const wchar_t *destinationName, IDXFileResourcePtr *out=0)=0
virtual DXError DXMCALL RemoveFile (IDXFilePtr file)=0
virtual DXError DXMCALL RemoveFile (uint index)=0
virtual DXError DXMCALL RemoveFile (uint start, uint count)=0
virtual DXError DXMCALL RemoveFile (const wchar_t *filename)=0
virtual void DXMCALL ClearFiles ()=0


Detailed Description

Controls access to all files included in the model.

Member Function Documentation

virtual DXError DXMCALL DX::IDXFileSystem::AddFloat32File ( const wchar_t *  source,
const wchar_t *  destinationName,
IDXFileFloat32Ptr *  out = 0 
) [pure virtual]

Add a new Float32 file from the file passed in.

Parameters:
source The source file (on disk) that the resouce will be taken from.
destinationName The name for the file in the zip.
out An optional pointer to an IDXFileFloat32Ptr where a handle will be saved.
Returns:
Error_NullParam if source was null.
Error_NullParam2 if destinationName was null.
Error_Duplicate if a file with the destination name already exists.
Error_NotFound if the source file was not found on disk.
Error_Success if the file was created and the result stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::AddFloat32File ( const wchar_t *  destinationName,
IDXFileFloat32Ptr *  out = 0 
) [pure virtual]

Add a new empty Float32 file to the file system.

Parameters:
destinationName The name for the file in the zip.
out An optional pointer to an IDXFileFloat32Ptr where a handle will be saved.
Returns:
Error_NullParam if destinationName was null.
Error_Duplicate if a file with the destinationName already exists in the zip.
Error_Success if the file was created and the result stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::AddFloat32File ( float *  data,
uint  length,
const wchar_t *  destinationName,
IDXFileFloat32Ptr *  out = 0 
) [pure virtual]

Add a new Float32 file to the file system using data passed in.

Parameters:
data A float array which is the data to load.
length The number of ints to load.
destinationName The name for the file in the zip.
out An optional pointer to an IDXFileFloat32Ptr where a handle will be saved.
Returns:
Error_NullParam if data was null.
Error_NullParam2 if destinationName was null.
Error_Duplicate if a file with the destination name already exists.
Error_Success if the file was created and the result stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::AddInt32File ( const wchar_t *  source,
const wchar_t *  destinationName,
IDXFileInt32Ptr *  out = 0 
) [pure virtual]

Add a new Int32 file from the file passed in.

Parameters:
source The source file (on disk) that the resouce will be taken from.
destinationName The name for the file in the zip.
out An optional pointer to an IDXFileInt32Ptr where a handle will be saved.
Returns:
Error_NullParam if source was null.
Error_NullParam2 if destinationName was null.
Error_Duplicate if a file with the destination name already exists.
Error_NotFound if the source file was not found on disk.
Error_InvalidParam if the source was not of the correct size. Error_Success if the file was created and the result stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::AddInt32File ( const wchar_t *  destinationName,
IDXFileInt32Ptr *  out = 0 
) [pure virtual]

Add a new empty int32 file to the file system.

Parameters:
destinationName The name for the file in the zip.
out An optional pointer to an IDXFileInt32Ptr where a handle will be saved.
Returns:
Error_NullParam if destinationName was null.
Error_Duplicate if a file with the destinationName already exists in the zip.
Error_Success if the file was created and the result stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::AddInt32File ( int *  data,
uint  length,
const wchar_t *  destinationName,
IDXFileInt32Ptr *  out = 0 
) [pure virtual]

Add a new int32 file to the file system using data passed in.

Parameters:
data An int array which is the data to load.
length The number of ints to load.
destinationName The name for the file in the zip.
out An optional pointer to an IDXFileInt32Ptr where a handle will be saved.
Returns:
Error_NullParam if data was null.
Error_NullParam2 if destinationName was null.
Error_Duplicate if a file with the destination name already exists.
Error_Success if the file was created and the result stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::AddResourceFile ( ByteArray  data,
uint  length,
const wchar_t *  destinationName,
IDXFileResourcePtr *  out = 0 
) [pure virtual]

Add a new resource file filled with the specified data.

Parameters:
data A byte array with the data to use.
length The number of bytes in data.
destinationName The name to use for the file in the zip.
out An optional pointer to an IDXFileResource where a handle will be saved.
Returns:
Error_NullParam if data was null.
Error_NullParam2 if destinationName was null.
Error_Duplicate if a file with the destination name already exists.
Error_Success if the resource was created and the result was stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::AddResourceFile ( const wchar_t *  destinationName,
IDXFileResourcePtr *  out = 0 
) [pure virtual]

Add a new empty resource file to the file system.

Parameters:
destinationName The name for the file in the zip.
out An optional pointer to an IDXFileResourcePtr where a handle will be saved.
Returns:
Error_NullParam if destinationName was null.
Error_Duplicate if a file with the destination name already exists.
Error_Success if the resource was created and the result stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::AddResourceFile ( const wchar_t *  source,
const wchar_t *  destinationName,
IDXFileResourcePtr *  out = 0 
) [pure virtual]

Add a new resource file to the file system.

Parameters:
source The source file (on disk) that the resource will be taken from.
destinationName The name for the file in the zip.
out An optional pointer to an IDXFileResource where a handle will be saved.
Returns:
Error_NullParam if source was null.
Error_NullParam2 if destinationName was null.
Error_Duplicate if a file with the destination name already exists.
Error_NotFound if the source file was not found on disk.
Error_Success if the resource was created and the result stored in out.

virtual void DXMCALL DX::IDXFileSystem::ClearFiles (  )  [pure virtual]

Remove all files from the file system.

virtual DXError DXMCALL DX::IDXFileSystem::GetFile ( const wchar_t *  name,
IDXFilePtr *  out 
) const [pure virtual]

Get the file with the specified name.

Parameters:
name The filename of the file to retrieve.
out A pointer to an IDXFilePtr where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if name was null.
Error_NotFound if there was no file with that name.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::GetFile ( uint  index,
IDXFilePtr *  out 
) const [pure virtual]

Get the file at the specified index.

Parameters:
idOrIndex The index to use
out A pointer to an IDXFilePtr where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if the index was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::GetFileIndex ( const wchar_t *  name,
uint *  out 
) const [pure virtual]

Get the index of the file with the specified name.

Parameters:
name The name of the file to search for.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if name was null.
Error_NotFound if the file was not found.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::GetFileIndex ( IDXFilePtr  file,
uint *  out 
) const [pure virtual]

Get the index of the specified file.

Parameters:
file The file to search for.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if file was null.
Error_NotFound if the file was not found.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::GetFiles ( uint  start,
uint  count,
IDXFileArray  out 
) const [pure virtual]

Get a chunk of files in the filesystem.

Parameters:
start The index of the first element to retrieve.
count The number of elements to retrieve.
out A user allocated array of IDXFilePtr of length at least count.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if start was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFileSystem::GetFiles ( IDXFileArray  out  )  const [pure virtual]

Get all files in the filesystem.

Parameters:
out A user allocated array of IDXFilePtr of length at least equal to GetNumFiles.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual uint DXMCALL DX::IDXFileSystem::GetNumFiles (  )  const [pure virtual]

Get the total number of files stored in the filesystem.

Returns:
The number of files.

virtual DXError DXMCALL DX::IDXFileSystem::RemoveFile ( const wchar_t *  filename  )  [pure virtual]

Remove the file with the specified name from the filesystem.

Parameters:
filename The name of the file to remove.
Returns:
Error_NullParam if filename was null.
Error_NotFound if there was no matching file.
Error_Success if the file was removed.

virtual DXError DXMCALL DX::IDXFileSystem::RemoveFile ( uint  start,
uint  count 
) [pure virtual]

Remove a range of files from the filesystem.

Parameters:
start The index of the first file to remove.
count The number of elements to remove.
Returns:
Error_OutOfRange if start was out of range.
Error_Success if the range was removed.

virtual DXError DXMCALL DX::IDXFileSystem::RemoveFile ( uint  index  )  [pure virtual]

Remove the file at the specified index from the filesystem.

Parameters:
index The index of the file to remove.
Returns:
Error_OutOfRange if the index was out of range.
Error_Success if the file was removed.

virtual DXError DXMCALL DX::IDXFileSystem::RemoveFile ( IDXFilePtr  file  )  [pure virtual]

Remove the speicified file from the file system.

Parameters:
file A file to remove.
Returns:
Error_NullParam if file was null.
Error_NotFound if the file was not found in the system.
Error_Success if the file was removed


Generated on Wed Jun 17 17:24:50 2009 for DXMesh API by  doxygen 1.5.7.1