NURBSRuledSurface Class Reference

#include <surf_api.h>

Class Description

See also

Class NURBSSurface.

Description:

This class defines a dependent ruled surface. A ruled surface is generated from two curve sub-objects. It lets you use curves to design the two opposite borders of a surface. Methods are available to get/set the indices of the parent surface in the NURBSSet and the parent Ids and to set the surface normal matching state of the surfaces.

All methods of this class are implemented by the system.

Inheritance diagram for NURBSRuledSurface:

Public Member Functions
DllExport	NURBSRuledSurface (void)
virtual DllExport	~NURBSRuledSurface (void)
DllExport NURBSRuledSurface &	operator= (const NURBSRuledSurface &surf)
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	SetFlip (int pnum, BOOL flip)
DllExport BOOL	GetFlip (int pnum)
DllExport void	SetCurveStartPoint (TimeValue t, int pnum, double startpoint)
DllExport double	GetCurveStartPoint (TimeValue t, int pnum)
Public Member Functions inherited from NURBSSurface
void *	GetSurfCache ()
void	SetSurfCache (void *pCache)
DllExport	NURBSSurface (void)
virtual DllExport	~NURBSSurface (void)
DllExport NURBSSurface &	operator= (const NURBSSurface &surf)
DllExport BOOL	Renderable ()
DllExport void	Renderable (BOOL state)
DllExport BOOL	FlipNormals ()
DllExport void	FlipNormals (BOOL state)
DllExport BOOL	GenerateUVs (int channel=0)
DllExport void	SetGenerateUVs (BOOL state, int channel=0)
DllExport int	MatID ()
DllExport void	MatID (int id)
DllExport Point2	GetTextureUVs (TimeValue t, int i, int channel=0)
DllExport void	SetTextureUVs (TimeValue t, int i, Point2 pt, int channel=0)
DllExport void	GetTileOffset (TimeValue t, float &ut, float &vt, float &uo, float &vo, float &a, int channel=0)
DllExport void	SetTileOffset (TimeValue t, float ut, float vt, float uo, float vo, float a, int channel=0)
DllExport NURBSTextureSurface &	GetTextureSurface (int channel)
DllExport void	SetTextureSurface (int channel, NURBSTextureSurface &texSurf)
DllExport int	NumChannels ()
DllExport int	GetChannelFromIndex (int index)
DllExport BOOL	IsClosedInU (void)
DllExport BOOL	IsClosedInV (void)
DllExport BOOL	Evaluate (TimeValue t, double u, double v, Point3 &pt, Point3 &dPdU, Point3 &dPdV)
DllExport BOOL	Evaluate (TimeValue t, double u, double v, Point3 &pt, Point3 &dPdU, Point3 &dPdV, Point3 &d2PdU2, Point3 &d2PdV2, Point3 &d2PdUdV)
DllExport void	GetParameterRange (TimeValue t, double &uMin, double &uMax, double &vMin, double &vMax)
DllExport BOOL	GetNURBSData (TimeValue t, int &degreeInU, int &degreeInV, int &numInU, int &numInV, NURBSCVTab &cvs, int &numKnotsInU, int &numKnotsInV, NURBSKnotTab &uKnots, NURBSKnotTab &vKnots)
DllExport BOOL	GetCLPTextureSurfaceData (TimeValue t, int channel, int &degreeInU, int &degreeInV, int &numInU, int &numInV, NURBSCVTab &cvs, int &numKnotsInU, int &numKnotsInV, NURBSKnotTab &uKnots, NURBSKnotTab &vKnots)
DllExport int	NumTrimLoops (TimeValue t)
DllExport int	NumCurvesInLoop (TimeValue t, int loop)
DllExport BOOL	Get2dTrimCurveData (TimeValue t, int loop, int curve, int &degree, int &numCVs, NURBSCVTab &cvs, int &numKnots, NURBSKnotTab &knots)
DllExport BOOL	Get3dTrimCurveData (TimeValue t, int loop, int curve, int &degree, int &numCVs, NURBSCVTab &cvs, int &numKnots, NURBSKnotTab &knots)
DllExport TessApprox *	GetProdTess (NURBSTessType type=kNTessSurface)
DllExport TessApprox *	GetViewTess (NURBSTessType type=kNTessSurface)
DllExport void	SetProdTess (TessApprox &tess, NURBSTessType type=kNTessSurface)
DllExport void	SetViewTess (TessApprox &tess, NURBSTessType type=kNTessSurface)
DllExport void	ClearViewTess (NURBSTessType type=kNTessSurface)
DllExport void	ClearProdTess (NURBSTessType type=kNTessSurface)
Public Member Functions inherited from NURBSObject
DllExport	NURBSObject (void)
virtual DllExport	~NURBSObject (void)
DllExport NURBSObject &	operator= (const NURBSObject &pt)
DllExport void	SetName (const MCHAR *name)
DllExport const MCHAR *	GetName (void)
DllExport NURBSType	GetType ()
DllExport NURBSKind	GetKind ()
DllExport NURBSId	GetId ()
DllExport void	SetId (NURBSId id)
DllExport void	SetNSet (NURBSSet *nset)
DllExport void	SetObject (Object *object)
DllExport Object *	GetMAXObject ()
DllExport NURBSSet *	GetNSet ()
DllExport int	GetIndex ()
DllExport BOOL	IsSelected ()
DllExport void	SetSelected (BOOL set)

