#include
<MFnEnumAttribute.h>
List of all
members.
Detailed Description
Enumerated attribute function set.
Function set for enumerated attributes. These attributes accept
fields as input. Each field consists of a short and its associated
string, which is a descriptive name for the field.
Constructor & Destructor Documentation
MFnEnumAttribute::MFnEnumAttribute |
( |
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:
-
MFnEnumAttribute::MFnEnumAttribute |
( |
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
MFnEnumAttribute::type |
( |
|
) |
const [virtual] |
const char * MFnEnumAttribute::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnEnumAttribute"
Reimplemented from MFnAttribute.
MObject MFnEnumAttribute::create |
( |
const MString & |
fullName, |
|
|
const MString & |
briefName, |
|
|
short |
defaultValue = 0 , |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Creates an enumerated attribute object.
The create method needs to be called on a per node basis. That
means if you want to create and add the same attribute to multiple
nodes, you need to call the create method for each node to get a
unique MObject back.
If you call create just once and add the attribute to multiple
nodes, Maya will encounter a fatal error.
- Parameters:
-
[in] |
fullName |
The full name of the attribute |
[in] |
briefName |
The brief name of the attribute |
[in] |
defaultValue |
The default value of the attribute |
[out] |
ReturnStatus |
Status code for the operation. |
- Returns:
- The newly created enumerated attribute object.
- Status Codes:
-
MStatus MFnEnumAttribute::addField |
( |
const MString & |
fieldString, |
|
|
short |
index |
|
|
) |
|
|
|
Add a field (a string/index pair) to the enumeration
- Parameters:
-
[in] |
fieldString |
The string describing the field |
[in] |
index |
The index of the field |
- Returns:
- Status code for the operation
- Status Codes:
-
MString MFnEnumAttribute::fieldName |
( |
short |
index, |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
const |
Retrieve the string associated with a given index
- Parameters:
-
[in] |
index |
The index of the string to look up |
[out] |
ReturnStatus |
Status code for the operation. |
- Returns:
- The descriptive string corresponding to the given index
- Status Codes:
-
short MFnEnumAttribute::fieldIndex |
( |
const MString & |
fieldString, |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
const |
Retrieve the index associated with a given string.
- Parameters:
-
[in] |
fieldString |
The string describing the field. |
[out] |
ReturnStatus |
Status code for the operation. |
- Returns:
- The index associated with the given descriptive string.
- Status Codes:
-
- MS::kSuccess The
operation was successfully performed
- MS::kObjectDoesNotExist the attribute is not bound to an
MObject
MStatus MFnEnumAttribute::getMin |
( |
short & |
minValue |
) |
const |
Return the minimum value for this attribute.
- Parameters:
-
[out] |
minValue |
the minimum value for this attribute |
- Returns:
-
MStatus MFnEnumAttribute::getMax |
( |
short & |
maxValue |
) |
const |
Return the maximum value for this attribute.
- Parameters:
-
[out] |
maxValue |
the maximum value for this attribute |
- Returns:
-
MStatus MFnEnumAttribute::setDefault |
( |
short |
index |
) |
|
Set a new default value for this enum attribute.
- Parameters:
-
[in] |
index |
new the default value for this attribute |
- Returns:
-
- MS::kSuccess the
operation succeeded
- MS::kObjectDoesNotExist this attribute is not bound to
an MObject
- MS::kInvalidParameter
this attribute is not a enum attribute, or the given index
value is not valid.
Set a new default value for this enum attribute.
- Parameters:
-
[in] |
fieldString |
new the default value for this attribute |
- Returns:
-
- MS::kSuccess the
operation succeeded
- MS::kObjectDoesNotExist this attribute is not bound to
an MObject
- MS::kInvalidParameter
this attribute is not a enum attribute, or the given
string value does not exist in the enum
MStatus MFnEnumAttribute::getDefault |
( |
short & |
index |
) |
const |
Get the default value for the enum attribute.
- Parameters:
-
[out] |
index |
default index value. |
- Returns:
-
MString
MFnEnumAttribute::defaultValue |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Get the default value for the enum attribute.
- Parameters:
-
[out] |
ReturnStatus |
Optional status code. See below. |
- Returns:
- the string value for the default enum
- Status Codes:
-
NO SCRIPT SUPPORT.
Get the default value for the enum attribute.
Python Notes
This method is not supported in Python. Please see defaultValue()
- Parameters:
-
[out] |
fieldString |
the string value for the default enum |
- Returns:
-