MUserData Class Reference

Virtual base class for user data caching. More...

#include <MUserData.h>

Public Member Functions
	MUserData (bool deleteAfterUse)
	This method is obsolete. More...
	MUserData ()
	Construct an MUserData.
virtual	~MUserData ()
	Destructor.
bool	deleteAfterUse ()
	This method is obsolete. More...
void	setDeleteAfterUse (bool shouldDelete)
	This method is obsolete. More...

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

Detailed Description

Virtual base class for user data caching.

MUserData is a virtual base class meant to provide a means for users to attach blind data to certain Maya object types such that the lifetime of the blind data is managed by Maya.

Examples:

apiMeshShape/apiMeshGeometryOverride.cpp, apiMeshShape/apiMeshSubSceneOverride.cpp, apiMeshShape/apiMeshSubSceneOverride.h, cvColorNode/cvColorNode.cpp, footPrintManip/footPrintManip.cpp, footPrintNode/footPrintNode.cpp, footPrintNode_AnimatedMaterial/footPrintNode_GeometryOverride_AnimatedMaterial.cpp, gpuCache/gpuCacheDrawOverride.cpp, gpuCache/gpuCacheDrawOverride.h, gpuCache/gpuCacheSubSceneOverride.cpp, hwPhongShader/hwPhongShader.cpp, MayaPluginForSpreticle/spReticleLoc.cpp, MayaPluginForSpreticle/spReticleLoc.h, rawfootPrintNode/rawfootPrintNode.cpp, simpleEvaluationDraw/simpleEvaluationDraw.cpp, squaresNode_noDepthTest/squaresNode_noDepthTest.cpp, swissArmyManip/swissArmyManip.cpp, transformDrawNode/transformDrawNode.cpp, and uiDrawManager/uiDrawManager.cpp.

Constructor & Destructor Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MUserData

(

bool

deleteAfterUse

)

This method is obsolete.

Construct an MUserData.

[as of Maya 2022]

Deprecated:

Please use MUserData() instead. MUserData should be managed with MSharedPtr<MUserData>.

Parameters

[in]

deleteAfterUse

If true, this user data will be deleted immediately after use, instead of being cached until the owning object is deleted.

Member Function Documentation

bool deleteAfterUse

(

)

This method is obsolete.

Returns whether or not this user data should be deleted immediately after use instead of being maintained until the internal owning object is deleted.

[as of Maya 2022]

Deprecated:

Deallocation after use should be managed via MSharedPtr<MUserData>.

Returns

True if this user data should be deleted after use.

void setDeleteAfterUse

(

bool

shouldDelete

)

This method is obsolete.

Sets whether or not this user data should be deleted immediately after use instead of being maintained until the internal owning object is deleted.

[as of Maya 2022]

Deprecated:

Deallocation after use should be managed via MSharedPtr<MUserData>.

Setting this to false may allow the data to be reused in some situations. For example, if the MUserData returned by an MPxDrawOverride instance's prepareForDraw() method has its delete-after-use set to false, then Maya will retain the data between draws of that object, passing it back to the instance for reuse on subsequent draws.

Parameters

[in]

shouldDelete

If true this user data will be deleted after use

const char * className ( )

static

Returns the name of this class.

Returns

Name of this class.

---

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

• MUserData.h
• MUserData.cpp