Message attribute function set.
Function set for message attributes. A message attribute is a dependency node attribute that does not transmit data. Message attributes only exist to formally declare relationships between nodes. By connecting two nodes via message attributes, a relationship between those nodes is expressed. Message attribute connections can be traversed in the same manner as any other connection in the dependency graph. Message attributes cannot be stored as they do not contain data.
|
virtual MFn::Type | type () const |
| Function set type. More...
|
|
virtual | ~MFnMessageAttribute () |
| Destructor.
|
|
| MFnMessageAttribute () |
| Default constructor.
|
|
| MFnMessageAttribute (MObject &object, MStatus *ReturnStatus=NULL) |
| Constructor. More...
|
|
MObject | create (const MString &fullName, const MString &briefName, MStatus *ReturnStatus=NULL) |
| Creates a Message attribute object. More...
|
|
| MFnMessageAttribute (const MObject &object, MStatus *ReturnStatus=NULL) |
| Constructor. More...
|
|
virtual | ~MFnAttribute () |
| Destructor.
|
|
| MFnAttribute () |
| Default constructor.
|
|
| MFnAttribute (MObject &object, MStatus *ReturnStatus=NULL) |
| Constructor. More...
|
|
bool | isReadable (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is readable. More...
|
|
bool | isWritable (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is writable. More...
|
|
bool | isConnectable (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute accepts dependency graph connections. More...
|
|
bool | isStorable (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is to be stored when the node is saved to a file. More...
|
|
bool | isCached (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is cached locally in the node's data block. More...
|
|
bool | isArray (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute supports an array of data. More...
|
|
bool | indexMatters (MStatus *ReturnStatus=NULL) const |
| Determines whether the user must specify an index when connecting to this attribute, or whether the next available index can be used. More...
|
|
bool | isKeyable (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is keyable. More...
|
|
bool | isChannelBoxFlagSet (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute has its channel box flag set. More...
|
|
bool | isHidden (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is to hidden from the UI. More...
|
|
bool | isUsedAsColor (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is to be presented as a color in the UI. More...
|
|
bool | isIndeterminant (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is indeterminant. More...
|
|
bool | isRenderSource (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is a render source. More...
|
|
bool | isDynamic (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is a dynamic attribute. More...
|
|
bool | isExtension (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is an extension attribute. More...
|
|
bool | isWorldSpace (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is worldspace. More...
|
|
bool | isAffectsWorldSpace (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute affects worldspace. More...
|
|
bool | isUsedAsFilename (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is to be used as a filename. More...
|
|
bool | affectsAppearance (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute affects the appearance of the object when rendering in the viewport. More...
|
|
bool | isProxyAttribute (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute is a proxy attribute. More...
|
|
DisconnectBehavior | disconnectBehavior (MStatus *ReturnStatus=NULL) const |
| Returns the behavior of this attribute when it is disconnected. More...
|
|
bool | usesArrayDataBuilder (MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute uses an array data builder. More...
|
|
bool | internal (MStatus *ReturnStatus=NULL) const |
| Returns true if a node has internal member data representing this attribute. More...
|
|
MStatus | setReadable (bool state) |
| Sets whether this attribute should be readable. More...
|
|
MStatus | setWritable (bool state) |
| Sets whether this attribute should be writable. More...
|
|
MStatus | setConnectable (bool state) |
| Sets whether this attribute should allow dependency graph connections. More...
|
|
MStatus | setStorable (bool state) |
| Sets whether this attribute should be storable. More...
|
|
MStatus | setCached (bool state) |
| Sets whether the data for this attribute is cached locally in the node's data block. More...
|
|
MStatus | setArray (bool state) |
| Sets whether this attribute should have an array of data. More...
|
|
MStatus | setIndexMatters (bool state) |
| If the attribute is an array, then this method specifies whether to force the user to specify an index when connecting to this attribute, or to use the next available index. More...
|
|
MStatus | setKeyable (bool state) |
| Sets whether this attribute should accept keyframe data. More...
|
|
MStatus | setChannelBox (bool state) |
| Sets whether this attribute should appear in the channel box when the node is selected. More...
|
|
MStatus | setHidden (bool state) |
| Sets whether this attribute should be hidden from the UI. More...
|
|
MStatus | setUsedAsColor (bool state) |
| Sets whether this attribute should be presented as a color in the UI. More...
|
|
MStatus | setIndeterminant (bool state) |
| Sets whether this attribute is indeterminant. More...
|
|
MStatus | setRenderSource (bool state) |
| Sets whether this attribute should be used as a render source attribute. More...
|
|
MStatus | setWorldSpace (bool state) |
| Sets whether this attribute should be treated as worldspace. More...
|
|
MStatus | setAffectsWorldSpace (bool state) |
| Sets whether this attribute should affect worldspace. More...
|
|
MStatus | setUsedAsFilename (bool state) |
| Sets whether this attribute should be presented as a filename in the UI. More...
|
|
MStatus | setAffectsAppearance (bool state) |
| Sets whether this attribute affects the appearance of the object when rendering in the viewport. More...
|
|
MStatus | setProxyAttribute (bool state) |
| Sets whether this attribute is a proxy attribute. More...
|
|
MStatus | setDisconnectBehavior (DisconnectBehavior behavior) |
| Sets the disconnection behavior for this attribute. More...
|
|
MStatus | setUsesArrayDataBuilder (bool state) |
| Sets whether this attribute uses an array data builder. More...
|
|
MStatus | setInternal (bool state) |
| The function controls an attribute's data storage. More...
|
|
MStatus | setNiceNameOverride (const MString &localizedName) |
| Sets the localized string which should be used for this attribute in the UI. More...
|
|
bool | acceptsAttribute (const MFnAttribute &attr, MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute can accept a connection with the given attribute. More...
|
|
bool | accepts (MFnData::Type type, MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute can accept a connection of the given type. More...
|
|
bool | accepts (const MTypeId &id, MStatus *ReturnStatus=NULL) const |
| Returns true if this attribute can accept a connection of the given type. More...
|
|
MObject | parent (MStatus *ReturnStatus=NULL) const |
| Get the parent of this attribute, if it has one. More...
|
|
MString | name (MStatus *ReturnStatus=NULL) const |
| Returns the long name of the attribute. More...
|
|
MString | shortName (MStatus *ReturnStatus=NULL) const |
| Returns the short name of the attribute. More...
|
|
MString | getAddAttrCmd (bool useLongName=false, MStatus *status=NULL) const |
| Returns a string containing the addAttr command which would be required to recreate the attribute on a node. More...
|
|
MStatus | addToCategory (const MString &category) |
| Add the attribute to the named category. More...
|
|
MStatus | removeFromCategory (const MString &category) |
| Remove the attribute from the named category. More...
|
|
bool | hasCategory (const MString &category) const |
| Check to see if the attribute belongs to the named category. More...
|
|
MStatus | getCategories (MStringArray &ReturnStatus) const |
| Get all of the categories to which this attribute belongs. More...
|
|
| MFnAttribute (const MObject &object, MStatus *ReturnStatus=NULL) |
| NO SCRIPT SUPPORT. More...
|
|
virtual | ~MFnBase () |
| Class Destructor. More...
|
|
bool | hasObj (MFn::Type) const |
| Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
|
|
bool | hasObj (const MObject &) const |
| Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
|
|
MObject | object (MStatus *ReturnStatus=NULL) const |
| Returns the MObject that is attached to the Function Set. More...
|
|
virtual MStatus | setObject (MObject &object) |
| Attaches the Function Set to the specified Maya Object. More...
|
|
virtual MStatus | setObject (const MObject &object) |
| NO SCRIPT SUPPORT. More...
|
|