NURBSFilletSurface Class Reference

Search for all occurrences

#include <surf_api.h>

Inheritance diagram for NURBSFilletSurface:

---

Class Description

See also:

Class NURBSSurface.

Description:

This class provides access to the NURBS Fillet Surface. Methods are provided to get / set the parent surfaces, get / set the radius, and get / set the trim and trim flip settings.
protected:

Public Member Functions
DllExport	NURBSFilletSurface (void)
virtual DllExport	~NURBSFilletSurface (void)
DllExport NURBSFilletSurface &	operator= (const NURBSFilletSurface &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 Point2	GetSeed (int pnum)
DllExport void	SetSeed (int pnum, Point2 &seed)
DllExport BOOL	IsCubic ()
DllExport void	SetCubic (BOOL cubic)
DllExport float	GetRadius (TimeValue t, int rnum)
DllExport void	SetRadius (TimeValue t, int rnum, float radius)
DllExport BOOL	GetTrimSurface (int pnum)
DllExport void	SetTrimSurface (int pnum, BOOL trim)
DllExport BOOL	GetFlipTrim (int pnum)
DllExport void	SetFlipTrim (int pnum, BOOL flip)
Friends
class	NURBSSet

---

Constructor & Destructor Documentation

DllExport NURBSFilletSurface

(

void

)

Remarks:

Constructor. The data members are initialized as follows:

mType = kNFilletSurface;

mpObject = NULL;

mpNSet = NULL;

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

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

mRadius[0] = mRadius[1] = 10.0f;

mSeed[0] = mSeed[1] = Point2(0.0, 0.0);

mCubic = TRUE;

virtual DllExport ~NURBSFilletSurface

(

void

)

[virtual]

Remarks:

Destructor.

---

Member Function Documentation

DllExport NURBSFilletSurface& operator=

(

const NURBSFilletSurface &

curve

)

Remarks:

Assignment operator.

Parameters:

const NURBSFilletSurface& curve

The surface to assign.

DllExport void SetParent	(	int	pnum,
		int	index
	)

Search for all occurrences

Remarks:

Sets the specified parent surface (by NURBSSet index) for the fillet.

Parameters:

int pnum

The parent surface: 0 or 1.

int index

The index in the NURBSSet.

DllExport void SetParentId	(	int	pnum,
		NURBSId	id
	)

Search for all occurrences

Remarks:

Sets the specified parent surface (by NURBSId) for the fillet.

Parameters:

int pnum

The parent surface: 0 or 1.

NURBSId id

The ID of the surface.

DllExport int GetParent

(

int

pnum

)

Search for all occurrences

Remarks:

Returns the index in the NURBSSet of the specified parent surface.

Parameters:

int pnum

The parent surface: 0 or 1.

DllExport NURBSId GetParentId

(

int

pnum

)

Search for all occurrences

Remarks:

Returns the NURBSId of the specified parent surface.

Parameters:

int pnum

The parent surface: 0 or 1.

DllExport Point2 GetSeed

(

int

pnum

)

Search for all occurrences

Remarks:

Returns the UV location of the seed value on the specified surface.

Parameters:

int pnum

The parent surface: 0 or 1.

DllExport void SetSeed	(	int	pnum,
		Point2 &	seed
	)

Search for all occurrences

Remarks:

Sets the UV location of the seed value on the specified surface.

Parameters:

int pnum

The parent surface: 0 or 1.

Point2& seed

The seed value to set.

DllExport BOOL IsCubic

(

)

Search for all occurrences

Remarks:

Returns TRUE if the cubic setting is on; FALSE if off. When off, the radius is always linear. When on, the radius is treated as a cubic function, allowing it to change based on the parent surface's geometry.

DllExport void SetCubic

(

BOOL

cubic

)

Search for all occurrences

Remarks:

Sets the cubic setting to on or off.

Parameters:

BOOL cubic

TRUE for on; FALSE for off.

DllExport float GetRadius	(	TimeValue	t,
		int	rnum
	)

Search for all occurrences

Remarks:

Returns the specified radius at the time passed.

Parameters:

TimeValue t

The time at which to get the radius.

int rnum

Specifies which radius to get: 0 for start, 1 for end.

DllExport void SetRadius	(	TimeValue	t,
		int	rnum,
		float	radius
	)

Search for all occurrences

Remarks:

Sets the specified radius at the time passed.

Parameters:

TimeValue t

The time at which to set the radius.

int rnum

Specifies which radius to set: 0 for start, 1 for end.

float radius

The radius to set.

DllExport BOOL GetTrimSurface

(

int

pnum

)

Search for all occurrences

Remarks:

Returns the trim surface setting for the specified parent surface. TRUE if on (trims the parent surface at the edge of the fillet); FALSE if off.

Parameters:

int pnum

The parent surface: 0 or 1.

DllExport void SetTrimSurface	(	int	pnum,
		BOOL	trim
	)

Search for all occurrences

Remarks:

Sets the trim surface setting for the specified parent surface.

Parameters:

int pnum

The parent surface: 0 or 1.

BOOL trim

TRUE for on (trims the parent surface at the edge of the fillet); FALSE for off.

DllExport BOOL GetFlipTrim

(

int

pnum

)

Search for all occurrences

Remarks:

Returns the state of the trim flip setting. When set this reverses the direction of the trim.

Parameters:

int pnum

The parent surface: 0 or 1.

DllExport void SetFlipTrim	(	int	pnum,
		BOOL	flip
	)

Search for all occurrences

Remarks:

Sets the state of the trim flip setting. When set this reverses the direction of the trim.

Parameters:

int pnum

The parent surface: 0 or 1.

BOOL flip

TRUE for on; FALSE for off.

---

Friends And Related Function Documentation

friend class NURBSSet [friend]

Search for all occurrences

Reimplemented from NURBSObject.