FTK utility macros and defines.



Your Ad Here


Defines
#define  _ERRMSG(x)   _SI_PRINTF(_SI_TEXT("ERROR : %s\n"),x);
#define  _MSG(x)   _SI_PRINTF(_SI_TEXT("MSG : %s\n"),x);
#define  _SI_NEW(x, y)   { x = new y; _SI_ASSERT( x != NULL ); }
#define  _SI_DELETE(ptr)   { if ( ptr != NULL ) { delete ptr; ptr = NULL; } }
#define  _SI_DELETE_ARRAY(ptr)   {if ( ptr != NULL ) { delete [] ptr; ptr = NULL; } }
#define  _SI_CALL(x, y)   { if (result==SI_SUCCESS) { result = x;if(result != SI_SUCCESS){_ERRMSG(y);}}}

Typedefs
typedef void(*)  SI_WARNING_CALLBACK_FNC (SI_Char *, int)

Functions
XSICOREEXPORT void  si_splitpath (const SI_Char *, SI_Char *, SI_Char *, SI_Char *, SI_Char *)

Variables
int  variantType
int  tweakType
int  numElems
char   bVal
unsigned char   ubVal
short   sVal
unsigned short   usVal
int   nVal
unsigned int   unVal
float   fVal
double   dVal
int   lVal
unsigned int   ulVal
unsigned short *   p_boolVal
char *   p_bVal
unsigned char *   p_ubVal
short *   p_sVal
unsigned short *   p_usVal
int *   p_nVal
unsigned int *   p_unVal
float *   p_fVal
double *   p_dVal
int *   p_lVal
unsigned int *   p_ulVal
char *   p_cVal
char **   pp_cVal
void *   p_voidVal
union {
   unsigned short   boolVal
   char   bVal
   unsigned char   ubVal
   short   sVal
   unsigned short   usVal
   int   nVal
   unsigned int   unVal
   float   fVal
   double   dVal
   int   lVal
   unsigned int   ulVal
   unsigned short *   p_boolVal
   char *   p_bVal
   unsigned char *   p_ubVal
   short *   p_sVal
   unsigned short *   p_usVal
   int *   p_nVal
   unsigned int *   p_unVal
   float *   p_fVal
   double *   p_dVal
   int *   p_lVal
   unsigned int *   p_ulVal
   char *   p_cVal
   char **   pp_cVal
   void *   p_voidVal
}; 

Define Documentation

#define _ERRMSG ( x   )     _SI_PRINTF(_SI_TEXT("ERROR : %s\n"),x);

Prints error message x. Print location is platform dependent.

#define _MSG ( x   )     _SI_PRINTF(_SI_TEXT("MSG : %s\n"),x);

Prints message x. Print location is platform dependent.

#define _SI_NEW ( x,
y   )     { x = new y; _SI_ASSERT( x != NULL ); }

Creates a new instance of y and assigns it to x, making sure it is not NULL.

#define _SI_DELETE ( ptr   )     { if ( ptr != NULL ) { delete ptr; ptr = NULL; } }

Deletes ptr, if it is not NULL, and then assigns ptr to NULL.

#define _SI_DELETE_ARRAY ( ptr   )     {if ( ptr != NULL ) { delete [] ptr; ptr = NULL; } }

Deletes the array ptr, if it is not NULL, and then assigns ptr to NULL.

#define _SI_CALL ( x,
y   )     { if (result==SI_SUCCESS) { result = x;if(result != SI_SUCCESS){_ERRMSG(y);}}}

If result is SI_SUCCESS, then calls the function x, and assigns the the return to result. If the result is not SI_SUCCESS, prints out the error message y. result must be a defined varaible.

Typedef Documentation

typedef void(*) SI_WARNING_CALLBACK_FNC(SI_Char *, int)

< @-SI_Void is defines as 'void'.

Function Documentation

XSICOREEXPORT void si_splitpath ( const SI_Char *  ,
SI_Char *  ,
SI_Char *  ,
SI_Char *  ,
SI_Char *   
)

< @-SI_Void is defines as 'void'.

Variable Documentation

int variantType [inherited]

< @-SI_Int is defines as 'int'. This is the type of the value contained within this structure. (See Variant Parameter types).

int tweakType [inherited]

< @-SI_Int is defines as 'int'. This is the tweaking type for the structure. (See Variant Parameter Tweak types).

int numElems [inherited]

< @-SI_Int is defines as 'int'. This is used to determine how many elements an array contains (pointer types are arrays).

char bVal [inherited]

< @-SI_Byte is defined as 'char'. Used if TinyVariant::variantType is SI_VT_BYTE

char bVal [inherited]

< @-SI_Byte is defined as 'char'. Used if TinyVariant::variantType is SI_VT_BYTE

unsigned char ubVal [inherited]

< @-SI_UByte is defined as 'unsigned char'. Used if TinyVariant::variantType is SI_VT_UBYTE

unsigned char ubVal [inherited]

< @-SI_UByte is defined as 'unsigned char'. Used if TinyVariant::variantType is SI_VT_UBYTE

short sVal [inherited]

< @-SI_Short is defines as 'short'. Used if TinyVariant::variantType is SI_VT_SHORT

short sVal [inherited]

< @-SI_Short is defines as 'short'. Used if TinyVariant::variantType is SI_VT_SHORT

unsigned short usVal [inherited]

< @-SI_UShort is defines as 'unsigned short'. Used if TinyVariant::variantType is SI_VT_USHORT

unsigned short usVal [inherited]

< @-SI_UShort is defines as 'unsigned short'. Used if TinyVariant::variantType is SI_VT_USHORT

int nVal [inherited]

< @-SI_Int is defines as 'int'. Used if TinyVariant::variantType is SI_VT_INT

int nVal [inherited]

< @-SI_Int is defines as 'int'. Used if TinyVariant::variantType is SI_VT_INT

unsigned int unVal [inherited]

< @-SI_UInt is defines as 'unsigned int'. Used if TinyVariant::variantType is SI_VT_UINT

unsigned int unVal [inherited]

< @-SI_UInt is defines as 'unsigned int'. Used if TinyVariant::variantType is SI_VT_UINT

float fVal [inherited]

< @-SI_Float is defines as 'float'. Used if TinyVariant::variantType is SI_VT_FLOAT

float fVal [inherited]

< @-SI_Float is defines as 'float'. Used if TinyVariant::variantType is SI_VT_FLOAT

double dVal [inherited]

< @-SI_Double is defines as 'double'. Used if TinyVariant::variantType is SI_VT_DOUBLE

double dVal [inherited]

< @-SI_Double is defines as 'double'. Used if TinyVariant::variantType is SI_VT_DOUBLE

int lVal [inherited]

< @-SI_Long is defines as 'long'. Used if TinyVariant::variantType is SI_VT_LONG

int lVal [inherited]

< @-SI_Long is defines as 'long'. Used if TinyVariant::variantType is SI_VT_LONG

unsigned int ulVal [inherited]

< @-SI_ULong is defines as 'unsigned long'. Used if TinyVariant::variantType is SI_VT_ULONG

unsigned int ulVal [inherited]

< @-SI_ULong is defines as 'unsigned long'. Used if TinyVariant::variantType is SI_VT_ULONG

unsigned short* p_boolVal [inherited]

< @-SI_Bool is defined as 'unsigned short'. Used if TinyVariant::variantType is SI_VT_PBOOL

unsigned short* p_boolVal [inherited]

< @-SI_Bool is defined as 'unsigned short'. Used if TinyVariant::variantType is SI_VT_PBOOL

char* p_bVal [inherited]

< @-SI_Byte is defined as 'char'. Used if TinyVariant::variantType is SI_VT_PBYTE

char* p_bVal [inherited]

< @-SI_Byte is defined as 'char'. Used if TinyVariant::variantType is SI_VT_PBYTE

unsigned char* p_ubVal [inherited]

