NURBSControlVertex Class Reference

This reference page is linked to from the following overview topics: Using the API to Create and Modify 3ds Max NURBS Models, Accessing Details of NURBS Objects.

---

Search for all occurrences

---

Detailed Description

See also:

Class NURBSObject, Class NURBSSurface, Class NURBSSet, Class NURBSPoint, Class NURBSCurve, Class NURBSFuseSurfaceCV, Class NURBSFuseCurveCV.

Description:

This class is available in release 2.0 and later only.

This class represents a control vertex in a NURBS curve. Methods are available to get and set the point position, and get/set the weight.

All methods of this class are implemented by the system.

#include <surf_api.h>

Inheritance diagram for NURBSControlVertex:

List of all members.

Public Member Functions
DllExport	NURBSControlVertex (void)
virtual DllExport	~NURBSControlVertex (void)
DllExport NURBSControlVertex &	operator= (const NURBSControlVertex &cv)
DllExport BOOL	operator== (const NURBSControlVertex &cv)
DllExport BOOL	operator!= (const NURBSControlVertex &cv)
DllExport void	SetPosition (TimeValue t, Point3 pt)
DllExport void	SetPosition (TimeValue t, float x, float y, float z)
DllExport void	SetPosition (TimeValue t, double x, double y, double z)
DllExport Point3	GetPosition (TimeValue t)
DllExport void	GetPosition (TimeValue t, float &x, float &y, float &z)
DllExport void	GetPosition (TimeValue t, double &x, double &y, double &z)
DllExport void	SetWeight (TimeValue t, float wt)
DllExport void	SetWeight (TimeValue t, double wt)
DllExport void	GetWeight (TimeValue t, float &wt)
DllExport double	GetWeight (TimeValue t)
DllExport void	GetWeight (TimeValue t, double &wt)

---

Constructor & Destructor Documentation

DllExport NURBSControlVertex

(

void

)

Remarks:

Constructor. The name is set to NULL, the points are set to 0.0f and the weight is set to 1.0.

virtual DllExport ~NURBSControlVertex

(

void

)

[virtual]

Remarks:

Destructor.

---

Member Function Documentation

DllExport NURBSControlVertex& operator=

(

const NURBSControlVertex &

cv

)

Remarks:

Assignment operator.

Parameters:

const NURBSControlVertex& cv

The control vertex to assign.

DllExport BOOL operator==

(

const NURBSControlVertex &

cv

)

Remarks:

Equality operator. Compares if the coordinates and weight are the same.

Parameters:

const NURBSControlVertex& cv

The control vertex to compare.

Returns:

TRUE if the CVs are equal; otherwise FALSE.

DllExport BOOL operator!=

(

const NURBSControlVertex &

cv

)

Remarks:

Inequality operator. Compares if the coordinates or weight are not the same.

Parameters:

const NURBSControlVertex& cv

The control vertex to compare.

Returns:

TRUE if the CVs are not equal; otherwise FALSE.

DllExport void SetPosition	(	TimeValue	t,
		Point3	pt
	)

Search for all occurrences

Remarks:

Sets the position of the control vertex.

Parameters:

TimeValue t

The time to set the position.

Point3 pt

Specifies the position to set.

DllExport void SetPosition	(	TimeValue	t,
		float	x,
		float	y,
		float	z
	)

Search for all occurrences

Remarks:

Sets the position of the control vertex.

Parameters:

TimeValue t

The time to set the position.

float x, float y, float z

Specifies the position to set.

DllExport void SetPosition	(	TimeValue	t,
		double	x,
		double	y,
		double	z
	)

Search for all occurrences

Remarks:

Sets the position of the control vertex.

Parameters:

TimeValue t

The time to set the position.

double x, double y, double z

Specifies the position to set.

DllExport Point3 GetPosition

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the position of the control vertex.

Parameters:

TimeValue t

The time to get the position.

DllExport void GetPosition	(	TimeValue	t,
		float &	x,
		float &	y,
		float &	z
	)

Search for all occurrences

Remarks:

Retrieves the position of the control vertex.

Parameters:

TimeValue t

The time to get the position.

float& x

The X coordinates is returned here.

float& y

The Y coordinates is returned here.

float& z

The Z coordinates is returned here.

DllExport void GetPosition	(	TimeValue	t,
		double &	x,
		double &	y,
		double &	z
	)

Search for all occurrences

Remarks:

Retrieves the position of the control vertex.

Parameters:

TimeValue t

The time to get the position.

double& x

The X coordinates is returned here.

double& y

The Y coordinates is returned here.

double& z

The Z coordinates is returned here.

DllExport void SetWeight	(	TimeValue	t,
		float	wt
	)

Search for all occurrences

Remarks:

Sets the weight of the control vertex.

Parameters:

TimeValue t

The time to set the weight.

float wt

Specifies the weight to set. This is a value greater than zero. Larger values cause the CV to have a greater effect, thus the curve or surface will try to pass closer to the CV.

DllExport void SetWeight	(	TimeValue	t,
		double	wt
	)

Search for all occurrences

Remarks:

Sets the weight of the control vertex.

Parameters:

TimeValue t

The time to set the weight.

double wt

Specifies the weight to set. . This is a value greater than zero. Larger values cause the CV to have a greater effect, thus the curve or surface will try to pass closer to the CV.

DllExport void GetWeight	(	TimeValue	t,
		float &	wt
	)

Search for all occurrences

Remarks:

Retrieves the weight of the control vertex.

Parameters:

TimeValue t

The time to get the weight.

float& wt

The weight is returned here.

DllExport double GetWeight

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the weight of the control vertex.

Parameters:

TimeValue t

The time to get the weight.

DllExport void GetWeight	(	TimeValue	t,
		double &	wt
	)

Search for all occurrences

Remarks:

Retrieves the weight of the control vertex.

Parameters:

TimeValue t

The time to get the weight.

double& wt

The weight is returned here.

Operators: