#include
<MFnDistanceManip.h>
List of all
members.
Detailed Description
DistanceManip function set.
The DistanceManip allows the user to manipulate a point that is
constrained to move along a line. This manipulator generates a
single floating point value. Scaling factors can be used to
determine how int the manipulator appears when it is drawn.
Constructor & Destructor Documentation
MFnDistanceManip::~MFnDistanceManip |
( |
|
) |
[virtual] |
Destructor.
Class destructor.
MFnDistanceManip::MFnDistanceManip |
( |
MObject & |
object, |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Constructor.
Class constructor that initializes the function set to the given
MObject.
- Parameters:
-
[in] |
object |
The MObject to
attach the function set to |
[out] |
ReturnStatus |
the return status |
- Status Codes:
-
MFnDistanceManip::MFnDistanceManip |
( |
const MDagPath & |
object, |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Constructor.
Class constructor that initializes the function set to the given
constant MDagPath object.
- Parameters:
-
[in] |
object |
The const MDagPath to attach the function set to |
[out] |
ReturnStatus |
The return status |
- Status Codes:
-
MFnDistanceManip::MFnDistanceManip |
( |
const MObject & |
object, |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Constructor.
Class constructor that initializes the function set to the given
MObject.
- Parameters:
-
[in] |
object |
The MObject to
attach the function set to |
[out] |
ReturnStatus |
the return status |
- Status Codes:
-
Member Function Documentation
MFn::Type
MFnDistanceManip::type |
( |
|
) |
const [virtual] |
const char * MFnDistanceManip::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnDistanceManip"
Reimplemented from MFnManip3D.
Creates a new DistanceManip. This function set's object is set
to be the new manipulator.
This method should only be used to create a non-composite
DistanceManip.
The name that appears in the feedback line is "Distance"
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
- Newly created DistanceManip
- Status Codes:
-
Creates a new DistanceManip. This function set's object is set
to be the new manipulator.
This method should only be used to create a non-composite
DistanceManip.
The name that appears in the feedback line is specified by the
distanceName argument.
- Parameters:
-
[in] |
manipName |
Name of the manip for UI purposes. |
[in] |
distanceName |
Label for the distance value which appears in the feedback
line. |
[out] |
ReturnStatus |
Status code. |
- Returns:
- Newly created DistanceManip.
- Status Codes:
-
Reimplemented from MFnDependencyNode.
MStatus
MFnDistanceManip::connectToDistancePlug |
( |
MPlug & |
distancePlug |
) |
|
Connect to the distance plug. The data type corresponding to the
distancePlug is a double. (Note that MFnUnitAttribute::kDistance is
used to specify a distance attribute.)
- Parameters:
-
[in] |
distancePlug |
the distance plug |
- Returns:
-
MStatus
MFnDistanceManip::setStartPoint |
( |
const MPoint & |
startPoint |
) |
|
Sets the start point of the DistanceManip.
- Parameters:
-
[in] |
startPoint |
the start point of the DistanceManip |
- Returns:
-
Sets the direction of the DistanceManip.
- Parameters:
-
[in] |
direction |
the direction of the DistanceManip |
- Returns:
-
MStatus
MFnDistanceManip::setDrawStart |
( |
bool |
state |
) |
|
Sets whether or not to draw the start of the DistanceManip. The
start of the DistanceManip is indicated by a grey dot. By default
the start is not drawn.
- Parameters:
-
[in] |
state |
whether or not the start should be drawn |
- Returns:
-
MStatus
MFnDistanceManip::setDrawLine |
( |
bool |
state |
) |
|
Sets whether or not to draw a line from the start to the end of
the DistanceManip. By default the line is drawn.
- Parameters:
-
[in] |
state |
whether or not the line should be drawn |
- Returns:
-
MStatus
MFnDistanceManip::setScalingFactor |
( |
double |
scalingFactor |
) |
|
Sets the scaling factor. The scaling factor is used to determine
how int the DistanceManip appears when it is drawn. The default
scaling factor is 1.0.
- Parameters:
-
[in] |
scalingFactor |
the scaling factor |
- Returns:
-
bool MFnDistanceManip::isDrawStartOn |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns whether or not the start of the DistanceManip is being
drawn. By default the start is not drawn.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
-
- true the start of the DistanceManip is being drawn
- false the start of the DistanceManip is not being
drawn
- Status Codes:
-
bool MFnDistanceManip::isDrawLineOn |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns whether or not a line is being drawn from the start to
the end of the DistanceManip. By default the line is drawn.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
-
- true the line of the DistanceManip is being drawn
- false the line of the DistanceManip is not being
drawn
- Status Codes:
-
double MFnDistanceManip::scalingFactor |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the scaling factor. The scaling factor is used to
determine how int the DistanceManip appears when it is drawn.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
- Scaling factor
- Status Codes:
-
unsigned int
MFnDistanceManip::distanceIndex |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the index of the distance. The data type corresponding
to this index is a double.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
- Distance index
- Status Codes:
-
unsigned int
MFnDistanceManip::directionIndex |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the index of the direction. The data type corresponding
to this index is MFnNumericData::k3Double.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
- Direction index
- Status Codes:
-
unsigned int
MFnDistanceManip::startPointIndex |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the index of the start point of the DistanceManip. The
data type corresponding to this index is MFnNumericData::k3Double.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
- Start point index
- Status Codes:
-
unsigned int
MFnDistanceManip::currentPointIndex |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the index of the current point of the DistanceManip. The
data type corresponding to this index is MFnNumericData::k3Double.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
- Current point index
- Status Codes:
-