< @-SI_UByte is defined as 'unsigned char'. Used if TinyVariant::variantType is SI_VT_PUBYTE

unsigned char* p_ubVal [inherited]

< @-SI_UByte is defined as 'unsigned char'. Used if TinyVariant::variantType is SI_VT_PUBYTE

short* p_sVal [inherited]

< @-SI_Short is defines as 'short'. Used if TinyVariant::variantType is SI_VT_PSHORT

short* p_sVal [inherited]

< @-SI_Short is defines as 'short'. Used if TinyVariant::variantType is SI_VT_PSHORT

unsigned short* p_usVal [inherited]

< @-SI_UShort is defines as 'unsigned short'. Used if TinyVariant::variantType is SI_VT_PUSHORT

unsigned short* p_usVal [inherited]

< @-SI_UShort is defines as 'unsigned short'. Used if TinyVariant::variantType is SI_VT_PUSHORT

int* p_nVal [inherited]

< @-SI_Int is defines as 'int'. Used if TinyVariant::variantType is SI_VT_PINT

int* p_nVal [inherited]

< @-SI_Int is defines as 'int'. Used if TinyVariant::variantType is SI_VT_PINT

unsigned int* p_unVal [inherited]

< @-SI_UInt is defines as 'unsigned int'. Used if TinyVariant::variantType is SI_VT_PUINT

unsigned int* p_unVal [inherited]

< @-SI_UInt is defines as 'unsigned int'. Used if TinyVariant::variantType is SI_VT_PUINT

float* p_fVal [inherited]

< @-SI_Float is defines as 'float'. Used if TinyVariant::variantType is SI_VT_PFLOAT

float* p_fVal [inherited]

< @-SI_Float is defines as 'float'. Used if TinyVariant::variantType is SI_VT_PFLOAT

double* p_dVal [inherited]

< @-SI_Double is defines as 'double'. Used if TinyVariant::variantType is SI_VT_PDOUBLE

double* p_dVal [inherited]

< @-SI_Double is defines as 'double'. Used if TinyVariant::variantType is SI_VT_PDOUBLE

int* p_lVal [inherited]

< @-SI_Long is defines as 'long'. Used if TinyVariant::variantType is SI_VT_PLONG

int* p_lVal [inherited]

< @-SI_Long is defines as 'long'. Used if TinyVariant::variantType is SI_VT_PLONG

unsigned int* p_ulVal [inherited]

< @-SI_ULong is defines as 'unsigned long'. Used if TinyVariant::variantType is SI_VT_PULONG

unsigned int* p_ulVal [inherited]

< @-SI_ULong is defines as 'unsigned long'. Used if TinyVariant::variantType is SI_VT_PULONG

char* p_cVal [inherited]

Used if TinyVariant::variantType is SI_VT_PCHAR. Note: char is used instead of SI_Char, because SI_Char is platform dependent.

char* p_cVal [inherited]

Used if TinyVariant::variantType is SI_VT_PCHAR. Note: char is used instead of SI_Char, because SI_Char is platform dependent.

char** pp_cVal [inherited]

Used if TinyVariant::variantType is SI_VT_PPCHAR. Note: char is used instead of SI_Char, because SI_Char is platform dependent.

char** pp_cVal [inherited]

Used if TinyVariant::variantType is SI_VT_PPCHAR. Note: char is used instead of SI_Char, because SI_Char is platform dependent.

void* p_voidVal [inherited]

< @-SI_Void is defines as 'void'. Used if TinyVariant::variantType is SI_VT_VOID.

void* p_voidVal [inherited]

< @-SI_Void is defines as 'void'. Used if TinyVariant::variantType is SI_VT_VOID.

union { ... } [inherited]

This union contains entries corresponding to every possible variant data type. The method in which the parameter is accessed is dependent on TinyVariant::variantType.

unsigned short boolVal [inherited]

< @-SI_Bool is defined as 'unsigned short'. Used if TinyVariant::variantType is SI_VT_BOOL

Return to Softimage XSI Index


Your Ad Here