Detailed Description

See also:: Class NURBSObject, NURBSConst Types, Class Point3.

Description:: This class is available in release 2.0 and later only.

This class is used to create a dependent point that lies on a curve or relative to it.

The point can either be on the curve or off the curve. If it is on the curve, the U Position is the only control of its location. The U Position specifies a location along the curve (based on the curve's local U axis). There are three ways to displace the point's location relative to the U position:

Offset moves the point according to a relative (object space) X,Y,Z location.

Normal moves the point along the direction of the curve's normal. (Negative values move it opposite to the normal.)

U Position

Tangent moves the point along the tangent of the U Position.

All methods of this class are implemented by the system.

Data Members:: protected:

NURBSId mParentId;

The NURBSId of the parent curve.

int mParentIndex;

The index in the NURBSSet of the parent curve.

NURBSConstType mCType;

The type of constraint in use.

Point3 mOffset;

The offset amount.

float mNormal;

The distance along the normal.

float mUTangent;

The distance along the tangent.

double mUParam;

Specifies the point along the parent curve.

BOOL mTrimCurve;

The point that is constrained to the curve may be used to trim the curve.

BOOL mFlipTrim;

If TRUE the curve is trimmed from the point towards low parameter space. If FALSE the curve is trimmed from the point towards high parameter space.

#include <surf_api.h>

Inheritance diagram for NURBSCurveConstPoint:

Public Member Functions
DllExport	NURBSCurveConstPoint (void)
virtual DllExport	~NURBSCurveConstPoint (void)
DllExport NURBSCurveConstPoint &	operator= (const NURBSCurveConstPoint &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	SetOffset (TimeValue t, Point3 pt)
DllExport Point3	GetOffset (TimeValue t)
DllExport void	SetUParam (TimeValue t, double param)
DllExport double	GetUParam (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 BOOL	GetTrimCurve ()
DllExport void	SetTrimCurve (BOOL trim)
DllExport BOOL	GetFlipTrim ()
DllExport void	SetFlipTrim (BOOL flip)
Protected Member Functions
DllExport void	Clean (NURBSIdTab ids)
Protected Attributes
NURBSId	mParentId
int	mParentIndex
NURBSConstType	mCType
Point3	mOffset
float	mNormal
float	mUTangent
double	mUParam
BOOL	mTrimCurve
BOOL	mFlipTrim
Friends
class	NURBSSet

Constructor & Destructor Documentation

DllExport NURBSCurveConstPoint ( void )

Remarks:: Constructor. The data members are initialized as follows:

mType = kNCurveCPoint;

mpObject = NULL;

mpNSet = NULL;

mParentId = 0;

mParentIndex = -1;

mCType = kNConstOnObject;

mOffset = Point3(0,0,0);

mNormal = 0.0f;

mUTangent = 0.0f;

mUParam = 0.0;

mTrimCurve = FALSE;

mFlipTrim = FALSE;

virtual DllExport ~NURBSCurveConstPoint ( 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 NURBSCurveConstPoint& operator= ( const NURBSCurveConstPoint & pt )

Remarks:: Assignment operator.

Parameters:: const NURBSCurveConstPoint& pt

The point to assign.

DllExport void SetParent ( int index )

Search for all occurrences

Remarks:: Sets the parent index to the specified value.

Parameters:: int index

The parent index to set.

DllExport void SetParentId ( NURBSId id )

Search for all occurrences

Remarks:: Sets the parent ID to the specified value.

Parameters:: NURBSId id

The parent ID to set.

DllExport int GetParent ( void )

Search for all occurrences

Remarks:: Returns the parent index.

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 point type.

Parameters:: NURBSConstType type

Specifies the construction point type. See NURBSConst Types.

DllExport NURBSConstType GetPointType ( void )

Search for all occurrences

Remarks:: Returns the point type. See NURBSConst Types.

DllExport void SetOffset	(	TimeValue	t,
		Point3	pt
	)

Search for all occurrences

Remarks:: Sets the offset value at the specified time.

Parameters:: TimeValue t

Specifies the time at which the offset value is set.

Point3 pt

The offset to set in object space.

DllExport Point3 GetOffset ( TimeValue t )

Search for all occurrences

Remarks:: Returns the offset value in object space at the specified time.

Parameters:: TimeValue t

Specifies the time at which the offset value is returned.

DllExport void SetUParam	(	TimeValue	t,
		double	param
	)

Search for all occurrences

Remarks:: Sets the U Parameter for the point.

Parameters:: TimeValue t

Specifies the time at which the value is set.

double param

The U parameter to set.

DllExport double GetUParam ( TimeValue t )

Search for all occurrences

Remarks:: Returns the U parameter at the specified time.

Parameters:: TimeValue t

Specifies the time at which the value is returned.

DllExport void SetNormal	(	TimeValue	t,
		float	dist
	)

Search for all occurrences

Remarks:: Sets the normal distance at the specified time.

Parameters:: TimeValue t

Specifies the time at which the value is set.

float dist

The distance to set.

DllExport float GetNormal ( TimeValue t )

Search for all occurrences

Remarks:: Returns the distance along the normal at the specified time.

Parameters:: TimeValue t

Specifies the time at which the value is returned.

DllExport void SetUTangent	(	TimeValue	t,
		float	dist
	)

Search for all occurrences

Remarks:: Set the U tangent value at the specified time.

Parameters:: TimeValue t

Specifies the time at which the value is set.

float dist

The distance to set.

DllExport float GetUTangent ( TimeValue t )

Search for all occurrences

Remarks:: Returns the U tangent value at the specified time.

Parameters:: TimeValue t

Specifies the time at which the value is returned.

DllExport BOOL GetTrimCurve ( )

Search for all occurrences

Remarks:: Returns TRUE if this point is used to trim the curve and FALSE if it is not.

DllExport void SetTrimCurve ( BOOL trim )

Search for all occurrences

Remarks:: Sets the trim curve boolean.

Parameters:: BOOL trim

TRUE to indicate this point is used to trim the curve; FALSE to indicate the curve is not trimmed beyond the point.

DllExport BOOL GetFlipTrim ( )

Search for all occurrences

Remarks:: Returns the state of the flip trim boolean.

DllExport void SetFlipTrim ( BOOL flip )

Search for all occurrences

Remarks:: Sets the state of the flip trim boolean.

Parameters:: BOOL flip

TRUE to indicate the curve is trimmed from the point towards low parameter space. Use FALSE to indicate the curve is trimmed from the point towards high parameter space.