Friends
class	NURBSSet

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
Protected Member Functions inherited from NURBSObject
DllExport void	Clean (NURBSIdTab ids)
Protected Attributes inherited from NURBSSurface
NURBSTextureChannelSet	mTextureChannelSet
BOOL	mFlipNormals
BOOL	mRenderable
int	mMatID
BOOL	mClosedInU
BOOL	mClosedInV
TessApprox *	mpVTess
TessApprox *	mpRTess
TessApprox *	mpRTessDisp
TessApprox *	mpVTessCurve
TessApprox *	mpRTessCurve
void *	mpSurfCache
Protected Attributes inherited from NURBSObject
MCHAR	mName [NURBS_NAME_SIZE]
NURBSType	mType
NURBSKind	mKind
NURBSId	mId
Object *	mpObject
NURBSSet *	mpNSet
BOOL	mSelected

Constructor & Destructor Documentation

DllExport NURBSRuledSurface

(

void

)

Remarks

Constructor. The data members are initialized as follows:

mType = kNRuledSurface;
mpObject = NULL;
mpNSet = NULL;
for (int i = 0; i < 2; i++)
{
    mParentId[i] = 0;
    mParentIndex[i] = -1;
    mFlip[i] = FALSE;
    mCurveStartParam[i] = 0.0;
}

virtual DllExport ~NURBSRuledSurface ( void  )

virtual

Remarks

Destructor.

Member Function Documentation

DllExport NURBSRuledSurface& operator=

(

const NURBSRuledSurface &

surf

)

Remarks

Assignment operator.

Parameters:

const NURBSRuledSurface& surf

The surface to assign.

DllExport void SetParent	(	int	pnum,
		int	index
	)

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 in the NURBSSet of the specified parent object.

DllExport void SetParentId	(	int	pnum,
		NURBSId	id
	)

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

)

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

)

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 SetFlip	(	int	pnum,
		BOOL	flip
	)

Remarks

This allows one to control the matching of parent surface normals when creating the ruled surface. For example, normally when you create a ruled surface between two parent curves you don't want a 'bow tie' surface (one with the ends rotated 180 degrees so it crosses on itself in the middle). If you simply match the parent normals you'll get a 'bow tie' surface. To prevent this you use this method to set a state indicating that one or the other should be flipped before it's used. In this way, when the ruled surface is created, a 'bow tie' won't occur.

Parameters:

int pnum

The number of the parent curve: 0 or 1.

BOOL flip

TRUE to match the parent surface normal; FALSE to not match it.

DllExport BOOL GetFlip

(

int

pnum

)

Remarks

Returns the flip state of the specified parent curve.

Parameters:

int pnum

The number of the parent curve: 0 or 1.

DllExport void SetCurveStartPoint	(	TimeValue	t,
		int	pnum,
		double	startpoint
	)

Remarks

Sets the start point for the specified parent curve. Note: This is only applicable if the parent is a closed curve.

Parameters:

TimeValue t

The time at which to set the start point.

int pnum

The number of the parent curve: 0 or 1.

double startpoint

The start point in the range 0.0 to 1.0.

DllExport double GetCurveStartPoint	(	TimeValue	t,
		int	pnum
	)

Remarks

Returns the start point for the specified parent curve. Note: This is only applicable if the parent is a closed curve.

Parameters:

TimeValue t

The time at which to get the start point.

int pnum

The number of the parent curve: 0 or 1.

Operators:

Friends And Related Function Documentation

friend class NURBSSet

friend