CSLCurveList Class Reference

Describes a list of NURBS curve. 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

Describes a list of NURBS curve.


Constructor & Destructor Documentation

CSLCurveList ( CSLScene in_pScene,
CSLModel in_pModel,
CdotXSITemplate in_pTemplate  
)

Constructor

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

virtual ~CSLCurveList (  )  [virtual]

Destructor


Member Function Documentation

CSLNurbsCurve* AddCurve (  ) 

Add a new curve to the list.

Returns:
CSLNurbsCurve* Pointer to the newly created curve.

SI_Int GetCurveCount (  ) 

Return the number of curves in the list.

Returns:
SI_Int Number of curves.

CSLNurbsCurve** Curves (  ) 

Return an array of all curves in the list.

Returns:
CSLNurbsCurve** Array of pointers to curve objects.

SI_Error RemoveCurve ( SI_Int  in_nIndex  ) 

Remove a single curve from the list.

Parameters:
in_nIndex  Index of the curve to remove.
Returns:
SI_Error Error code.

SI_Error RemoveCurve ( CSLNurbsCurve in_pCurve  ) 

Remove a single curve from the list.

Parameters:
in_pCurve  Pointer to the curve to remove.
Returns:
SI_Error Error code.

SI_Error ClearCurves (  ) 

Remove all curves from the list.

Returns:
SI_Error Error code.

CSLNurbsCurve* ConnectCurve ( CSLNurbsCurve in_pNewCurve  ) 

Connects a NURBS curve to this curve list

Parameters:
in_pNewCurve  the new NURBS curve to connect
Returns:
CSLNurbsCurve* the connected NURBS curve

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this curve list instance with its IO layer representation

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

Reimplemented from CSLTemplate.

virtual ETemplateType Type (  )  [virtual]

Get the template type

Returns:
ETemplateType the template type of the curve list

Implements CSLTemplate.


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