class MPxObjectSet

Jump to documentation

Inheritance:

MPxObjectSet < MPxNode

public members:

	MPxObjectSet ()
virtual	~MPxObjectSet ()
virtual MPxNode::Type	type () const
virtual bool	canBeDeleted ( bool isSrcNode )
static MObject	dagSetMembers Connections to this attribute specify the dagNodes or parts (components) of the same that are members of this set.
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. A value of -1 disables use of the color. Values outside the range [-1,7] may give unpredictable results.
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.
static MObject	edgesOnlySet Is set membership restricted to objects with edges? This attribute should not be explicitly changed by the user.
static MObject	facetsOnlySet Is set membership restricted to objects with facets? This attribute should not be explicitly changed by the user.
static MObject	editPointsOnlySet Is set membership restricted to objects with edit points? This attribute should not be explicitly changed by the user.
static MObject	renderableOnlySet Is set membership restricted to renderable objects only? This attribute should not be explicitly changed by the user.
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.
static MObject	usedByNodes References to nodes that operate upon this set, such as deformers.

Inherited from MPxNode:

public members:

enum	Type kDependNode kLocatorNode kDeformerNode kManipContainer kSurfaceShape kFieldNode kEmitterNode kSpringNode kIkSolverNode kHardwareShader Custom shader derived from MPxHardwareShader kHwShaderNode Custom shader derived from MPxHwShaderNode kTransformNode kObjectSet kFluidEmitterNode kImagePlaneNode kParticleAttributeMapperNode kConstraintNode kLast
virtual void	postConstructor ()
virtual MStatus	compute ( const MPlug & plug, MDataBlock & dataBlock )
virtual bool	getInternalValueInContext ( const MPlug & plug, MDataHandle & dataHandle, MDGContext & ctx)
virtual bool	setInternalValueInContext ( const MPlug & plug, const MDataHandle & dataHandle, MDGContext & ctx)
virtual bool	getInternalValue ( const MPlug & plug, MDataHandle & dataHandle)
virtual bool	setInternalValue ( const MPlug & plug, const MDataHandle & dataHandle)
virtual int	internalArrayCount ( const MPlug & plug, const MDGContext & ctx) const
virtual void	copyInternalData ( MPxNode * )
virtual MStatus	legalConnection ( const MPlug & plug, const MPlug & otherPlug, bool asSrc, bool& isLegal ) const
virtual MStatus	legalDisconnection ( const MPlug & plug, const MPlug & otherPlug, bool asSrc, bool& isLegal ) const
virtual MStatus	setDependentsDirty ( const MPlug & plug, MPlugArray & plugArray)
virtual MStatus	connectionMade ( const MPlug & plug, const MPlug & otherPlug, bool asSrc )
virtual MStatus	connectionBroken ( const MPlug & plug, const MPlug & otherPlug, bool asSrc )
virtual bool	isPassiveOutput ( const MPlug & plug ) const
virtual MStatus	shouldSave ( const MPlug & plug, bool& isSaving )
virtual MPlug	passThroughToOne ( const MPlug & plug ) const
virtual bool	passThroughToMany ( const MPlug & plug, MPlugArray & plugArray ) const
MTypeId	typeId () const
MString	typeName () const
MString	name () const
virtual Type	type () const
virtual bool	isAbstractClass () const
MObject	thisMObject () const
static MStatus	addAttribute ( const MObject & attr )
static MStatus	inheritAttributesFrom ( const MString & parentClassName )
static MStatus	attributeAffects ( const MObject & whenChanges, const MObject & isAffected )
MStatus	setExistWithoutInConnections ( bool flag )
bool	existWithoutInConnections ( MStatus * ReturnStatus = NULL ) const
MStatus	setExistWithoutOutConnections ( bool flag )
bool	existWithoutOutConnections ( MStatus * ReturnStatus = NULL ) const
static MObject	message
static MObject	isHistoricallyInteresting
static MObject	caching
static MObject	state

protected members:

MDataBlock	forceCache ( MDGContext & ctx= MDGContext::fsNormal )
void	setMPSafe ( bool flag )
MStatus	setDoNotWrite ( bool flag )
bool	doNotWrite ( MStatus *ReturnStatus = NULL ) const

Documentation

Description

MPxObjectSet is the parent class of all user defined sets.

Functions

MPxObjectSet:: MPxObjectSet ()

Description

Class constructor.

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

MPxObjectSet:: ~MPxObjectSet ()

Description

Class destructor.

MPxNode::Type MPxObjectSet:: type () const

Description

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.

Return Value

• Type of the node (MPxNode::kObjectSet)

bool MPxObjectSet:: canBeDeleted (bool isSrcNode)

Description

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.

Arguments

• isSrcNode True if this node is the source node of the connection to the neighboring node.

Return Value

• true Delete this node
• false Do not delete this node

This class has no child classes.