class MFnNumericAttribute

Jump to documentation

Inheritance:

MFnNumericAttribute < MFnAttribute < MFnBase

public members:

	MFnNumericAttribute ()
	MFnNumericAttribute ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnNumericAttribute ()
virtual MFn::Type	type () const
MObject	create ( const MString & fullName, const MString & briefName, MFnNumericData::Type unitType , double defaultValue =0, MStatus * ReturnStatus = NULL )
MObject	createColor ( const MString & fullName, const MString & briefName, MStatus * ReturnStatus = NULL )
MObject	createPoint ( const MString & fullName, const MString & briefName, MStatus * ReturnStatus = NULL )
MObject	createAddr ( const MString & fullName, const MString & briefName, void* defaultValue = NULL, MStatus * ReturnStatus = NULL )
MObject	create ( const MString & fullName, const MString & briefName, const MObject & child1, const MObject & child2, const MObject & child3 = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MFnNumericData::Type	unitType ( MStatus * ReturnStatus = NULL ) const
MObject	child ( unsigned int index, MStatus * ReturnStatus = NULL ) const
bool	hasMin ( MStatus * ReturnStatus = NULL) const
bool	hasMax ( MStatus * ReturnStatus = NULL) const
bool	hasSoftMin ( MStatus * ReturnStatus = NULL) const
bool	hasSoftMax ( MStatus * ReturnStatus = NULL) const
MStatus	getMin ( double& min1 ) const
MStatus	getMin ( double& min1, double& min2 ) const
MStatus	getMin ( double& min1, double& min2, double& min3 ) const
MStatus	getMax ( double& max1 ) const
MStatus	getMax ( double& max1, double& max2 ) const
MStatus	getMax ( double& max1, double& max2, double& max3 ) const
MStatus	getSoftMin ( double& min1 ) const
MStatus	getSoftMax ( double& max1 ) const
MStatus	setMin ( double min1 )
MStatus	setMin ( double min1, double min2 )
MStatus	setMin ( double min1, double min2, double min3 )
MStatus	setMax ( double max1 )
MStatus	setMax ( double max1, double max2 )
MStatus	setMax ( double max1, double max2, double max3 )
MStatus	setSoftMin ( double min1 )
MStatus	setSoftMax ( double max1 )
MStatus	getDefault ( bool & def1 )
MStatus	getDefault ( char & def1 )
MStatus	getDefault ( int & def1 )
MStatus	getDefault ( int & def1, int & def2 )
MStatus	getDefault ( int & def1, int & def2, int & def3 )
MStatus	getDefault ( float & def1 )
MStatus	getDefault ( float & def1, float & def2 )
MStatus	getDefault ( float & def1, float & def2, float & def3 )
MStatus	getDefault ( double & def1 )
MStatus	getDefault ( double & def1, double & def2 )
MStatus	getDefault ( double & def1, double & def2, double & def3 )
MStatus	getDefault ( double & def1, double & def2, double & def3, double & def4 )
MStatus	getDefault ( void*& def1 )
MStatus	setDefault ( bool def1 )
MStatus	setDefault ( char def1 )
MStatus	setDefault ( int def1 )
MStatus	setDefault ( int def1, int def2 )
MStatus	setDefault ( int def1, int def2, int def3 )
MStatus	setDefault ( float def1 )
MStatus	setDefault ( float def1, float def2 )
MStatus	setDefault ( float def1, float def2, float def3 )
MStatus	setDefault ( double def1 )
MStatus	setDefault ( double def1, double def2 )
MStatus	setDefault ( double def1, double def2, double def3 )
MStatus	setDefault ( double def1, double def2, double def3, double def4 )
MStatus	setDefault ( void* def1 )
	MFnNumericAttribute ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnAttribute:

public members:

virtual MFn::Type	type () const
enum	DisconnectBehavior kDelete delete array element on disconnect (array attributes only) kReset reset the attribute to its default on disconnect kNothing do nothing to the attribute's value on disconnect
bool	isReadable ( MStatus * ReturnStatus=NULL ) const
bool	isWritable ( MStatus * ReturnStatus=NULL ) const
bool	isConnectable ( MStatus * ReturnStatus=NULL ) const
bool	isStorable ( MStatus * ReturnStatus=NULL ) const
bool	isCached ( MStatus * ReturnStatus=NULL ) const
bool	isArray ( MStatus * ReturnStatus=NULL ) const
bool	indexMatters ( MStatus * ReturnStatus=NULL ) const
bool	isKeyable ( MStatus * ReturnStatus=NULL ) const
bool	isChannelBoxFlagSet ( MStatus * ReturnStatus=NULL ) const
bool	isHidden ( MStatus * ReturnStatus=NULL ) const
bool	isUsedAsColor ( MStatus * ReturnStatus=NULL ) const
bool	isIndeterminant ( MStatus * ReturnStatus=NULL ) const
bool	isRenderSource ( MStatus * ReturnStatus=NULL ) const
bool	isDynamic ( MStatus * ReturnStatus=NULL ) const
bool	isWorldSpace ( MStatus * ReturnStatus=NULL ) const
bool	isAffectsWorldSpace ( MStatus * ReturnStatus=NULL ) const
DisconnectBehavior	disconnectBehavior ( MStatus * ReturnStatus=NULL ) const
bool	usesArrayDataBuilder ( MStatus * ReturnStatus=NULL ) const
bool	internal ( MStatus * ReturnStatus=NULL ) const
MStatus	setReadable ( bool state )
MStatus	setWritable ( bool state )
MStatus	setConnectable ( bool state )
MStatus	setStorable ( bool state )
MStatus	setCached ( bool state )
MStatus	setArray ( bool state )
MStatus	setIndexMatters ( bool state )
MStatus	setKeyable ( bool state )
MStatus	setChannelBox ( bool state )
MStatus	setHidden ( bool state )
MStatus	setUsedAsColor ( bool state )
MStatus	setIndeterminant ( bool state )
MStatus	setRenderSource ( bool state )
MStatus	setWorldSpace ( bool state )
MStatus	setAffectsWorldSpace ( bool state )
MStatus	setDisconnectBehavior ( DisconnectBehavior behavior )
MStatus	setUsesArrayDataBuilder ( bool state )
MStatus	setInternal ( bool state )
bool	accepts ( MFnData::Type type , MStatus * ReturnStatus=NULL ) const
bool	accepts ( const MTypeId & id, MStatus * ReturnStatus=NULL ) const
MObject	parent ( MStatus * ReturnStatus=NULL) const
MStatus	setParent ( const MObject & parent )
MString	name ( MStatus * ReturnStatus=NULL ) const
MString	shortName ( MStatus * ReturnStatus=NULL ) const
MString	getAddAttrCmd ( bool useLongName = false, MStatus * status=NULL ) const
	public

Inherited from MFnBase:

public members:

virtual MFn::Type	type () const
bool	hasObj ( MFn::Type ) const
bool	hasObj ( const MObject & ) const
MObject	object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( MObject & object )
virtual MStatus	setObject ( const MObject & object )

Documentation

Description

MFnNumericAttribute is the function set for dependency node attributes that store one, two or three untyped numeric values. A numeric attribute supports both a "hard" maximum/minimum and a soft maximum/minimum. The soft maximum/minimum are used by the Attribute Editor as the limits on its slider, but values within the hard range can be typed in the input box.

As a convenience, MFnNumericAttribute will set the flags of child attributes as well when the flags of the parent attribute are set. This is important when creating a numeric pair or triplet. For example, if MFnNumericAttribute is used to create a 3 double attribute and the attribute is set to be keyable, then the three child attributes will also be marked as keyable.

Functions

MFnNumericAttribute:: MFnNumericAttribute ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnNumericAttribute:: MFnNumericAttribute ( MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

• object the MObject to attach the function set to
• ReturnStatus the return status
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnNumericAttribute:: MFnNumericAttribute ( const MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

• object the const MObject to attach the function set to
• ReturnStatus the return status
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnNumericAttribute:: ~MFnNumericAttribute ()

Description

The class destructor.

MFn::Type MFnNumericAttribute:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kNumericAttribute

MObject MFnNumericAttribute:: create ( const MString & full, const MString & brief, MFnNumericData::Type unitType , double defaultValue, MStatus * ReturnStatus)

Description

Create a new numeric attribute and return it as an MObject. If the attribute create is of a type that stores two or more values, then a compound attribute will be created. The names of child attributes will have "0", "1" and "2" appended to both the full and brief names. As well, each child will use the defaultValue parameter as its default.

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.

Arguments

• full the full (or long) name of the attribute
• brief the brief (or short) name of the attribute
• unitType an element of the MFnUnitAttribute::Type enum
• defaultValue the default value for the new attribute
• ReturnStatus
  • MS::kSuccess the new attribute was created successfully
  • MS::kFailure the new attribute was not created
  • MS::kInvalidParameter the type parameter was invalid

Return Value

• an MObject representing the new attribute

MObject MFnNumericAttribute:: createColor ( const MString & full, const MString & brief, MStatus * ReturnStatus)

Description

Create a new color attribute and return it as an MObject. The names of child attributes will have "r", "g" and "b" appended to both the full and brief names.

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.

Arguments

• full the full (or long) name of the attribute
• brief the brief (or short) name of the attribute
• ReturnStatus
  • MS::kSuccess the new attribute was created successfully
  • MS::kFailure the new attribute was not created
  • MS::kInvalidParameter the type parameter was invalid

Return Value

• an MObject representing the new attribute

MObject MFnNumericAttribute:: createPoint ( const MString & full, const MString & brief, MStatus * ReturnStatus)

Description

Create a new point attribute and return it as an MObject. The names of child attributes will have "x", "y" and "z" appended to both the full and brief names.

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.

Arguments

• full the full (or long) name of the attribute
• brief the brief (or short) name of the attribute
• ReturnStatus
  • MS::kSuccess the new attribute was created successfully
  • MS::kFailure the new attribute was not created
  • MS::kInvalidParameter the type parameter was invalid

Return Value

• an MObject representing the new attribute

MObject MFnNumericAttribute:: createAddr ( const MString & full, const MString & brief, void* defaultValue, MStatus * ReturnStatus)

Description

Create a new address attribute and return it as an MObject.

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.

Arguments

• full the full (or long) name of the attribute
• brief the brief (or short) name of the attribute
• defaultValue the default value for the new attribute
• ReturnStatus
  • MS::kSuccess the new attribute was created successfully
  • MS::kFailure the new attribute was not created
  • MS::kInvalidParameter the type parameter was invalid

Return Value

• an MObject representing the new attribute

MObject MFnNumericAttribute:: create ( const MString & full, const MString & brief, const MObject & child1, const MObject & child2, const MObject & child3, MStatus * ReturnStatus)

Description

Create a new numeric attribute and return it as an MObject. This form of the create method allows the creation of compound attributes out of numeric attributes. All attributes passed in must be of the same type (eg all of type kDouble). The child1, child2, and child3 (child3 can be ommitted if only two children are desired) parameters represent two numeric attributes created previous via the other form of the create method.

It is also possible to use angle and distance attributes created with MFnUnitAttribute. These attributes will act the same as a double attribute.

Arguments

• full the full (or int) name of the attribute
• brief the brief (or short) name of the attribute
• child1 an MObject representing an numeric attribute
• child2 an MObject representing an numeric attribute
• child3 an MObject representing an numeric attribute
• ReturnStatus
  • MS::kSuccess the new attribute was created successfully
  • MS::kFailure the new attribute was not created
  • MS::kInvalidParameter the given child objects were not all numeric attributes

Return Value

• an MObject representing the new attribute

MFnNumericData::Type MFnNumericAttribute:: unitType ( MStatus * ReturnStatus) const

Description

Return the unit type of this attribute.

Arguments

• ReturnStatus
  • MS::kSuccess the operation succeeded
  • MS::kObjectDoesNotExist this instance is not bound to an MObject

Return Value

• an element of the MFnNumericData::Type enum

MObject MFnNumericAttribute:: child ( unsigned int index, MStatus * ReturnStatus ) const

Description

Return the indicated child attribute as an MObject. No index checking is done by this routine, so you must ensure that the index provided is valid.

Arguments

• index the full (or int) name of the attribute
• ReturnStatus
  • MS::kSuccess the operation was successful
  • MS::kFailure the attribute is not a compound attribute
  • MS::kObjectDoesNotExist the attribute is not bound to an MObject

Return Value

• an MObject representing the child attribute

bool MFnNumericAttribute:: hasMin ( MStatus * ReturnStatus) const

Description

Determine whether or not this attribute has a minimum value set.

Arguments

• ReturnStatus
  • MS::kSuccess the operation succeeded
  • MS::kObjectDoesNotExist this instance is not bound to an MObject

Return Value

• true if the attribute has a minimum value, and false otherwise

bool MFnNumericAttribute:: hasMax ( MStatus * ReturnStatus) const

Description

Determine whether or not this attribute has a maximum value set.

Arguments

• ReturnStatus
  • MS::kSuccess the operation succeeded
  • MS::kObjectDoesNotExist this instance is not bound to an MObject

Return Value

• true if the attribute has a maximum value, and false otherwise

bool MFnNumericAttribute:: hasSoftMin ( MStatus * ReturnStatus) const

Description

Determine whether or not this double attribute has a soft minimum value set.

Arguments

• ReturnStatus
  • MS::kSuccess the operation succeeded
  • MS::kObjectDoesNotExist this instance is not bound to an MObject

Return Value

• true if the attribute has a soft minimum value, and false otherwise

bool MFnNumericAttribute:: hasSoftMax ( MStatus * ReturnStatus) const

Description

Determine whether or not this double attribute has a soft maximum value set.

Arguments

• ReturnStatus
  • MS::kSuccess the operation succeeded
  • MS::kObjectDoesNotExist this instance is not bound to an MObject

Return Value

• true if the attribute has a soft maximum value, and false otherwise

MStatus MFnNumericAttribute:: getMin ( double& min ) const

Description

Return the minimum value for this double attribute.

Arguments

• min the minimum value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kFailure the attribute does not have a minimum
• MS::kObjectDoesNotExist this instance is not bound to an MObject

MStatus MFnNumericAttribute:: getMin ( double& min1, double& min2 ) const

Description

Return the minimum values for the two children (both double attributes) of this compound attribute.

Arguments

• min1 the minimum value for the first child attribute
• min2 the minimum value for the second child attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kFailure the attribute does not have a minimum
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or the attribute is not a compound attribute.

MStatus MFnNumericAttribute:: getMin ( double& min1, double& min2, double &min3 ) const

Description

Return the minimum values for the three children (all double attributes) of this compound attribute.

Arguments

• min1 the minimum value for the first child attribute
• min2 the minimum value for the second child attribute
• min3 the minimum value for the third child attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kFailure the attribute does not have a minimum
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or the attribute is not a compound attribute.

MStatus MFnNumericAttribute:: getMax ( double& max ) const

Description

Return the maximum value for this double attribute.

Arguments

• max the maximum value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kFailure the attribute does not have a maximum
• MS::kObjectDoesNotExist this instance is not bound to an MObject

MStatus MFnNumericAttribute:: getMax ( double& max1, double& max2 ) const

Description

Return the maximum values for the two children (both double attributes) of this compound attribute.

Arguments

• max1 the maximum value for the first child attribute
• max2 the maximum value for the second child attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kFailure the attribute does not have a maximum
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or the attribute is not a compound attribute.

MStatus MFnNumericAttribute:: getMax ( double& max1, double& max2, double& max3 ) const

Description

Return the maximum values for the three children (all double attributes) of this compound attribute.

Arguments

• max1 the maximum value for the first child attribute
• max2 the maximum value for the second child attribute
• max3 the maximum value for the third child attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kFailure the attribute does not have a maximum
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or the attribute is not a compound attribute.

MStatus MFnNumericAttribute:: getSoftMin ( double& min ) const

Description

Return the minimum value for this double attribute.

Arguments

• min the minimum value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kFailure the attribute does not have a minimum
• MS::kObjectDoesNotExist this instance is not bound to an MObject

MStatus MFnNumericAttribute:: getSoftMax ( double& max ) const

Description

Return the maximum value for this double attribute.

Arguments

• max the soft maximum value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kFailure the attribute does not have a maximum
• MS::kObjectDoesNotExist this instance is not bound to an MObject

MStatus MFnNumericAttribute:: setMin ( double min )

Description

Set the minimum value for this double attribute.

Arguments

• min the minimum value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or this instance is not a numeric attribute

MStatus MFnNumericAttribute:: setMin ( double min1, double min2 )

Description

Set the minimum values for the two children (both double attributes) of this compound attribute.

Arguments

• min1 the minimum value for the first child attribute
• min2 the minimum value for the second child attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or the attribute is not a compound attribute.

MStatus MFnNumericAttribute:: setMin ( double min1, double min2, double min3 )

Description

Set the minimum values for the three children (all double attributes) of this compound attribute.

Arguments

• min1 the minimum value for the first child attribute
• min2 the minimum value for the second child attribute
• min3 the minimum value for the third child attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or the attribute is not a compound attribute.

MStatus MFnNumericAttribute:: setMax ( double max)

Description

Set the maximum value for this double attribute.

Arguments

• max the maximum value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or this instance is not a numeric attribute

MStatus MFnNumericAttribute:: setMax ( double max1, double max2 )

Description

Set the maximum values for the two children (both double attributes) of this compound attribute.

Arguments

• max1 the maximum value for the first child attribute
• max2 the maximum value for the second child attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or the attribute is not a compound attribute.

MStatus MFnNumericAttribute:: setMax ( double max1, double max2, double max3 )

Description

Set the maximum values for the three children (all double attributes) of this compound attribute.

Arguments

• max1 the maximum value for the first child attribute
• max2 the maximum value for the second child attribute
• max3 the maximum value for the third child attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or the attribute is not a compound attribute.

MStatus MFnNumericAttribute:: setSoftMin ( double min )

Description

Set the soft minimum value for this double attribute.

Arguments

• min the minimum value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or this instance is not a numeric attribute

MStatus MFnNumericAttribute:: setSoftMax ( double max)

Description

Set the soft maximum value for this double attribute.

Arguments

• max the soft maximum value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this instance is not bound to an MObject, or this instance is not a numeric attribute

MStatus MFnNumericAttribute:: getDefault ( bool & def1 )

Description

Get the default value for this boolean attribute.

Arguments

• def1 returns the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a boolean attribute

MStatus MFnNumericAttribute:: getDefault ( char & def1 )

Description

Get the default value for this character attribute.

Arguments

• def1 returns the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a char attribute

MStatus MFnNumericAttribute:: getDefault ( int & def1 )

Description

Gets the default value for this integral attribute. This method is used to get default values for attributes of type byte, short, int or int.

Arguments

• def1 returns the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a byte, short, int or int attribute

MStatus MFnNumericAttribute:: getDefault ( int & def1, int & def2 )

Description

Gets the default value for the integral attributes of the two children of this attribute. This method is used to query the default values for attributes of type byte, short, int or int.

Arguments

• def1 returns the default value for first child of this attribute
• def2 returns the default value for second child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a short, int or int attribute
• MS::kNotFound the attribute did not have exactly two children

MStatus MFnNumericAttribute:: getDefault ( int & def1, int & def2, int & def3 )

Description

Gets the default value for the integral attributes of the three children of this attribute. This method is used to get the default values for attributes of type byte, short, int or int.

Arguments

• def1 returns the default value for first child of this attribute
• def2 returns the default value for second child of this attribute
• def3 returns the default value for third child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a short, int or int attribute

MStatus MFnNumericAttribute:: getDefault ( float & def1 )

Description

Gets the default value for this float attribute.

Arguments

• def1 returns the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a float attribute

MStatus MFnNumericAttribute:: getDefault ( float & def1, float & def2 )

Description

Gets the default value for the float attributes of the two children of this attribute.

Arguments

• def1 returns the default value for first child of this attribute
• def2 returns the default value for second child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a float attribute

MStatus MFnNumericAttribute:: getDefault ( float & def1, float & def2, float & def3 )

Description

Gets the default value for the float attributes of the three children of this attribute.

Arguments

• def1 returns the default value for first child of this attribute
• def2 returns the default value for second child of this attribute
• def3 returns the default value for third child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a float attribute

MStatus MFnNumericAttribute:: getDefault ( double & def1 )

Description

Get the default value for this double attribute.

Arguments

• def1 returns the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a double attribute

MStatus MFnNumericAttribute:: getDefault ( double & def1, double & def2 )

Description

Gets the default value for the double attributes of the two children of this attribute.

Arguments

• def1 returns the default value for first child of this attribute
• def2 returns the default value for second child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a double attribute

MStatus MFnNumericAttribute:: getDefault ( double & def1, double & def2, double & def3 )

Description

Gets the default value for the double attributes of the three children of this attribute.

Arguments

• def1 returns the default value for first child of this attribute
• def2 returns the default value for second child of this attribute
• def3 returns the default value for third child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a double attribute

MStatus MFnNumericAttribute:: getDefault ( double & def1, double & def2, double & def3, double & def4 )

Description

Gets the default value for the double attributes of the four children of this attribute.

Arguments

• def1 returns the default value for first child of this attribute
• def2 returns the default value for second child of this attribute
• def3 returns the default value for third child of this attribute
• def4 returns the default value for fourth child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a double attribute

MStatus MFnNumericAttribute:: getDefault ( void* & def1 )

Description Get the default value for this address attribute.

Arguments

• def1 returns the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a boolean attribute

MStatus MFnNumericAttribute:: setDefault ( bool def1 )

Description

Set a new default value for this boolean attribute.

Arguments

• def1 new the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a boolean attribute

MStatus MFnNumericAttribute:: setDefault ( char def1 )

Description

Set a new default value for this character attribute.

Arguments

• def1 new the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a char attribute

MStatus MFnNumericAttribute:: setDefault ( int def1 )

Description

Set a new default value for this integral attribute. This method is used to set default values for byte, short, int or int attributes.

Arguments

• def1 new the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a byte, short, int or int attribute

MStatus MFnNumericAttribute:: setDefault ( int def1, int def2 )

Description

Set a new default value for the integral attributes of the two children of this attribute. This method is used to set default values for byte, short, int or int attributes.

Arguments

• def1 new the default value for first child of this attribute
• def2 new the default value for second child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a short, int or int attribute

MStatus MFnNumericAttribute:: setDefault ( int def1, int def2, int def3 )

Description

Set a new default value for the integral attributes of the three children of this attribute. This method is used to set default values for byte, short, int or int attributes.

Arguments

• def1 new the default value for first child of this attribute
• def2 new the default value for second child of this attribute
• def3 new the default value for third child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a short, int or int attribute

MStatus MFnNumericAttribute:: setDefault ( float def1 )

Description

Set a new default value for this float attribute.

Arguments

• def1 new the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a float attribute

MStatus MFnNumericAttribute:: setDefault ( float def1, float def2 )

Description

Set a new default value for the float attributes of the two children of this attribute.

Arguments

• def1 new the default value for first child of this attribute
• def2 new the default value for second child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a float attribute

MStatus MFnNumericAttribute:: setDefault ( float def1, float def2, float def3 )

Description

Set a new default value for the float attributes of the three children of this attribute.

Arguments

• def1 new the default value for first child of this attribute
• def2 new the default value for second child of this attribute
• def3 new the default value for third child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a float attribute

MStatus MFnNumericAttribute:: setDefault ( double def1 )

Description

Set a new default value for this double attribute.

Arguments

• def1 new the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a double attribute

MStatus MFnNumericAttribute:: setDefault ( double def1, double def2 )

Description

Set a new default value for the double attributes of the two children of this attribute.

Arguments

• def1 new the default value for first child of this attribute
• def2 new the default value for second child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a double attribute

MStatus MFnNumericAttribute:: setDefault ( double def1, double def2, double def3 )

Description

Set a new default value for the double attributes of the three children of this attribute.

Arguments

• def1 new the default value for first child of this attribute
• def2 new the default value for second child of this attribute
• def3 new the default value for third child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a double attribute

MStatus MFnNumericAttribute:: setDefault ( double def1, double def2, double def3, double def4 )

Description

Set a new default value for the double attributes of the four children of this attribute.

Arguments

• def1 new the default value for first child of this attribute
• def2 new the default value for second child of this attribute
• def3 new the default value for third child of this attribute
• def4 new the default value for fourth child of this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a double attribute

MStatus MFnNumericAttribute:: setDefault ( void* def1 )

Description Set a new default value for this address attribute.

Arguments

• def1 new the default value for this attribute

Return Value

• MS::kSuccess the operation succeeded
• MS::kObjectDoesNotExist this attribute is not bound to an MObject
• MS::kInvalidParameter this attribute is not a boolean attribute

This class has no child classes.