NURBSSurfConstPoint Class Reference

This reference page is linked to from the following overview topics: Parameter Ranges for Curves and Surfaces.

---

Search for all occurrences

---

Detailed Description

See also:

Class NURBSObject, NURBSConst Types.

Description:

This class is available in release 2.0 and later only.

This class is used to create a dependent point on a surface or related to it.

All methods of this class are implemented by the system.

Data Members:

protected:

NURBSId mParentId;

The NURBSId of the parent surface.

int mParentIndex;

The index in the NURBSSet of the parent surface.

NURBSConstType mCType;

The type of constraint used by the point.

Point3 mOffset;

The offset amount.

float mNormal;

The distance along the normal.

float mUTangent;

The positive tangent offset in U. At the location in parameter space of the constrained point is a tangent to the surface. This is the distance along the positive U tangent in parameter space.

double mUParam;

The point is constrained to exist on the parent surface. The surface itself is defined over a parameter range. The point is defined at a point in the parent surface parameter space. This is the location of the point in the parent surface parameter space in U.

float mVTangent;

This is the distance along the positive V tangent in parameter space.

double mVParam;

This is the location of the point in the parent surface parameter space in V.

#include <surf_api.h>

Inheritance diagram for NURBSSurfConstPoint:

List of all members.

Public Member Functions
DllExport	NURBSSurfConstPoint (void)
virtual DllExport	~NURBSSurfConstPoint (void)
DllExport NURBSSurfConstPoint &	operator= (const NURBSSurfConstPoint &pt)
DllExport void	SetParent (int index)
DllExport void	SetParentId (NURBSId id)
DllExport int	GetParent (void)
DllExport NURBSId	GetParentId (void)
DllExport void	SetPointType (NURBSConstType type)
DllExport NURBSConstType	GetPointType (void)
DllExport void	SetUParam (TimeValue t, double param)
DllExport double	GetUParam (TimeValue t)
DllExport void	SetVParam (TimeValue t, double param)
DllExport double	GetVParam (TimeValue t)
DllExport void	SetOffset (TimeValue t, Point3 pt)
DllExport Point3	GetOffset (TimeValue t)
DllExport void	SetNormal (TimeValue t, float dist)
DllExport float	GetNormal (TimeValue t)
DllExport void	SetUTangent (TimeValue t, float dist)
DllExport float	GetUTangent (TimeValue t)
DllExport void	SetVTangent (TimeValue t, float dist)
DllExport float	GetVTangent (TimeValue t)
Protected Member Functions
DllExport void	Clean (NURBSIdTab ids)
Protected Attributes
NURBSId	mParentId
int	mParentIndex
NURBSConstType	mCType
Point3	mOffset
float	mNormal
float	mUTangent
double	mUParam
float	mVTangent
double	mVParam
Friends
class	NURBSSet

---

Constructor & Destructor Documentation

DllExport NURBSSurfConstPoint

(

void

)

Remarks:

Constructor. The data members are initialized as follows:

mType = kNSurfaceCPoint;

mpObject = NULL;

mpNSet = NULL;

mParentId = 0;

mParentIndex = -1;

mCType = kNConstOnObject;

mOffset = Point3(0,0,0);

mNormal = 0.0f;

mUTangent = 0.0f;

mUParam = 0.0;

mVTangent = 0.0f;

mVParam = 0.0;

virtual DllExport ~NURBSSurfConstPoint

(

void

)

[virtual]

Remarks:

Destructor.

---

Member Function Documentation

DllExport void Clean

(

NURBSIdTab

ids

)

[protected]

Search for all occurrences

Remarks:

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.

Reimplemented from NURBSObject.

DllExport NURBSSurfConstPoint& operator=

(

const NURBSSurfConstPoint &

pt

)

Remarks:

Assignment operator.

Parameters:

const NURBSSurfConstPoint& pt

The point to assign.

DllExport void SetParent

(

int

index

)

Search for all occurrences

Remarks:

Sets the index in the NURBSSet of the parent object.

Parameters:

int index

The index into the NURBSSet of the parent surface.

DllExport void SetParentId

(

NURBSId

id

)

Search for all occurrences

Remarks:

Sets the NURBSId of the specified parent.

Parameters:

NURBSId id

The id to set.

DllExport int GetParent

(

void

)

Search for all occurrences

Remarks:

Returns the index in the NURBSSet of the parent object.

DllExport NURBSId GetParentId

(

void

)

Search for all occurrences

Remarks:

Returns the NURBSId of the parent. Note that a NURBSId won't be valid until the object has been instantiated in the scene

DllExport void SetPointType

(

NURBSConstType

type

)

Search for all occurrences

Remarks:

Sets the type of constrained point this is. See NURBSConst Types.

Parameters:

NURBSConstType type

The type of the constrained point.

DllExport NURBSConstType GetPointType

(

void

)

Search for all occurrences

Remarks:

Returns the type of constrained point this is. See NURBSConst Types

DllExport void SetUParam	(	TimeValue	t,
		double	param
	)

Search for all occurrences

Remarks:

Sets the position of the point in the parent U parameter space.

Parameters:

TimeValue t

The time to set the U parameter.

double param

The value to set.

DllExport double GetUParam

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the position of the point in the parent U parameter space.

Parameters:

TimeValue t

The time to get the U parameter.

DllExport void SetVParam	(	TimeValue	t,
		double	param
	)

Search for all occurrences

Remarks:

Sets the position of the point in the parent V parameter space.

Parameters:

TimeValue t

The time to set the U parameter.

double param

The value to set.

DllExport double GetVParam

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the position of the point in the parent V parameter space.

Parameters:

TimeValue t

The time to get the Vparameter.

DllExport void SetOffset	(	TimeValue	t,
		Point3	pt
	)

Search for all occurrences

Remarks:

Sets the offset of the point from the parent surface.

Parameters:

TimeValue t

The time at which to set the offset.

Point3 pt

The offset to set.

DllExport Point3 GetOffset

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the offset of the point from the parent surface at the specified time.

Parameters:

TimeValue t

The time at which to get the offset.

DllExport void SetNormal	(	TimeValue	t,
		float	dist
	)

Search for all occurrences

Remarks:

Sets the distance along the normal to the surface of the point at the specified time.

Parameters:

TimeValue t

The time at which to set the distance.

float dist

The distance to set.

DllExport float GetNormal

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the distance along the normal to the surface of the point at the specified time.

Parameters:

TimeValue t

The time at which to get the distance.

DllExport void SetUTangent	(	TimeValue	t,
		float	dist
	)

Search for all occurrences

Remarks:

Sets the distance along the U tangent of the point.

Parameters:

TimeValue t

The time at which to set the distance.

float dist

The distance to set.

DllExport float GetUTangent

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the distance along the U tangent of the point.

Parameters:

TimeValue t

The time at which to get the distance.

DllExport void SetVTangent	(	TimeValue	t,
		float	dist
	)

Search for all occurrences

Remarks:

Sets the distance along the V tangent of the point.

Parameters:

TimeValue t

The time at which to set the distance.

float dist

The distance to set.

DllExport float GetVTangent

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the distance along the V tangent of the point.

Parameters:

TimeValue t

The time at which to get the distance.

Operators:

---

Friends And Related Function Documentation

friend class NURBSSet [friend]

Search for all occurrences

Reimplemented from NURBSObject.

---

Member Data Documentation

NURBSId mParentId [protected]

Search for all occurrences

int mParentIndex [protected]

Search for all occurrences

NURBSConstType mCType [protected]

Search for all occurrences

Point3 mOffset [protected]

Search for all occurrences

float mNormal [protected]

Search for all occurrences

float mUTangent [protected]

Search for all occurrences

double mUParam [protected]

Search for all occurrences

float mVTangent [protected]

Search for all occurrences

double mVParam [protected]

Search for all occurrences