NURBSMirrorCurve Class Reference

#include <surf_api.h>

Inheritance diagram for NURBSMirrorCurve:

Public Member Functions
DllExport	NURBSMirrorCurve (void)
virtual DllExport	~NURBSMirrorCurve (void)
DllExport NURBSMirrorCurve &	operator= (const NURBSMirrorCurve &curve)
DllExport void	SetParent (int index)
DllExport void	SetParentId (NURBSId id)
DllExport int	GetParent (void)
DllExport NURBSId	GetParentId (void)
DllExport void	SetAxis (NURBSMirrorAxis axis)
DllExport NURBSMirrorAxis	GetAxis (void)
DllExport void	SetXForm (TimeValue t, Matrix3 &mat)
DllExport Matrix3 &	GetXForm (TimeValue t)
DllExport void	SetDistance (TimeValue t, double d)
DllExport double	GetDistance (TimeValue t)
Public Member Functions inherited from NURBSCurve
DllExport	NURBSCurve (void)
virtual DllExport	~NURBSCurve (void)
DllExport NURBSCurve &	operator= (const NURBSCurve &curve)
DllExport BOOL	IsClosed (void)
DllExport int	NumTrimPoints ()
DllExport NURBSTrimPoint	GetTrimPoint (TimeValue t, int i)
DllExport BOOL	Evaluate (TimeValue t, double u, Point3 &pt, Point3 &tangent)
DllExport void	GetParameterRange (TimeValue t, double &uMin, double &uMax)
DllExport BOOL	GetNURBSData (TimeValue t, int &degree, int &numCVs, NURBSCVTab &cvs, int &numKnots, NURBSKnotTab &knots)
DllExport int	MatID ()
DllExport void	MatID (int id)
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 () const
DllExport NURBSKind	GetKind () const
DllExport NURBSId	GetId () const
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...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
Protected Member Functions inherited from NURBSObject
DllExport void	Clean (NURBSIdTab ids)
Protected Attributes inherited from NURBSCurve
int	mMatID
Protected Attributes inherited from NURBSObject
MCHAR	mName [NURBS_NAME_SIZE]
NURBSType	mType
NURBSKind	mKind
NURBSId	mId
Object *	mpObject
NURBSSet *	mpNSet
BOOL	mSelected

Detailed Description

See also

Class NURBSCurve, NURBSMirrorAxis Types

Description:

This class defines a dependent mirror curve. A mirror curve is similar to a mirror object that you create using the Mirror tool (on the 3ds Max toolbar) or the Mirror modifier. It is the original curve relfected about one or two axes. Methods are available to get/set the parent index and id, to get/set the reflection axis, and to get/set the offset distance.

All methods of this class are implemented by the system.

Constructor & Destructor Documentation

NURBSMirrorCurve()

DllExport NURBSMirrorCurve

(

void

)

Remarks

Constructor. The data members are initialized as follows:

mType = kNMirrorCurve;

mpObject = NULL;

mpNSet = NULL;

mParentId = 0;

mParentIndex = -1;

mXForm.IdentityMatrix();

mAxis = kMirrorX;

mDistance = 0.0;

~NURBSMirrorCurve()

virtual DllExport ~NURBSMirrorCurve ( void  )

virtual

Remarks

Destructor.

Member Function Documentation

operator=()

DllExport NURBSMirrorCurve& operator=

(

const NURBSMirrorCurve &

curve

)

Remarks

Assignment operator.

Parameters:

const NURBSMirrorCurve& curve

The curve to assign.

SetParent()

DllExport void SetParent

(

int

index

)

Remarks

Sets the index in the NURBSSet of the parent object.

Parameters:

int index

The index into the NURBSSet of the parent curve.

SetParentId()

DllExport void SetParentId

(

NURBSId

id

)

Remarks

Sets the NURBSId of the specified parent.

Parameters:

NURBSId id

The id to set.

GetParent()

DllExport int GetParent

(

void

)

Remarks

Returns the index in the NURBSSet of the parent object.

GetParentId()

DllExport NURBSId GetParentId

(

void

)

Remarks

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

SetAxis()

DllExport void SetAxis

(

NURBSMirrorAxis

axis

)

Remarks

Sets the axis or axes of reflection for the curve.

Parameters:

NURBSMirrorAxis axis

Specifies the axis or axes of reflection.

GetAxis()

DllExport NURBSMirrorAxis GetAxis

(

void

)

Remarks

Returns the axis or axes of reflection for the curve.

SetXForm()

DllExport void SetXForm	(	TimeValue	t,
		Matrix3 &	mat
	)

Remarks

This is an additional transformation applied to the axis specification. This corresponds to the gizmo they user may use interactively to alter the location of the mirror axis. This is exactly equivalent to setting the transform on the gizmo of a mirror modifier.

Parameters:

TimeValue t

The time at which to set the transformation.

Matrix3& mat

The transformation to set.

GetXForm()

DllExport Matrix3& GetXForm

(

TimeValue

t

)

Remarks

Returns the additional transformation applied to the mirror axis at the specified time.

Parameters:

TimeValue t

The time at which to get the transformation matrix.

SetDistance()

DllExport void SetDistance	(	TimeValue	t,
		double	d
	)

Remarks

Sets the offset distance of the curve.

Parameters:

TimeValue t

The time at which to set the distance.

double d

The distance to set.

GetDistance()

DllExport double GetDistance

(

TimeValue

t

)

Remarks

Returns the offset distance of the curve.

Parameters:

TimeValue t

The time at which to get the distance.

Operators:

Friends And Related Function Documentation

NURBSSet

friend class NURBSSet

friend