Detailed Description
- See also:
- Class NURBSCurve, NURBSMirrorAxis
Types.
- Description:
- This class is available in release 2.0 and later only.
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.
#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) |
Friends |
|
| class | NURBSSet |
Constructor & Destructor Documentation
| 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;
| virtual DllExport ~NURBSMirrorCurve | ( | void | ) | [virtual] |
- Remarks:
- Destructor.
Member Function Documentation
| DllExport NURBSMirrorCurve& operator= | ( | const NURBSMirrorCurve & | curve | ) |
- Remarks:
- Assignment operator.
- Parameters:
- const NURBSMirrorCurve&
curve
The curve to assign.
| DllExport void SetParent | ( | int | index | ) |
| DllExport void SetParentId | ( | NURBSId | id | ) |
- Remarks:
- Sets the NURBSId of the specified parent.
- Parameters:
- NURBSId id
The id to set.
| DllExport int GetParent | ( | void | ) |
- Remarks:
- Returns the index in the NURBSSet of the parent object.
| 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
| 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.
| DllExport NURBSMirrorAxis GetAxis | ( | void | ) |
- Remarks:
- Returns the axis or axes of reflection for the curve.
| 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.
| 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.
| 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.
| 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
friend class NURBSSet [friend] |
Reimplemented from NURBSObject.
