XSIParser.h File Reference

Defines the CXSIReturn, CdotXSIDict, and CXSIParser classes, as well as the global functions Callbacks for reading/writing and Utility for the parser . More...

#include <SIBCUtil.h>
#include <SIBCString.h>
#include "dotXSITemplate.h"
#include "CXSIFilter.h"

Go to the source code of this file.

Namespaces

namespace   xercesc_2_7

Classes

class   CXSIReturn
  Class used for the return of values from a nested parse if called explictly. More...
class   CdotXSIDict
  Class used for dictionary entries (binary format). More...
class   CXSIParser
  Main class for the Softimage parser. More...

Defines

#define  FORMAT_TEXT   0
#define  FORMAT_BINARY   1
#define  FORMAT_COLLADA   2
#define  OPEN_READ   0
#define  OPEN_WRITE   1

Functions

SI_Error  dotXSICB_ReadGeneric (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadCluster (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadConstraint (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadCustomPSet (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadEnvelope (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadFCurve (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadFileInfo (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadIKRoot (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadImageClip (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadLight (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadNurbsSurface (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadNurbsCurve (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadPatchSurface (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadPolygonList (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadScene (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadShape (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadTriangleList (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_ReadTriStrip (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate)
SI_Error  dotXSICB_WriteGeneric (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteCluster (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteConstraint (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteCustomPSet (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteEnvelope (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteFCurve (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteFileInfo (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteIKRoot (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteImageClip (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteNurbsSurface (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteNurbsCurve (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WritePatchSurface (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WritePolygonList (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteShape (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteTriangleList (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)
SI_Error  dotXSICB_WriteTriStrip (CXSIParser *i_pParser, CdotXSITemplate *i_pCurrentTemplate, CdotXSITemplate *i_pNewTemplate, SI_Int i_nLevel)


Detailed Description

Defines the CXSIReturn, CdotXSIDict, and CXSIParser classes, as well as the global functions Callbacks for reading/writing and Utility for the parser .

Copyright 2008 Autodesk, Inc. All rights reserved. Use of this software is subject to the terms of the Autodesk license agreement provided at the time of installation or download, or which otherwise accompanies this software in either electronic or hard copy form.


Define Documentation

#define FORMAT_TEXT   0

Text format

#define FORMAT_BINARY   1

Binary format

#define FORMAT_COLLADA   2

COLLADA format

#define OPEN_READ   0

Read file mode

#define OPEN_WRITE   1

Write file mode


Function Documentation

SI_Error dotXSICB_ReadGeneric ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a generic template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadCluster ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a cluster template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadConstraint ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a constraint template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadCustomPSet ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a CustomPset template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadEnvelope ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a Envelope template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadFCurve ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a FCurve template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadFileInfo ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a FileInfo template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadIKRoot ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a IKRoot template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadImageClip ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a ImageClip template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadLight ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a Light template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadNurbsSurface ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a NurbsSurface template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadNurbsCurve ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a NurbsCurve template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadPatchSurface ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a PatchSurface template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadPolygonList ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a PolygonList template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadScene ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a Scene template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadShape ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a Shape template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadTriangleList ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a TriangleList template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_ReadTriStrip ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate  
)

Reads a TriStrip template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
Returns:
Success/failure

SI_Error dotXSICB_WriteGeneric ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a Generic template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteCluster ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a Cluster template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteConstraint ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a Constraint template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteCustomPSet ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a CustomPSet template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteEnvelope ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a Envelope template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteFCurve ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a FCurve template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteFileInfo ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a FileInfo template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteIKRoot ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a IKRoot template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteImageClip ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a ImageClip template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteNurbsSurface ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a NurbsSurface template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteNurbsCurve ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a NurbsCurve template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WritePatchSurface ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a PatchSurface template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WritePolygonList ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a PolygonList template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteShape ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a Shape template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteTriangleList ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a TriangleList template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure

SI_Error dotXSICB_WriteTriStrip ( CXSIParser i_pParser,
CdotXSITemplate i_pCurrentTemplate,
CdotXSITemplate i_pNewTemplate,
SI_Int  i_nLevel  
)

Writes a TriStrip template

Parameters:
[in]  i_pParser  Parser used
[in]  i_pCurrentTemplate  Parent Template
[in]  i_pNewTemplate  New child template
[in]  i_nLevel  Depth
Returns:
Success/failure