MUserData Class Reference

#include <MUserData.h>

Class Description

Public Member Functions

 MUserData (bool deleteAfterUse)
 Construct an MUserData. More...
 
virtual ~MUserData ()
 Destructor.
 
bool deleteAfterUse ()
 Returns whether or not this user data should be deleted immediately after use instead of being maintained until the internal owning object is deleted. More...
 
void setDeleteAfterUse (bool shouldDelete)
 Sets whether or not this user data should be deleted immediately after use instead of being maintained until the internal owning object is deleted. More...
 

Static Public Member Functions

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

Constructor & Destructor Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MUserData ( bool  deleteAfterUse)

Construct an MUserData.

Parameters
[in]deleteAfterUseIf true, this user data will be deleted immediately after use, instead of being cached until the owning object is deleted.
+ Examples:

Member Function Documentation

bool deleteAfterUse ( )

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

Returns
True if this user data should be deleted after use.
void setDeleteAfterUse ( bool  shouldDelete)

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

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]shouldDeleteIf 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