NURBSMirrorSurface Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class NURBSSurface, NURBSMirrorAxis Types.

Description:

This class is available in release 2.0 and later only.

This class defines a dependent mirror surface. A mirror surface 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 surface relfected about one or two axes. Methods are available to get/set the indices of the parent surface in the NURBSSet and the parent Ids, to get/set the mirror axes, to get/set the mirror distance, and to set the transformation used to position the surface in the NURBSSet.

All methods of this class are implemented by the system.

#include <surf_api.h>

Inheritance diagram for NURBSMirrorSurface:

List of all members.

Public Member Functions
DllExport	NURBSMirrorSurface (void)
virtual DllExport	~NURBSMirrorSurface (void)
DllExport NURBSMirrorSurface &	operator= (const NURBSMirrorSurface &surf)
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)
Friends
class	NURBSSet

---

Constructor & Destructor Documentation

DllExport NURBSMirrorSurface

(

void

)

Remarks:

Constructor. The data members are initialized as follows:

mType = kNMirrorSurface;

mpObject = NULL;

mpNSet = NULL;

mParentId = 0;

mParentIndex = -1;

mXForm.IdentityMatrix();

mAxis = kMirrorX;

mDistance = 0.0;

virtual DllExport ~NURBSMirrorSurface

(

void

)

[virtual]

Remarks:

Destructor.

---

Member Function Documentation

DllExport NURBSMirrorSurface& operator=

(

const NURBSMirrorSurface &

surf

)

Remarks:

Assignment operator.

Parameters:

const NURBSMirrorSurface& surf

The surface to assign.

DllExport void SetParent

(

int

index

)

Search for all occurrences

Remarks:

Sets the index in the NURBSSet of the parent object.

Parameters:

int index

The index in the NURBSSet of the parent object

DllExport void SetParentId

(

NURBSId

id

)

Search for all occurrences

Remarks:

Sets the NURBSId of the parent object.

Parameters:

NURBSId id

The NURBSId of the parent object.

DllExport int GetParent

(

void

)

Search for all occurrences

Remarks:

Returns the index in the NURBSSet of the parent object.

DllExport NURBSId GetParentId

(

void

)

Search for all occurrences

Remarks:

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

DllExport void SetAxis

(

NURBSMirrorAxis

axis

)

Search for all occurrences

Remarks:

Sets the mirror axis to the specified constant.

Parameters:

NURBSMirrorAxis axis

The mirror axis to set.

DllExport NURBSMirrorAxis GetAxis

(

void

)

Search for all occurrences

Remarks:

Returns the axis or axes of reflection for the surface.

DllExport void SetXForm	(	TimeValue	t,
		Matrix3 &	mat
	)

Search for all occurrences

Remarks:

This is an additional transformation applied to the axis specification. This corresponds to the gizmo the 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.

DllExport Matrix3& GetXForm

(

TimeValue

t

)

Search for all occurrences

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.

DllExport void SetDistance	(	TimeValue	t,
		double	d
	)

Search for all occurrences

Remarks:

This is just like the offset parameter in the mirror modifier. It is an offset from the center of the local coordinate system for the mirror object that moves the mirror, in the direction specified by the mirror axis.

Parameters:

TimeValue t

The time at which to set the offset.

double d

The offset distance.

DllExport double GetDistance

(

TimeValue

t

)

Search for all occurrences

Remarks:

Returns the offset distance of the mirror at the specified time.

Parameters:

TimeValue t

The time at which to return the offset.

Operators:

---

Friends And Related Function Documentation

friend class NURBSSet [friend]

Search for all occurrences

Reimplemented from NURBSObject.