CSIILPICFileDriver Class Reference

Softimage PIC file loader class. More...

#include <SIILPICFileDriver.h>

Inheritance diagram for CSIILPICFileDriver:

CSIBCPixMapDriver List of all members.

Public Member Functions

  CSIILPICFileDriver ()
virtual  ~CSIILPICFileDriver ()
virtual SI_Bool  Supported (CSIBCString &in_Filename)
virtual SI_Error  Load (CSIBCString &in_filename, CSIBCPixMap &in_PixMap)
virtual SI_Error  LoadFromMemory (void *in_pMemoryBlock, SI_Int in_lCount, CSIBCPixMap &in_PixMap)

Static Public Member Functions

static CSIILPICFileDriver Driver ()

Detailed Description

Softimage PIC file loader class.


Constructor & Destructor Documentation

CSIILPICFileDriver (  ) 

Constructor

virtual ~CSIILPICFileDriver (  )  [virtual]

Destructor


Member Function Documentation

virtual SI_Bool Supported ( CSIBCString in_Filename  )  [virtual]

Returns whether the extension in the specified filename is supported by this driver

Parameters:
in_Filename  file name to check
Returns:
TRUE if this file is supported

FALSE otherwise

Implements CSIBCPixMapDriver.

virtual SI_Error Load ( CSIBCString in_filename,
CSIBCPixMap &  in_PixMap  
) [virtual]

Loads a Softimage Picture File Format file into a CSIBCPixMap object

Parameters:
in_filename  PIC file name
in_PixMap  CSIBCPixMap object to load the file into
Returns:
SI_Error::SI_SUCCESS loading has been succesful

SI_Error::SI_ERR_ERROR_MSG loading has failed

SI_Error::SI_FILE_NOT_FOUND the file has not been found

Implements CSIBCPixMapDriver.

virtual SI_Error LoadFromMemory ( void *  in_pMemoryBlock,
SI_Int  in_lCount,
CSIBCPixMap &  in_PixMap  
) [virtual]

Loads a PIC file from memory into a CSIBCPixMap object

Parameters:
in_pMemoryBlock  memory block
in_lCount  memory block size
in_PixMap  CSIBCPixMap object to load the file into
Returns:
SI_Error::SI_SUCCESS loading has been succesful

SI_Error::SI_ERR_ERROR_MSG loading has failed

SI_Error::SI_FILE_NOT_FOUND the file has not been found

Reimplemented from CSIBCPixMapDriver.

static CSIILPICFileDriver* Driver (  )  [static]

Returns the global PIC loader instance

Returns:
instance of loader


The documentation for this class was generated from the following file: