Public Member Functions | Protected Member Functions

MFnEnumAttribute Class Reference

Search for all occurrences

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.

Examples:

apiMeshCreator.cpp, buildRotationNode.cpp, GLSLShaderNode.cpp, meshOpNode.cpp, and quadricShape.cpp.

#include <MFnEnumAttribute.h>

Inheritance diagram for MFnEnumAttribute:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnEnumAttribute ()
 Destructor.
 MFnEnumAttribute ()
 Default constructor.
 MFnEnumAttribute (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (const MString &fullName, const MString &briefName, short defaultValue=0, MStatus *ReturnStatus=NULL)
 Creates an enumerated attribute object.
MStatus addField (const MString &fieldString, short index)
 Add a field (a string/index pair) to the enumeration.
MString fieldName (short index, MStatus *ReturnStatus=NULL) const
 Retrieve the string associated with a given index.
short fieldIndex (const MString &fieldString, MStatus *ReturnStatus=NULL) const
 Retrieve the index associated with a given string.
MStatus getMin (short &minValue) const
 Return the minimum value for this attribute.
MStatus getMax (short &maxValue) const
 Return the maximum value for this attribute.
MStatus setDefault (short index)
 Set a new default value for this enum attribute.
MStatus setDefault (const MString &fieldString)
 Set a new default value for this enum attribute.
MStatus getDefault (short &index) const
 Get the default value for the enum attribute.
MString defaultValue (MStatus *ReturnStatus=NULL) const
 Get the default value for the enum attribute.
 MFnEnumAttribute (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MStatus getDefault (MString &fieldString) const
 NO SCRIPT SUPPORT.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnEnumAttribute ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnEnumAttribute ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kEnumAttribute.

Reimplemented from MFnAttribute.

const char * className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnEnumAttribute".

Reimplemented from MFnAttribute.

MObject 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]fullNameThe full name of the attribute
[in]briefNameThe brief name of the attribute
[in]defaultValueThe default value of the attribute
[out]ReturnStatusStatus code for the operation.
Returns:
The newly created enumerated attribute object.
Status Codes:
Examples:
apiMeshCreator.cpp, buildRotationNode.cpp, GLSLShaderNode.cpp, meshOpNode.cpp, and quadricShape.cpp.
MStatus addField ( const MString fieldString,
short  index 
)

Add a field (a string/index pair) to the enumeration.

Parameters:
[in]fieldStringThe string describing the field
[in]indexThe index of the field
Returns:
Status code for the operation
Status Codes:
Examples:
apiMeshCreator.cpp, buildRotationNode.cpp, GLSLShaderNode.cpp, meshOpNode.cpp, and quadricShape.cpp.
MString fieldName ( short  index,
MStatus ReturnStatus = NULL 
) const

Retrieve the string associated with a given index.

Parameters:
[in]indexThe index of the string to look up
[out]ReturnStatusStatus code for the operation.
Returns:
The descriptive string corresponding to the given index
Status Codes:
short fieldIndex ( const MString fieldString,
MStatus ReturnStatus = NULL 
) const

Retrieve the index associated with a given string.

Parameters:
[in]fieldStringThe string describing the field.
[out]ReturnStatusStatus 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 getMin ( short &  minValue) const

Return the minimum value for this attribute.

Parameters:
[out]minValuethe minimum value for this attribute
Returns:
MStatus getMax ( short &  maxValue) const

Return the maximum value for this attribute.

Parameters:
[out]maxValuethe maximum value for this attribute
Returns:
MStatus setDefault ( short  index)

Set a new default value for this enum attribute.

Parameters:
[in]indexnew 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.
Examples:
GLSLShaderNode.cpp.
MStatus setDefault ( const MString fieldString)

Set a new default value for this enum attribute.

Parameters:
[in]fieldStringnew 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 getDefault ( short &  index) const

Get the default value for the enum attribute.

Parameters:
[out]indexdefault index value.
Returns:
MString defaultValue ( MStatus ReturnStatus = NULL) const

Get the default value for the enum attribute.

Parameters:
[out]ReturnStatusOptional status code. See below.
Returns:
the string value for the default enum
Status Codes:
MStatus getDefault ( MString fieldString) const

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]fieldStringthe string value for the default enum
Returns:

MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute
MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute MFnEnumAttribute