Detailed Description

See also:: Class NURBSCurve.

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

This class defines a dependent chamfer curve. A chamfer is a curve that creates a straight line corner between two parent curves. Methods are availalble to get/set the parent indices and ids, to get/set which ends of the curves are used for the chamfer, get/set the trim settings for each curve, and to get/set the length of the curve back from the selected end that represents the start of the chamfer.

All methods of this class are implemented by the system.

#include <surf_api.h>

Inheritance diagram for NURBSChamferCurve:

Public Member Functions
DllExport	NURBSChamferCurve (void)
virtual DllExport	~NURBSChamferCurve (void)
DllExport NURBSChamferCurve &	operator= (const NURBSChamferCurve &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 void	SetEnd (int pnum, BOOL end)
DllExport BOOL	GetEnd (int pnum)
DllExport void	SetLength (TimeValue t, int pnum, double length)
DllExport double	GetLength (TimeValue t, int pnum)
DllExport BOOL	GetTrimCurve (int pnum)
DllExport void	SetTrimCurve (int pnum, BOOL trim)
DllExport BOOL	GetFlipTrim (int pnum)
DllExport void	SetFlipTrim (int pnum, BOOL flip)
Friends
class	NURBSSet

Constructor & Destructor Documentation

DllExport NURBSChamferCurve ( void )

Remarks:

Constructor. The data members are initialized as follows:

    mType = kNChamferCurve;
    mpObject = NULL;
    mpNSet = NULL;
    for (int i = 0; i < 2; i++)
    {
        mParentId[i] = 0;
        mParentIndex[i] = -1;
        mParentEnd[i] = TRUE;
        mTrimCurve[i] = TRUE;
        mFlipTrim[i] = FALSE;
        mLength[i] = 0.0;
    }

virtual DllExport ~NURBSChamferCurve ( void ) [virtual]

Remarks:: Destructor. The cache is cleared.

Member Function Documentation

DllExport NURBSChamferCurve& operator= ( const NURBSChamferCurve & curve )

Remarks:: Assignment operator.

Parameters:: const NURBSChamferCurve& curve

The curve to assign.

DllExport void SetParent	(	int	pnum,
		int	index
	)

Search for all occurrences

Remarks:: Sets the index in the NURBSSet of the specified parent object.

Parameters:: int pnum

The parent number: 0 or 1.

int index

The index into the NURBSSet of the parent object.

DllExport void SetParentId	(	int	pnum,
		NURBSId	id
	)

Search for all occurrences

Remarks:: Sets the NURBSId of the specified parent.

Parameters:: int pnum

The parent number: 0 or 1.

NURBSId id

The id to set.

DllExport int GetParent ( int pnum )

Search for all occurrences

Remarks:: Returns the index in the NURBSSet of the specified parent object.

Parameters:: int pnum

The parent number: 0 or 1.

DllExport NURBSId GetParentId ( int pnum )

Search for all occurrences

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

Parameters:: int pnum

The parent number: 0 or 1.

DllExport void SetEnd	(	int	pnum,
		BOOL	end
	)

Search for all occurrences

Remarks:: Sets which end of the specified curve is used for the chamfer.

Parameters:: int pnum

The parent number: 0 or 1.

BOOL end

TRUE to use the end of the curve; FALSE to use the beginning.

DllExport BOOL GetEnd ( int pnum )

Search for all occurrences

Remarks:: Returns which end of the specified curve is used for the chamfer. TRUE if the end of the curve is used; FALSE if the beginning is used.

Parameters:: int pnum

The parent curve number: 0 or 1.

DllExport void SetLength	(	TimeValue	t,
		int	pnum,
		double	length
	)

Search for all occurrences

Remarks:: Sets the length for the specified parent curve back from the end that defines the beginning of the chamfer, at the specified time.

Parameters:: TimeValue t

The time at which to set the chamfer length.

int pnum

The parent curve number: 0 or 1.

double length

The chamfer length to set.

DllExport double GetLength	(	TimeValue	t,
		int	pnum
	)

Search for all occurrences

Remarks:: Returns the length of the chamfer at the specified time.

Parameters:: TimeValue t

The time at which to return the chamfer length.

int pnum

The parent curve number: 0 or 1.

DllExport BOOL GetTrimCurve ( int pnum )

Search for all occurrences

Remarks:: Determines if the specified curve is trimmed beyond the fillet. TRUE if the curve is trimmed; otherwise FALSE.

Parameters:: int pnum

The parent curve number: 0 or 1.

DllExport void SetTrimCurve	(	int	pnum,
		BOOL	trim
	)

Search for all occurrences

Remarks:: Sets if the specified curve is trimmed beyond the chamfer.

Parameters:: int pnum

The parent curve number: 0 or 1.

BOOL trim

TRUE to trim the curve beyond the chamfer; otherwise FALSE.

DllExport BOOL GetFlipTrim ( int pnum )

Search for all occurrences

Remarks:: Returns the flip state for the specified curve.

Parameters:: int pnum

The parent curve number: 0 or 1.

Returns:: TRUE if flip is set; FALSE it not.

DllExport void SetFlipTrim	(	int	pnum,
		BOOL	flip
	)

Search for all occurrences

Remarks:: Sets the flip state for the specified curve.

Parameters:: int pnum

The parent curve number: 0 or 1.

BOOL flip

TRUE to flip; FALSE to not flip.

Operators:

Friends And Related Function Documentation

friend class NURBSSet [friend]

Search for all occurrences

Reimplemented from NURBSObject.

NURBSChamferCurve Class Reference

Detailed Description

Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation