CSLNurbsSurface Class Reference

This class represents an SI_NurbsSurface template. More...

#include <NurbsSurface.h>

Inheritance diagram for CSLNurbsSurface:

CSLGeometry CSLPrimitive CSLTemplate CSIBCNode List of all members.

Public Types
enum   EParametrizationType {
  SI_UNIFORM,
  SI_NON_UNIFORM,
  SI_CHORD_LENGTH,
  SI_CENTRIPETAL
}
typedef CSLArrayProxy< SI_Float,
SI_Float, 1 > 		 CSLFloatArray
typedef CSLArrayProxy< CSIBCVector4D,
SI_Float, 4 > 		 CSLVector4DArray

Public Member Functions
  CSLNurbsSurface (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLNurbsSurface ()
virtual SI_Error  Fix ()
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()
SI_Int  GetUDegree ()
SI_Void  SetUDegree (SI_Int in_nValue)
SI_Int  GetVDegree ()
SI_Void  SetVDegree (SI_Int in_nValue)
SI_Bool  GetUClosedFlag ()
SI_Void  SetUClosedFlag (SI_Bool in_nValue)
SI_Bool  GetVClosedFlag ()
SI_Void  SetVClosedFlag (SI_Bool in_nValue)
EParametrizationType  GetParametrization ()
SI_Void  SetParametrization (EParametrizationType in_Type)
SI_Int  GetUKnotCount ()
CSLFloatArray *  GetUKnotList ()
SI_Float *  GetUKnotListPtr ()
SI_Int  GetVKnotCount ()
CSLFloatArray *  GetVKnotList ()
SI_Float *  GetVKnotListPtr ()
SI_Int  GetUControlPointCount ()
SI_Void  SetUControlPointCount (SI_Int in_nValue)
SI_Int  GetVControlPointCount ()
SI_Void  SetVControlPointCount (SI_Int in_nValue)
SI_Int  GetControlPointCount ()
CSLVector4DArray *  GetControlPointList ()
CSIBCVector4D *  GetControlPointListPtr ()
CSLNurbsProjection *  AddNurbsProjection ()
SI_Error  RemoveNurbsProjection (SI_Int in_nIndex)
SI_Error  RemoveNurbsProjection (CSLNurbsProjection *in_pToRemove)
SI_Error  ClearNurbsProjections ()
CSLNurbsProjection *  ConnectNurbsProjection (CSLNurbsProjection *in_pToConnect)
CSLNurbsProjection **  GetNurbsProjections ()
SI_Int  GetNurbsProjectionCount ()
CSLNurbsProjection *  FindNurbsProjection (SI_Char *in_szNurbsProjectionName)
CSLNurbsTrim *  AddNurbsTrim ()
SI_Error  RemoveNurbsTrim (SI_Int in_nIndex)
SI_Error  RemoveNurbsTrim (CSLNurbsTrim *in_pToRemove)
SI_Error  ClearNurbsTrims ()
CSLNurbsTrim *  ConnectNurbsTrim (CSLNurbsTrim *in_pToConnect)
CSLNurbsTrim **  GetNurbsTrims ()
SI_Int  GetNurbsTrimCount ()
CSLNurbsTrim *  FindNurbsTrim (SI_Char *in_szNurbsTrimName)

Detailed Description

This class represents an SI_NurbsSurface template.

Describes a single NURBS surface (see the SI_NurbsSurface template reference).

Member Typedef Documentation

typedef CSLArrayProxy<SI_Float, SI_Float, 1> CSLFloatArray

Proxy class that allows modifying a list of SI_Float like an array.

typedef CSLArrayProxy<CSIBCVector4D, SI_Float, 4> CSLVector4DArray

Proxy class that allows modifying a list of CSIBCVector4D objects like an array.

Member Enumeration Documentation

enum EParametrizationType

The EParametrizationType enum contains possible types for knot parametrization

Enumerator:
SI_UNIFORM  Uniform parametrization.
SI_NON_UNIFORM  Non-uniform parametrization.
SI_CHORD_LENGTH  Chord length parametrization.
SI_CENTRIPETAL  Centripetal parametrization.

Constructor & Destructor Documentation

CSLNurbsSurface ( 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 CSLNurbsSurface

virtual ~CSLNurbsSurface (  )  [virtual]

Destructor

Member Function Documentation

virtual SI_Error Fix (  )  [virtual]

Validates the content of this NURBS surface and fixes it if necessary

Returns:
whether the fix has been successful

Reimplemented from CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this NURBS surface instance with its IO layer representation

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

Reimplemented from CSLGeometry.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the template type of the NURBS surface

Return values:
CSLTemplate::SI_NURBS_SURFACE  the template type

Implements CSLTemplate.

SI_Int GetUDegree (  ) 

Returns the degree of the surface in the U direction.

Returns:
Degree value in U.

SI_Void SetUDegree ( SI_Int  in_nValue  ) 

Changes the degree of the surface in the U direction.

Parameters:
[in]  in_nValue  New degree value in U.

SI_Int GetVDegree (  ) 

Returns the degree of the surface in the V direction.

Returns:
Degree value in V.

SI_Void SetVDegree ( SI_Int  in_nValue  ) 

Changes the degree of the surface in the V direction.

Parameters:
[in]  in_nValue  New degree value in V.

SI_Bool GetUClosedFlag (  ) 

Returns the closed flag of the surface in the U direction.

Returns:
Closed flag in U.

SI_Void SetUClosedFlag ( SI_Bool  in_nValue  ) 

Changes the closed flag of the surface in the U direction.

Parameters:
[in]  in_nValue  New closed flag in U.

SI_Bool GetVClosedFlag (  ) 

Returns the closed flag of the surface in the V direction.

Returns:
Closed flag in V.

SI_Void SetVClosedFlag ( SI_Bool  in_nValue  ) 

Changes the closed flag of the surface in the V direction.

Parameters:
[in]  in_nValue  New closed flag in V.

EParametrizationType GetParametrization (  ) 

Returns the parametrization type of the surface.

Returns:
Parametrization type.

SI_Void SetParametrization ( EParametrizationType  in_Type  ) 

Changes the parametrization type of the surface.

Parameters:
[in]  in_Type  New parametrization type.

SI_Int GetUKnotCount (  ) 

Return the number of knots of the surface in the U direction.

Returns:
Number of knots in U.

CSLFloatArray* GetUKnotList (  ) 

Return the knot values array proxy in the U direction.

Returns:
Pointer to an array proxy of knots values in U.

SI_Float* GetUKnotListPtr (  ) 

Returns an array of SI_Float containing the knot values in the U direction.

Returns:
Array of knots values in U.

SI_Int GetVKnotCount (  ) 

Return the number of knots of the surface in the V direction.

Returns:
Number of knots in V.

CSLFloatArray* GetVKnotList (  ) 

Return the knot values array proxy in the V direction.

Returns:
Pointer to an array proxy of knots values in V.

SI_Float* GetVKnotListPtr (  ) 

Returns an array of SI_Float containing the knot values in the V direction.

Returns:
Array of knots values in V.

SI_Int GetUControlPointCount (  ) 

Returns the number of control points of the surface in the U direction.

Returns:
Number of control points in U.

SI_Void SetUControlPointCount ( SI_Int  in_nValue  ) 

Changes the number of control points of the surface in the U direction.

Parameters:
[in]  in_nValue  New number of control points in U.

SI_Int GetVControlPointCount (  ) 

Returns the number of control points of the surface in the V direction.

Returns:
Number of control points in V.

SI_Void SetVControlPointCount ( SI_Int  in_nValue  ) 

Changes the number of control points of the surface in the V direction.

Parameters:
[in]  in_nValue  New number of control points in V.

SI_Int GetControlPointCount (  ) 

Returns the total number of control points of the surface.

Returns:
Number of knots.

CSLVector4DArray* GetControlPointList (  ) 

Returns the control point values array proxy.

Returns:
Pointer to an array proxy of indexed normals.

CSIBCVector4D* GetControlPointListPtr (  ) 

Returns an array of SI_Float containing the control point values.

Returns:
Array of control point values.

CSLNurbsProjection* AddNurbsProjection (  ) 

Adds an nurbs projection to the nurbs surface

Note:
The scene must support 3.6 to add a nurbs projection
Returns:
Pointer to the newly added nurbs projection

SI_Error RemoveNurbsProjection ( SI_Int  in_nIndex  ) 

Removes a nurbs projection from the nurbs surface

Parameters:
[in]  in_nIndex  Index of the nurbs projection to remove
Returns:
Whether or not the nurbs projection could be removed

SI_Error RemoveNurbsProjection ( CSLNurbsProjection *  in_pToRemove  ) 

Removes an nurbs projection from the nurbs surface

Parameters:
[in]  in_pToRemove  Pointer to the nurbs projection to remove
Returns:
Whether or not the nurbs projection could be removed

SI_Error ClearNurbsProjections (  ) 

Removes all nurbs projections from the nurbs surface

Returns:
Whether or not the list could be cleared

CSLNurbsProjection* ConnectNurbsProjection ( CSLNurbsProjection *  in_pToConnect  ) 

Adds an exisiting nurbs projection to the nurbs surface

Parameters:
[in]  in_pToConnect  Pointer to the nurbs projection to add
Returns:
The added nurbs projection or null if it already exists in the list

CSLNurbsProjection** GetNurbsProjections (  ) 

Returns an array of all nurbs projection contained on this nurbs surface

Returns:
Pointer to the list
Note:
The scene must support 3.6 to add a nurbs projection

SI_Int GetNurbsProjectionCount (  ) 

Returns the total number of nurbs projections

Returns:
Number of nurbs projections

CSLNurbsProjection* FindNurbsProjection ( SI_Char *  in_szNurbsProjectionName  ) 

Searches for a given nurbs projection

Parameters:
[in]  in_szNurbsProjectionName  Name of the nurbs projection to look for
Returns:
Pointer to the nurbs projection or null if it cannot be found

CSLNurbsTrim* AddNurbsTrim (  ) 

Adds an nurbs trim to the nurbs surface

Returns:
Pointer to the newly added nurbs trim

SI_Error RemoveNurbsTrim ( SI_Int  in_nIndex  ) 

Removes a nurbs trim from the nurbs surface

Note:
The scene must support 3.6 to add a nurbs trim
Parameters:
[in]  in_nIndex  Index of the nurbs trim to remove
Returns:
Whether or not the nurbs trim could be removed

SI_Error RemoveNurbsTrim ( CSLNurbsTrim *  in_pToRemove  ) 

Removes an nurbs trim from the nurbs surface

Parameters:
[in]  in_pToRemove  Pointer to the nurbs trim to remove
Returns:
Whether or not the nurbs trim could be removed

SI_Error ClearNurbsTrims (  ) 

Removes all nurbs trims from the nurbs surface

Returns:
Whether or not the list could be cleared

CSLNurbsTrim* ConnectNurbsTrim ( CSLNurbsTrim *  in_pToConnect  ) 

Adds an exisiting nurbs trim to the nurbs surface

Parameters:
[in]  in_pToConnect  Pointer to the nurbs trim to add
Returns:
The added nurbs trim or null if it already exists in the list

CSLNurbsTrim** GetNurbsTrims (  ) 

Returns an array of all nurbs trims contained on this nurbs surface

Note:
The scene must support 3.6 to add a nurbs trim
Returns:
Pointer to the list

SI_Int GetNurbsTrimCount (  ) 

Returns the total number of nurbs trims

Returns:
Number of nurbs trims

CSLNurbsTrim* FindNurbsTrim ( SI_Char *  in_szNurbsTrimName  ) 

Searches for a given nurbs trim

Parameters:
[in]  in_szNurbsTrimName  Name of the nurbs trim to look for
Returns:
Pointer to the nurbs trim or null if it cannot be found

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