Detailed Description

Create and Access dependency node plugs.

MPlug provides methods for creating plugs, and accessing the plugs' dependency node and attributes.

A plug is a point on a dependency node where a particular attribute can be connected. In simple cases the plug and attribute are equivalent. When you have array attributes, however, the plug is more specific in that it indicates which of the array elements is to be connected.

There are two main types of plugs: networked plugs and non-networked plugs. Non-networked plugs can be considered user plugs as they are created by users and belong to users. Networked plugs can be considered dependency node plugs as they are part of the dependency graph and can only be referenced by users.

In every dependency node there is a network or "tree" of plugs indicating connections that have been made to attributes of the node. The plugs in this tree are known as networked plugs as they belong to the dependency node's network.

Non-networked plugs are plugs that you can create in order to establish a new connection to an attribute, or to get or set a value on an attribute. When a connection is made using these plugs, a networked version of the plug is created and added to the dependency nodes network.

A networked plug cannot be explicitly created. They are created when a connection is established for some attribute of the node. Since the allocation of networked plugs is managed exclusively by Maya, a plugin should never reference a networked plug after changes are made to the DG. Instead, use a non-networked version of the plug, or get a new reference to the networked plug.

All a non-networked plug knows is how to uniquely describe the attribute that it references, in fact the purpose of a non-networked plug is to specify, without ambiguity, an attribute of a dependency node. A non-networked plug contains an array of array indices that plot the path from the root plug to this plug.

For simple attributes the plug and attribute are equivalent. Compound attributes are also unambiguous. A plug that refers to an array attribute, however, is more complex as it can refer to the array plug or an element plug in the array.

Several methods are provided for navigating the plug tree. The child method can be used to retrieve the child plugs of a compound plug. The elementByLogicalIndex and elementByPhysicalIndex methods can be used to retrieve the element plugs of an array plug. The parent and array methods traverse the tree in the opposite direction: parent retrieves a compound plug from a child plug, and array retrieves an array plug from an element plug.

Since connections to arrays are sparse, element plugs have both logical and physical indexes. The logical indexes are used by MEL, and are sparse. Physical indexes, on the other hand, are not sparse. It is guaranteed that the physical indexes will range from 0 to numElements() - 1. Using the physical indexes, iterating over the element plugs in an array is easy:

       // See note below on numElements() method
       for (i = 0; i < arrayPlug.numElements (); i++)
       {
           MPlug elementPlug = arrayPlug [i];
           unsigned int logicalIndex = elementPlug.logicalIndex();
           // ...
       }

This is equivalent to calling elementByPhysicalIndex since the bracket operator uses physical indexes.

The ancestry of a plug is the tree above the plug: any parents or arrays which this plug belongs to. The selectAncestorLogicalIndex method provides quick access to element plugs without walking the plug tree. A plug does not need to exist in the datablock or plug tree in order to be constructed using selectByLogicalIndex, but once a value is requested or set on the plug, it will be added to the datablock if it was not there already. For example:

    MPlug plug(node,attribute);
    // See note below on numElements() method
    unsigned int count = plug.numElements();
    if (0 == count) {
        plug.selectAncestorLogicalIndex(0,attribute);
        plug.setValue(setVal);
        count = plug.numElements(); // count will now be 1 since we added a value

        plug.selectAncestorLogicalIndex(10,attribute);
        MObject getVal;
        plug.getValue(getVal);
        count = plug.numElements(); // count will now be 2 since we asked for a value
    }

Once a value has been added to an array plug, it will usually remain in the datablock as long as the scene is open. The exception is for attributes that have their disconnect behavior set to kDelete; data for these attributes will be deleted when their connection is broken. When a file is saved, only array values that are not at their default values will be written out. Therefore, the number of elements in an array plug may change when the file is read in again.

Note:: The numElements() call for array plugs returns a value based on the information in the datablock. It is possible to have un-evaluated connected items being excluded from the count since these items are not yet in the datablock. In this case, the numElements() method will return the correct answer if the ::evaluateNumElements() call is made first. But this cannot be done in the ::compute() method of a node.

Examples:: affectsNode.cpp, animCubeNode.cpp, animExportUtil.cpp, animInfoCmd.cpp, anisotropicShader.cpp, apiMeshCreator.cpp, apiMeshCreator.h, apiMeshShape.cpp, apiMeshShape.h, arcLenNode.cpp, backfillShader.cpp, blindComplexDataCmd.cpp, blindDataMesh.cpp, blindDataMesh.h, blindDataShader.cpp, blindDataShader.h, blindDoubleDataCmd.cpp, brickShader.cpp, buildRotationNode.cpp, cellShader.cpp, cgfxAttrDef.cpp, cgfxAttrDef.h, cgfxShaderNode.cpp, cgfxShaderNode.h, cgfxVector.cpp, cgfxVector.h, checkerShader.cpp, circleNode.cpp, clearcoat.cpp, closestPointCmd.cpp, closestPointOnCurveCmd.cpp, closestPointOnCurveNode.cpp, closestPointOnCurveNode.h, clothPaintAttrCmd.cpp, componentScaleManip.cpp, compositingShader.cpp, contrastShader.cpp, createClipCmd.cpp, curvedArrowsNode.cpp, customAttrManip.cpp, customImagePlane.cpp, cvColorNode.cpp, cvColorShader.cpp, D3DResourceManager.cpp, D3DViewportRenderer.cpp, dagPoseInfoCmd.cpp, depthShader.cpp, displacementShader.cpp, dynExprField.cpp, dynExprField.h, exampleMRampAttribute.cpp, exportJointClusterDataCmd.cpp, filteredAsciiFile.cpp, findFileTexturesCmd.cpp, findTexturesPerPolygonCmd.cpp, flameShader.cpp, footPrintManip.cpp, footPrintNode.cpp, fullLoftNode.cpp, gammaShader.cpp, genericAttributeNode.cpp, geometrySurfaceConstraint.cpp, geometrySurfaceConstraint.h, geomShader.cpp, GLSLShaderNode.cpp, GLSLShaderNode.h, hlslShader.cpp, hlslShader.h, hwAnisotropicShader_NV20.cpp, hwColorPerVertexShader.cpp, hwDecalBumpShader_NV20.cpp, hwDecalBumpShader_NV20.h, hwPhongShader.cpp, hwPhongShader.h, hwPhongShaderBehavior.cpp, hwPhongShaderBehavior.h, hwReflectBumpShader_NV20.cpp, hwReflectBumpShader_NV20.h, hwRefractReflectShader_NV20.cpp, hwRefractReflectShader_NV20.h, hwToonShader_NV20.cpp, hwToonShader_NV20.h, hwUnlitShader.cpp, hwUnlitShader.h, interpShader.cpp, intersectCmd.cpp, jitterNode.cpp, lambertShader.cpp, latticeNoise.h, latticeNoiseNode.cpp, lavaShader.cpp, lightShader.cpp, lockEvent.cpp, maTranslator.cpp, meshOpCmd.cpp, meshOpNode.cpp, meshOpNode.h, mixtureShader.cpp, motionTraceCmd.cpp, moveManip.cpp, MTextureCache.cpp, multiCurveNode.cpp, narrowPolyViewer.h, nodeInfoCmd.cpp, nodeMessageCmd.cpp, noiseShader.cpp, ownerEmitter.cpp, ownerEmitter.h, particleAttrNode.cpp, particleAttrNode.h, phongShader.cpp, pluginMain.cpp, pnTrianglesNode.cpp, pnTrianglesNode.h, pointOnMeshCmd.cpp, pointOnMeshInfoNode.cpp, pointOnMeshInfoNode.h, pointOnSubdNode.cpp, pointOnSubdNode.h, polyExporter.cpp, polyModifierCmd.cpp, polyModifierCmd.h, polyTrgNode.cpp, polyWriter.cpp, quadricShape.cpp, renderAccessNode.cpp, rockingTransform.cpp, rockingTransform.h, rockingTransformCheck.cpp, rockingTransformCheck.h, rotateManip.cpp, ShadingConnection.cpp, ShadingConnection.h, shadowMatteShader.cpp, shellNode.cpp, shiftNode.cpp, simpleEmitter.cpp, simpleEmitter.h, simpleFluidEmitter.cpp, simpleFluidEmitter.h, simpleLoftNode.cpp, simpleSpring.cpp, simpleSpring.h, sineNode.cpp, slopeShaderBehavior.cpp, slopeShaderBehavior.h, slopeShaderNode.cpp, slopeShaderNode.h, solidCheckerShader.cpp, splitUVCmd.cpp, splitUVNode.cpp, splitUVNode.h, squareScaleManipContext.cpp, stringFormatNode.cpp, surfaceBumpManip.cpp, sweptEmitter.cpp, sweptEmitter.h, swissArmyManip.cpp, testNobjectNode.cpp, testNobjectNode.h, testNucleusNode.cpp, testNucleusNode.h, torusField.cpp, torusField.h, transCircleNode.cpp, volumeShader.cpp, and weightListNode.cpp.

