CSLCurveList Class Reference

This class represents an XSI_CurveList template. More...

#include <CurveList.h>

Inheritance diagram for CSLCurveList:

CSLPrimitive CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLCurveList (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLCurveList ()
CSLNurbsCurve *  AddCurve ()
SI_Int  GetCurveCount ()
CSLNurbsCurve **  Curves ()
SI_Error  RemoveCurve (SI_Int in_nIndex)
SI_Error  RemoveCurve (CSLNurbsCurve *in_pCurve)
SI_Error  ClearCurves ()
CSLNurbsCurve *  ConnectCurve (CSLNurbsCurve *in_pNewCurve)
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()

Detailed Description

This class represents an XSI_CurveList template.

Describes a list of NURBS curves (see the XSI_CurveList template reference).

Constructor & Destructor Documentation

CSLCurveList ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  Refered template
Returns:
an instance of CSLCurveList

virtual ~CSLCurveList (  )  [virtual]

Destructor

Member Function Documentation

CSLNurbsCurve* AddCurve (  ) 

Adds a new curve to the list.

Returns:
Pointer to the newly created curve.

SI_Int GetCurveCount (  ) 

Returns the number of curves in the list.

Returns:
Number of curves.

CSLNurbsCurve** Curves (  ) 

Returns an array of all curves in the list.

Returns:
Array of pointers to curve objects.

SI_Error RemoveCurve ( SI_Int  in_nIndex  ) 

Removes a single curve from the list.

Parameters:
[in]  in_nIndex  Index of the curve to remove.
Returns:
Error code.

SI_Error RemoveCurve ( CSLNurbsCurve *  in_pCurve  ) 

Removes a single curve from the list.

Parameters:
[in]  in_pCurve  Pointer to the curve to remove.
Returns:
Error code.

SI_Error ClearCurves (  ) 

Removes all curves from the list.

Returns:
Error code.

CSLNurbsCurve* ConnectCurve ( CSLNurbsCurve *  in_pNewCurve  ) 

Connects a NURBS curve to this curve list

Parameters:
[in]  in_pNewCurve  the new NURBS curve to connect
Returns:
the connected NURBS curve

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this curve list instance with its IO layer representation

Return values:
SI_Error::SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLTemplate.

virtual ETemplateType Type (  )  [virtual]

Returns the template type of the curve list

Returns:
CSLTemplate::SI_CURVE_LIST the template type

Implements CSLTemplate.

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