#include <MPxObjectSet.h>

Class Description

Parent class of all user defined object sets.

MPxObjectSet is the parent class of all user defined sets.

Inheritance diagram for MPxObjectSet:

Public Member Functions
	MPxObjectSet ()
	Class constructor. More...

virtual	~MPxObjectSet ()
	Class destructor.

virtual MPxNode::Type	type () const
	Returns the type of node that this is. More...

virtual bool	canBeDeleted (bool isSrcNode)
	A method that is called whenever a neighboring node is deleted, to check if this node should be deleted alongside or as a result of the neighboring node. More...

Public Member Functions inherited from MPxNode
	MPxNode ()
	Constructor. More...

virtual	~MPxNode ()
	Destructor.

virtual void	postConstructor ()
	Post constructor. More...

virtual MStatus	compute (const MPlug &plug, MDataBlock &dataBlock)
	This method should be overridden in user defined nodes. More...

virtual bool	getInternalValueInContext (const MPlug &plug, MDataHandle &dataHandle, MDGContext &ctx)
	This method is overridden by nodes that store attribute data in some internal format. More...

virtual bool	setInternalValueInContext (const MPlug &plug, const MDataHandle &dataHandle, MDGContext &ctx)
	This method is overridden by nodes that store attribute data in some internal format. More...

virtual bool	getInternalValue (const MPlug &plug, MDataHandle &dataHandle)
	This method is obsolete. More...

virtual bool	setInternalValue (const MPlug &plug, const MDataHandle &dataHandle)
	This method is obsolete. More...

virtual int	internalArrayCount (const MPlug &plug, const MDGContext &ctx) const
	This method is overridden by nodes that have internal array attributes which are not stored in Maya's datablock. More...

virtual void	copyInternalData (MPxNode *)
	This method is overridden by nodes that store attribute data in some internal format. More...

virtual MStatus	legalConnection (const MPlug &plug, const MPlug &otherPlug, bool asSrc, bool &isLegal) const
	This method allows you to check for legal connections being made to attributes of this node. More...

virtual MStatus	legalDisconnection (const MPlug &plug, const MPlug &otherPlug, bool asSrc, bool &isLegal) const
	This method allows you to check for legal disconnections being made to attributes of this node. More...

virtual MStatus	setDependentsDirty (const MPlug &plug, MPlugArray &plugArray)
	This method can be overridden in user defined nodes to specify which plugs should be set dirty based upon an input plug {plugBeingDirtied} which Maya is marking dirty. More...

virtual MStatus	preEvaluation (const MDGContext &context, const MEvaluationNode &evaluationNode)
	Prepare a node's internal state for threaded evaluation. More...

virtual MStatus	postEvaluation (const MDGContext &context, const MEvaluationNode &evaluationNode, PostEvaluationType evalType)
	Clean up node's internal state after threaded evaluation. More...

virtual SchedulingType	schedulingType () const
	When overridden this method controls the degree of parallelism supported by the node during threaded evaluation. More...

virtual MStatus	connectionMade (const MPlug &plug, const MPlug &otherPlug, bool asSrc)
	This method gets called when connections are made to attributes of this node. More...

virtual MStatus	connectionBroken (const MPlug &plug, const MPlug &otherPlug, bool asSrc)
	This method gets called when connections are broken with attributes of this node. More...

virtual MStatus	dependsOn (const MPlug &plug, const MPlug &otherPlug, bool &depends) const
	This method may be overridden by the user defined node. More...

virtual bool	isPassiveOutput (const MPlug &plug) const
	This method may be overridden by the user defined node if it wants to provide output attributes which do not prevent value modifications to the destination attribute. More...

virtual MStatus	shouldSave (const MPlug &plug, bool &isSaving)
	This method may be overridden by the user defined node. More...

virtual MPlug	passThroughToOne (const MPlug &plug) const
	This method may be overridden by nodes that have a one-to-one relationship between an input attribute and a corresponding output attribute. More...

