Detailed Description

See also:: Class NURBSCurve, Class Point2, Class Point3.

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

This class provides access to the Vector Projected Curve. A Vector Projected curve lies on a surface. This is almost the same as a Normal Projected curve, except that the projection from the existing curve to the surface is in the direction of a vector that you can control. Vector projected curves may be used for trimming.

#include <surf_api.h>

Inheritance diagram for NURBSProjectVectorCurve:

Public Member Functions
DllExport	NURBSProjectVectorCurve (void)
virtual DllExport	~NURBSProjectVectorCurve (void)
DllExport NURBSProjectVectorCurve &	operator= (const NURBSProjectVectorCurve &curve)
DllExport void	SetParent (int pnum, int index)
DllExport void	SetParentId (int pnum, NURBSId id)
DllExport int	GetParent (int pnum)
DllExport NURBSId	GetParentId (int pnum)
DllExport BOOL	GetTrim ()
DllExport void	SetTrim (BOOL trim)
DllExport BOOL	GetFlipTrim ()
DllExport void	SetFlipTrim (BOOL flip)
DllExport Point2	GetSeed ()
DllExport void	SetSeed (Point2 &seed)
DllExport void	SetPVec (TimeValue t, Point3 &pvec)
DllExport Point3 &	GetPVec (TimeValue t)
Friends
class	NURBSSet

Constructor & Destructor Documentation

DllExport NURBSProjectVectorCurve ( void )

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

mType = kNProjectVectorCurve;

mpObject = NULL;

mpNSet = NULL;

mParentId[0] = mParentId[1] = 0;

mParentIndex[0] = mParentIndex[1] = -1;

mTrim = FALSE;

mFlipTrim = FALSE;

mSeed = Point2(0.0, 0.0);

mPVec = Point3(0.0, 0.0, 1.0);

virtual DllExport ~NURBSProjectVectorCurve ( void ) [virtual]

Remarks:: Destructor.

Member Function Documentation

DllExport NURBSProjectVectorCurve& operator= ( const NURBSProjectVectorCurve & curve )

Remarks:: Assignment operator.

Parameters:: const NURBSProjectVectorCurve& curve

The curve to assign.

DllExport void SetParent	(	int	pnum,
		int	index
	)

Search for all occurrences

Remarks:

Parameters:: int pnum

Pass 0 for the surface and 1 for the curve.

int index

The index in the NURBSSet of the surface or curve.

DllExport void SetParentId	(	int	pnum,
		NURBSId	id
	)

Search for all occurrences

Remarks:: Sets the surface or curve used by specifying its NURBSId.

Parameters:: int pnum

Pass 0 for the surface and 1 for the curve.

NURBSId id

The id of the surface or curve.

DllExport int GetParent ( int pnum )

Search for all occurrences

Remarks:: Returns the index into the NURBSSet of surface or curve used.

Parameters:: int pnum

Pass 0 for the surface and 1 for the curve.

DllExport NURBSId GetParentId ( int pnum )

Search for all occurrences

Remarks:: Returns the NURBSId of surface or curve used.

Parameters:: int pnum

Pass 0 for the surface and 1 for the curve.

DllExport BOOL GetTrim ( )

Search for all occurrences

Remarks:: Returns the state of the trim flag. When set the surface is trimmed against the curve. When not set, the surface isn't trimmed

DllExport void SetTrim ( BOOL trim )

Search for all occurrences

Remarks:: Sets the state of the trim flag. When set the surface is trimmed against the curve. When not set, the surface isn't trimmed

Parameters:: BOOL trim

TRUE to trim; FALSE to not trim.

DllExport BOOL GetFlipTrim ( )

Search for all occurrences

Remarks:: Returns the state of the trim flip flag. When set this trims the surface in the opposite direction.

DllExport void SetFlipTrim ( BOOL flip )

Search for all occurrences

Remarks:: Sets the state of the trim flip flag. When set this trims the surface in the opposite direction

Parameters:: BOOL flip

TRUE to flip; FALSE to not flip.

DllExport Point2 GetSeed ( )

Search for all occurrences

Remarks:: Returns the UV location of the seed value on the surface.

DllExport void SetSeed ( Point2 & seed )

Search for all occurrences

Remarks:: Sets the UV location of the seed value on the surface. If there is a choice of projections, the projection closest to the seed point is the one used to create the curve.