#include <MPlug.h>

List of all members.

Public Types
enum	MValueSelector { kAll, kNonDefault, kChanged, kLastAttrSelector }
	Which values to generate setAttr commands for. More...
enum	FreeToChangeState { kFreeToChange = 0, kNotFreeToChange, kChildrenNotFreeToChange }
	Plug state returned by isFreeToChange. More...
Public Member Functions
	MPlug ()
	Constructor.
	MPlug (const MPlug &in)
	Copy constructor.
	MPlug (const MObject &node, const MObject &attribute)
	Constructor.
virtual	~MPlug ()
	Destructor.
MStatus	setAttribute (MObject &attribute)
	This method is a convenience routine to allow quick movement between attributes on a single node.
MObject	attribute (MStatus *ReturnStatus=NULL) const
	This method returns the attribute that this plug refers to.
MObject	node (MStatus *ReturnStatus=NULL) const
	Returns the dependency node that this plug belongs to.
MString	name (MStatus *ReturnStatus=NULL) const
	Returns the name of this plug in the form "<i>nodeName</i>.<i>attributeName</i>".
MString	partialName (bool includeNodeName=false, bool includeNonMandatoryIndices=false, bool includeInstancedIndices=false, bool useAlias=false, bool useFullAttributePath=false, bool useLongNames=false, MStatus *ReturnStatus=NULL) const
	By default, this method returns the shortest possible name for the plug, but its parameters can be used to add parts back in.
MStatus	getSetAttrCmds (MStringArray &cmds, MValueSelector valueSelector=kAll, bool useLongNames=false)
	Returns an array of strings containing setAttr commands for this plug and all of its descendent plugs.
bool	isNetworked (MStatus *ReturnStatus=NULL) const
	This method determines if the plug is networked or non-networked.
bool	isArray (MStatus *ReturnStatus=NULL) const
	This method determines if the plug is an array plug.
bool	isElement (MStatus *ReturnStatus=NULL) const
	This method determines if the plug is an element plug.
bool	isCompound (MStatus *ReturnStatus=NULL) const
	This method determines if the plug is a compound plug.
bool	isChild (MStatus *ReturnStatus=NULL) const
	This method determines if the plug is a child plug.
bool	isProcedural (MStatus *ReturnStatus=NULL) const
	This method determines if the plug is a procedural plug.
unsigned int	logicalIndex (MStatus *ReturnStatus=NULL) const
	Returns the logical index of the element this plug refers to.
MStatus	selectAncestorLogicalIndex (unsigned int index, const MObject &attribute=MObject::kNullObj)
	This method is a convenience routine to allow quick iteration and construction of plugs with array plugs in their ancestry.
unsigned int	getExistingArrayAttributeIndices (MIntArray &indices, MStatus *ReturnStatus=NULL)
	This method will return a list of the logical indices of the elements in an array attribute that are either connected or have had their value set.
unsigned int	numElements (MStatus *ReturnStatus=NULL) const
	Return the total number of elements in the datablock of this array plug.
unsigned int	evaluateNumElements (MStatus *ReturnStatus=NULL)
	Return the total number of elements in the datablock of this array plug.
unsigned int	numChildren (MStatus *ReturnStatus=NULL) const
	Return the total number of children of this compound plug.
unsigned int	numConnectedElements (MStatus *ReturnStatus=NULL) const
	Return the total number of connected element plugs belonging to this array plug.
unsigned int	numConnectedChildren (MStatus *ReturnStatus=NULL) const
	Return the number of children of this plug that are connected in the dependency graph.
MPlug	child (MObject &attr, MStatus *ReturnStatus=NULL) const
	Returns a plug to a given attribute that is a child of this plug.
MPlug	child (unsigned int index, MStatus *ReturnStatus=NULL) const
	Returns a plug to a given attribute that is a child of this plug.
MPlug	parent (MStatus *ReturnStatus=NULL) const
	Returns the parent plug.
MPlug	array (MStatus *ReturnStatus=NULL) const
	Returns the array to which this element plug belongs.
MPlug	elementByLogicalIndex (unsigned int logicalIndex, MStatus *ReturnStatus=NULL) const
	This method will find and return a plug with the given logical index.
MPlug	elementByPhysicalIndex (unsigned int physicalIndex, MStatus *ReturnStatus=NULL) const
	This method will find and return a plug with the given physical index.
MPlug	connectionByPhysicalIndex (unsigned int physicalIndex, MStatus *ReturnStatus=NULL) const
	This method will find and return a connected plug with the given physical index for its connection.
bool	connectedTo (MPlugArray &array, bool asDst, bool asSrc, MStatus *ReturnStatus=NULL) const
	This method finds all of the plugs that this plug is connected with.
bool	isConnected (MStatus *ReturnStatus=NULL) const
	Determines if this plug is connected to one or more plugs.
bool	isKeyable (MStatus *ReturnStatus=NULL) const
	Determines if this plug is keyable.
MStatus	setKeyable (bool keyable)
	This overrides the default keyability of a plug set with MFnAttribute::setKeyable.
bool	isLocked (MStatus *ReturnStatus=NULL) const
	Determines the locked state of this plug's value.
MStatus	setLocked (bool locked)
	Sets the locked state for this plug's value.
bool	isChannelBoxFlagSet (MStatus *ReturnStatus=NULL) const
	Returns true if this plug or its attribute has its channel box flag set.
MStatus	setChannelBox (bool channelBox)
	Sets whether this plug is displayed in the channel box.
bool	isCachingFlagSet (MStatus *ReturnStatus=NULL) const
	Returns true if this plug or its attribute has its caching flag set.
MStatus	setCaching (bool caching)
	Sets whether this plug is cached internally.
bool	isNull (MStatus *ReturnStatus=NULL) const
	This method determines whether this plug is valid.
MString	info (MStatus *ReturnStatus=NULL) const
	This method returns a string containing the name of the node this plug belongs to and the attributes that the plug refers to.
bool	isFromReferencedFile (MStatus *ReturnStatus=NULL) const
	This method determines whether this plug came from a referenced file.
bool	isDynamic (MStatus *ReturnStatus=NULL) const
	Determines whether the attribute is of dynamic type or not.
bool	isIgnoredWhenRendering (MStatus *ReturnStatus=NULL) const
	Determines whether a connection to the attribute should be ignored during rendering.
MPlug::FreeToChangeState	isFreeToChange (bool checkParents=true, bool checkChildren=true, MStatus *ReturnStatus=NULL) const
	Returns true if the plug's value is allowed to be set directly.
MDataHandle	constructHandle (MDataBlock &) const
	This method returns a data handle constructed for this plug.
void	destructHandle (MDataHandle &) const
	This method destructs the data handle for this plug.
