NURBSFilletCurve Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class NURBSCurve.

Description:

This class is available in release 2.0 and later only.

This class defines a dependent fillet curve. A fillet is a curve that creates a circular arc corner between two parent curves. Methods are available to get/set the parent indices and ids, get/set the trim state of the curves, get/set which ends of the curves are used, and get/set the radius of the fillet.

All methods of this class are implemented by the system.

#include <surf_api.h>

Inheritance diagram for NURBSFilletCurve:

List of all members.

Public Member Functions
DllExport	NURBSFilletCurve (void)
virtual DllExport	~NURBSFilletCurve (void)
DllExport NURBSFilletCurve &	operator= (const NURBSFilletCurve &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	SetRadius (TimeValue t, double radius)
DllExport double	GetRadius (TimeValue t)
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 NURBSFilletCurve

(

void

)

Remarks:

Constructor. The data members are initialized as follows:

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

virtual DllExport ~NURBSFilletCurve

(

void

)

[virtual]

Remarks:

Destructor.

---

Member Function Documentation

DllExport NURBSFilletCurve& operator=

(

const NURBSFilletCurve &

curve

)

Remarks:

Assignment operator.

Parameters:

const NURBSFilletCurve& 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 curve.

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:

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 fillet. 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 SetRadius	(	TimeValue	t,
		double	radius
	)

Search for all occurrences

Remarks:

Sets the radius for the fillet at the specified time.

Parameters:

TimeValue t

The time at which to set the radius value.

double radius

The radius to set.

DllExport double GetRadius

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the radius of the fillet at the specified time.

Parameters:

TimeValue t

The time to return the fillet value.

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 fillet.

Parameters:

int pnum

The parent curve number: 0 or 1.

BOOL trim

TRUE to trim the curve beyond the fillet; 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.