virtual bool	passThroughToMany (const MPlug &plug, MPlugArray &plugArray) const
	This method is overridden by nodes that want to control the traversal behavior of some Maya search algorithms which traverse the history/future of shape nodes looking for directly related nodes. More...

virtual bool	isAbstractClass () const
	Override this class to return true if this node is an abstract node. More...

virtual MStringArray	getFilesToArchive (bool shortName=false, bool unresolvedName=false, bool markCouldBeImageSequence=false) const
	Use this method to return all external files used by this node. More...

virtual void	getExternalContent (MExternalContentInfoTable &table) const
	Returns the external content (files) that this node depends on. More...

bool	addExternalContentForFileAttr (MExternalContentInfoTable &table, const MObject &attr) const
	Adds content info to the specified table from a file path attribute. More...

bool	setExternalContentForFileAttr (const MObject &attr, const MExternalContentLocationTable &table)
	Sets content info in the specified attribute from the table. More...

virtual void	setExternalContent (const MExternalContentLocationTable &table)
	Changes the location of external content in batch. More...

virtual MTypeId	typeId () const
	Returns the TYPEID of this node. More...

virtual MString	typeName () const
	Returns the type name of this node. More...

virtual MString	name () const
	Returns the name of this particular instance of this class. More...

virtual MObject	thisMObject () const
	Returns the MObject associated with this user defined node. More...

virtual MStatus	setExistWithoutInConnections (bool flag)
	This method specifies whether or not the node can exist without input connections. More...

virtual bool	existWithoutInConnections (MStatus *ReturnStatus=NULL) const
	Determines whether or not this node can exist without input connections. More...

virtual MStatus	setExistWithoutOutConnections (bool flag)
	This method specifies whether or not the node can exist without output connections. More...

virtual bool	existWithoutOutConnections (MStatus *ReturnStatus=NULL) const
	Determines whether or not this node can exist without output connections. More...

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Static Public Member Functions inherited from MPxNode
static MStatus	addAttribute (const MObject &attr)
	This method adds a new attribute to a user defined node type during the type's initialization. More...

static MStatus	inheritAttributesFrom (const MString &parentClassName)
	This method allows a class of plugin node to inherit all of the attributes of a second class of plugin node. More...

static MStatus	attributeAffects (const MObject &whenChanges, const MObject &isAffected)
	This method specifies that a particular input attribute affects a specific output attribute. More...

static const char *	className ()
	Returns the name of this class. More...

Static Public Attributes
static MObject	dagSetMembers
	Connections to this attribute specify the dagNodes or parts (components) of the same that are members of this set. More...

static MObject	DNSetMembers
	References to dependNode attributes which defines set membership.

static MObject	memberWireframeColor
	The index of a user defined color in which the dag object component members should appear. More...

static MObject	annotation
	A text string to annotate the set.

static MObject	isLayer
	This attribute is obsolete and should no longer be used.

static MObject	verticesOnlySet
	Is set membership restricted to objects with vertices? This attribute should not be explicitly changed by the user. More...

static MObject	edgesOnlySet
	Is set membership restricted to objects with edges? This attribute should not be explicitly changed by the user. More...

static MObject	facetsOnlySet
	Is set membership restricted to objects with facets? This attribute should not be explicitly changed by the user. More...

static MObject	editPointsOnlySet
	Is set membership restricted to objects with edit points? This attribute should not be explicitly changed by the user. More...

static MObject	renderableOnlySet
	Is set membership restricted to renderable objects only? This attribute should not be explicitly changed by the user. More...

static MObject	partition
	References to the partition nodes this set is a member of.

static MObject	groupNodes
	When parts (components) of dagNodes are in the set, connections are made to this attribute to hold references to groupId nodes, with the id uniquely identifying the group in the dagNode. More...

static MObject	usedByNodes
	References to nodes that operate upon this set, such as deformers.

Static Public Attributes inherited from MPxNode
static MObject	message
	message attribute

static MObject	isHistoricallyInteresting
	is historically interesting attribute

static MObject	caching
	caching attribute

static MObject	state
	state attribute

static MObject	frozen
	frozen attribute

Additional Inherited Members
Public Types inherited from MPxNode
enum	Type { kDependNode, kLocatorNode, kDeformerNode, kManipContainer, kSurfaceShape, kFieldNode, kEmitterNode, kSpringNode, kIkSolverNode, kHardwareShader, kHwShaderNode, kTransformNode, kObjectSet, kFluidEmitterNode, kImagePlaneNode, kParticleAttributeMapperNode, kCameraSetNode, kConstraintNode, kManipulatorNode, kMotionPathNode, kClientDeviceNode, kThreadedDeviceNode, kAssembly, kSkinCluster, kGeometryFilter, kBlendShape, kLast }
	Defines the type of node. More...

enum	SchedulingType { kParallel, kSerial, kGloballySerial, kUntrusted, kDefaultScheduling = kSerial }
	Defines the degree of parallelism of a node. More...

Protected Member Functions inherited from MPxNode
virtual MDataBlock	forceCache (MDGContext &ctx=MDGContext::fsNormal)
	USE _forceCache() IN SCRIPT. More...

virtual void	setMPSafe (bool flag)
	USE _setMPSafe() IN SCRIPT. More...

virtual MStatus	setDoNotWrite (bool flag)
	USE _setDoNotWrite() IN SCRIPT. More...

virtual bool	doNotWrite (MStatus *ReturnStatus=NULL) const
	USE _doNotWrite() IN SCRIPT. More...

Constructor & Destructor Documentation

MPxObjectSet ( )

Class constructor.

Any calls the MPxObjectSet methods must be done in the postConstructor method and not here.

Member Function Documentation

MPxNode::Type type ( ) const

virtual

Returns the type of node that this is.

This is used to differentiate user defined nodes that are derived off different MPx base classes.

It is not necessary to override this method.

Returns: Type of the node (MPxNode::kObjectSet)

Reimplemented from MPxNode.

bool canBeDeleted ( bool isSrcNode )

virtual

A method that is called whenever a neighboring node is deleted, to check if this node should be deleted alongside or as a result of the neighboring node.

This method will not be called in the case where construction history is being deleted.

By default, the object set will be deleted when all of the following criteria are met:

The object set is not locked
The object set is deletable
No connections to usedByNodes exist.
No connections to dagSM and to DNSM, i.e., no members in the set.
No connection to groupNodes and to DNSM and no full dagObject members

It is not necessary to override this method.

Parameters

[in] isSrcNode True if this node is the source node of the connection to the neighboring node.

Returns

true Delete this node
false Do not delete this node

const char * className ( )

static

Returns the name of this class.

Returns: The name of this class.

Member Data Documentation

MObject dagSetMembers

static

Connections to this attribute specify the dagNodes or parts (components) of the same that are members of this set.

MObject memberWireframeColor

static

The index of a user defined color in which the dag object component members should appear.

A value of -1 disables use of the color. Values outside the range [-1,7] may give unpredictable results.

MObject verticesOnlySet

static

Is set membership restricted to objects with vertices? This attribute should not be explicitly changed by the user.

MObject edgesOnlySet

static

Is set membership restricted to objects with edges? This attribute should not be explicitly changed by the user.

MObject facetsOnlySet

static

Is set membership restricted to objects with facets? This attribute should not be explicitly changed by the user.

MObject editPointsOnlySet

static

Is set membership restricted to objects with edit points? This attribute should not be explicitly changed by the user.

MObject renderableOnlySet

static

Is set membership restricted to renderable objects only? This attribute should not be explicitly changed by the user.

MObject groupNodes

static

When parts (components) of dagNodes are in the set, connections are made to this attribute to hold references to groupId nodes, with the id uniquely identifying the group in the dagNode.

The documentation for this class was generated from the following files:

MPxObjectSet.h
MPxObjectSet.cpp

MPxObjectSet Class Reference

Class Description

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation