Class NURBSCapSurface

3DS Max Plug-In SDK

Class NURBSCapSurface

See Also: Class NURBSSurface.

class NURBSCapSurface : public NURBSSurface

Description:

This class is available in release 2.5 and later only.

This class provides access to the Cap Surface. A Cap Surface is a surface that caps a closed curve or the edge of a closed surface. Caps are especially useful with extruded surfaces.

Methods:

protected:

Prototype:

void Clean(NURBSIdTab ids);

Remarks:

This method is available in release 3.0 and later only.

This methods breaks the relation between this NURBSObject and a NURBSSet.

Parameters:

NURBSIdTab ids

A table with the IDs of each object in the NURBSSet.

public:

Prototype:

NURBSCapSurface(void);

Remarks:

Constructor. The data members are initialized as follows:

 mType = kNCapSurface;

 mpObject = NULL;

 mpNSet = NULL;

 mParentId = 0;

 mParentIndex = -1;

 mParentEdge = -1;

 mCurveStartParam = 0.0;

Prototype:

virtual ~NURBSCapSurface(void);

Remarks:

Destructor.

Prototype:

void SetParent(int index);

Remarks:

Establishes the curve or surface that's capped by specifying its index in the NURBSSet.

Parameters:

int index

The index in the NURBSSet of the curve or surface to cap.

Prototype:

void SetParentId(NURBSId id);

Remarks:

Establishes the curve or surface that's capped by specifying its NURBSId.

Parameters:

NURBSId id

The id of the curve or surface to cap.

Prototype:

int GetParent(void);

Remarks:

Returns the index in the NURBSSet of the curve or surface that's capped.

Prototype:

NURBSId GetParentId(void);

Remarks:

Returns the NURBSId of the curve or surface that's capped.

Prototype:

void SetEdge(int edge);

Remarks:

Establishes which edge of the closed parent surface is capped.

Parameters:

int edge

The edge to cap. One of the following values:

0: The low U edge.

1: The high U edge.

2: The low V edge.

3: The high V edge.

Prototype:

int GetEdge();

Remarks:

Returns the edge of the closed parent surface is capped.

Return Value:

One of the following values:

0: The low U edge.

1: The high U edge.

2: The low V edge.

3: The high V edge.

Prototype:

void SetCurveStartPoint(TimeValue t, double startpoint);

Remarks:

This method is available in release 3.0 and later only.

Sets the start point for the curve. Note: This is only applicable if the parent is a closed curve.

Parameters:

TimeValue t

The time to set the start point.

double startpoint

The start point to set.

Prototype:

double GetCurveStartPoint(TimeValue t);

Remarks:

This method is available in release 3.0 and later only.

Returns the start point for the curve. Note: This is only applicable if the parent is a closed curve.

Parameters:

TimeValue t

The time to get the start point.

Prototype:

NURBSCapSurface & operator=(const NURBSCapSurface& surf);

Remarks:

Assignment operator.

Parameters:

const NURBSCapSurface& surf

The surface to assign.