CSIILPICFileDriver Class Reference



Your Ad Here

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

Returns:
an instance of CSIILPICFileDriver

virtual ~CSIILPICFileDriver (  )  [virtual]

Destructor

Member Function Documentation

virtual SI_Bool Supported ( CSIBCString &  in_Filename  )  [virtual]

tells whether the extension passed in the string is supported by this driver

Parameters:
in_Filename  file name to check
Returns:
SI_Bool
Return values:
TRUE  if this file is supported
FALSE  if this file is not supported

Implements CSIBCPixMapDriver.

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

Loads a bitmap file into a CSIBCPixMap object

Parameters:
in_filename  bitmap file name
in_PixMap  CSIBCPixMap object to load the file into
Returns:
SI_Error
Return values:
SI_SUCCESS  loading has been succesful
SI_ERR_ERROR_MSG  loading has failed
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 memory bitmap file 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
Return values:
SI_SUCCESS  loading has been succesful
SI_ERR_ERROR_MSG  loading has failed
SI_FILE_NOT_FOUND  the file has not been found

Reimplemented from CSIBCPixMapDriver.

static CSIILPICFileDriver* Driver (  )  [static]

returns the global PIC loader instance

Returns:
CSIILPICFileDriver*

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

Return to Softimage XSI Index


Your Ad Here