MStatus	getValue (MObject &val, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (MDataHandle &handle, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (double &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (float &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (int &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (short &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (bool &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (MDistance &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (MAngle &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (MTime &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (char &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	getValue (MString &, MDGContext &ctx=MDGContext::fsNormal) const
	NO SCRIPT SUPPORT.
MStatus	setValue (MObject &val)
	NO SCRIPT SUPPORT.
MStatus	setValue (MPxData *data)
	NO SCRIPT SUPPORT.
MStatus	setValue (MDataHandle &handle)
	NO SCRIPT SUPPORT.
MStatus	setValue (double)
	NO SCRIPT SUPPORT.
MStatus	setValue (float)
	NO SCRIPT SUPPORT.
MStatus	setValue (int)
	NO SCRIPT SUPPORT.
MStatus	setValue (short)
	NO SCRIPT SUPPORT.
MStatus	setValue (bool)
	NO SCRIPT SUPPORT.
MStatus	setValue (MDistance &)
	NO SCRIPT SUPPORT.
MStatus	setValue (MAngle &)
	NO SCRIPT SUPPORT.
MStatus	setValue (MTime &)
	NO SCRIPT SUPPORT.
MStatus	setValue (char)
	NO SCRIPT SUPPORT.
MStatus	setValue (const MString &)
	NO SCRIPT SUPPORT.
MStatus	setValue (const char *)
	NO SCRIPT SUPPORT.
MObject	asMObject (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
MDataHandle	asMDataHandle (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
double	asDouble (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
float	asFloat (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
int	asInt (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
short	asShort (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
bool	asBool (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
MDistance	asMDistance (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
MAngle	asMAngle (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
MTime	asMTime (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
char	asChar (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
MString	asString (MDGContext &ctx=MDGContext::fsNormal, MStatus *ReturnStatus=NULL) const
	Retrieve the current value of the attribute this plug references.
MStatus	setMObject (MObject &val)
	Set the current value of the attribute this plug references.
MStatus	setMPxData (MPxData *data)
	Set the current value of the attribute this plug references.
MStatus	setMDataHandle (MDataHandle &handle)
	Set the current value of the attribute this plug references with the values in the handle.
MStatus	setDouble (double)
	Set the current value of the attribute this plug references.
MStatus	setFloat (float)
	Set the current value of the attribute this plug references.
MStatus	setInt (int)
	Set the current value of the attribute this plug references.
MStatus	setShort (short)
	Set the current value of the attribute this plug references.
MStatus	setBool (bool)
	Set the current value of the attribute this plug references.
MStatus	setMDistance (MDistance &)
	Set the current value of the attribute this plug references.
MStatus	setMAngle (MAngle &)
	Set the current value of the attribute this plug references.
MStatus	setMTime (MTime &)
	Set the current value of the attribute this plug references.
MStatus	setChar (char)
	Set the current value of the attribute this plug references.
MStatus	setString (const MString &)
	Set the current value of the attribute this plug references.
MPlug &	operator= (const MPlug &other)
	Assignment operator.
MPlug	operator[] (unsigned int physicalIndex) const
	This method will find and return a plug with the given physical index.
bool	operator== (const MPlug &other) const
	Comparison operator for MPlugs.
bool	operator== (const MObject &other) const
	Comparison operator for a plug and an attribute.
bool	operator!= (const MPlug &other) const
	The inequality operator for MPlugs.
bool	operator!= (const MObject &other) const
	The inequality operator for a plug and an attribute.
MStatus	setNumElements (unsigned int)
	The method is used to pre-allocate the number of elements that an array plug will contain.
MPlug	operator[] (MObject &attr) const
	NO SCRIPT SUPPORT.
	operator MObject () const
	NO SCRIPT SUPPORT.
bool	operator! () const
	NO SCRIPT SUPPORT.
bool	isSource (MStatus *ReturnStatus=NULL) const
	Determines if this plug is connected as a source.
bool	isDestination (MStatus *ReturnStatus=NULL) const
	Determines if this plug is connected as a destination.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class. Search for all occurrences

kAll	All values. Search for all occurrences
kNonDefault	Non default values. Search for all occurrences
kChanged	Changed values. Search for all occurrences
kLastAttrSelector	Last value, for counting. Search for all occurrences

kFreeToChange	All tested plugs are free to change. Search for all occurrences
kNotFreeToChange	Some of the tested plugs are not free to change. Search for all occurrences
kChildrenNotFreeToChange	Some of the children are not free to change. Search for all occurrences

[in]	node	the dependency node this plug belongs to
[in]	attribute	the attribute this plug refers to

MString partialName	(	bool	includeNodeName = `false`,
		bool	includeNonMandatoryIndices = `false`,
		bool	includeInstancedIndices = `false`,
		bool	useAlias = `false`,
		bool	useFullAttributePath = `false`,
		bool	useLongNames = `false`,
		MStatus *	ReturnStatus = `NULL`
	)		const

[in]	includeNodeName	If true, then the plug's node name is prefixed to the name of the plug, with a dot separating it from the attribute name. If false, then just the attribute name is returned. (default: false)
[in]	includeNonMandatoryIndices	If the plug's attribute is a non-instanced element of a multi which is NOT marked as indexMatters, then setting this parameter true will cause its index to be included in the returned string anyway. If the attribute is marked as indexMatters then its array index will be included regardless of the setting of this parameter. If the attribute is instanced then it is not affected by this parameter. See the next parameter instead. (default: false)
[in]	includeInstancedIndices	If the plug's attribute is an element of an instanced multi, then setting this parameter true will cause the array index to be included in the returned string. For example, if you are planning to append the returned plug name to a node's dagPath, then the instance index is unnecessary as it can be determined from the dagPath. (default: false)
[in]	useFullAttributePath	Normally, the plug's attribute path is compressed so that any compound ancestors which do not serve to uniquely identify the plug are removed. Setting this parameter true will cause the full attribute path to be used. (default: false)
[in]	useAlias	Display aliased name if alias exists. (default: false)
[in]	useLongNames	Normally, short attribute names are used. Setting this true will cause long names to be used. (default: false)
[out]	ReturnStatus	Return status.

MStatus getSetAttrCmds	(	MStringArray &	cmds,
		MPlug::MValueSelector	valueSelector = `kAll`,
		bool	useLongNames = `false`
	)

MStatus selectAncestorLogicalIndex	(	unsigned int	index,
		const MObject &	attribute = `MObject::kNullObj`
	)

[in]	index	index value to be set
[in]	attribute	array attribute whose index will be changed

unsigned int getExistingArrayAttributeIndices	(	MIntArray &	indices,
		MStatus *	ReturnStatus = `NULL`
	)

[in]	indices	A list to store the logical indices of the set/connected elements.
[out]	ReturnStatus	Status Code

MPlug child	(	MObject &	obj,
		MStatus *	ReturnStatus = `NULL`
	)		const

[in]	index	The index of the plug to be found
[out]	ReturnStatus	Status code.

MPlug elementByLogicalIndex	(	unsigned int	index,
		MStatus *	ReturnStatus = `NULL`
	)		const

MPlug elementByPhysicalIndex	(	unsigned int	index,
		MStatus *	ReturnStatus = `NULL`
	)		const

[in]	index	The physical array index of the plug to be found
[out]	ReturnStatus	Status Code

MPlug connectionByPhysicalIndex	(	unsigned int	index,
		MStatus *	ReturnStatus = `NULL`
	)		const

bool connectedTo	(	MPlugArray &	array,
		bool	asDst,
		bool	asSrc,
		MStatus *	ReturnStatus = `NULL`
	)		const

[in]	array	Location for storing connected plugs (allocated by the caller)
[in]	asDst	Check connections with this plug as destination. If there are such connections, put them in array.
[in]	asSrc	Check connections with this plug as source. If there are such connections, put them in array.
[out]	ReturnStatus	Status Code

MPlug::FreeToChangeState isFreeToChange	(	bool	checkParents = `true`,
		bool	checkChildren = `true`,
		MStatus *	ReturnStatus = `NULL`
	)		const

[in]	checkParents	Check parent plugs.
[in]	checkChildren	Check child plugs.
[out]	ReturnStatus	Status Code

MPlug Class Reference

OpenMaya - API module for common classes

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

MStatus getValue	(	MObject &	val,
		MDGContext &	ctx = `MDGContext::fsNormal`
	)		const

[out]	val	Storage for the attribute value
[in]	ctx	Context in which to evaluate the plug (Default is normal)

MStatus getValue	(	MDataHandle &	val,
		MDGContext &	ctx = `MDGContext::fsNormal`
	)		const

MStatus getValue	(	double &	val,
		MDGContext &	ctx = `MDGContext::fsNormal`
	)		const

MStatus getValue	(	float &	val,
		MDGContext &	ctx = `MDGContext::fsNormal`
	)		const

MStatus getValue	(	int &	val,
		MDGContext &	ctx = `MDGContext::fsNormal`
	)		const

MStatus getValue	(	short &	val,
		MDGContext &	ctx = `MDGContext::fsNormal`
	)		const

MStatus getValue	(	bool &	val,
		MDGContext &	ctx = `MDGContext::fsNormal`
	)		const

MStatus getValue	(	MDistance &	val,
		MDGContext &	ctx = `MDGContext::fsNormal`
	)		const

MStatus getValue	(	MAngle &	val,
		MDGContext &	ctx = `MDGContext::fsNormal`
	)		const