Defines additional info about why the node disables Cached Playback. More...

#include <MNodeCacheDisablingInfo.h>

Public Member Functions
void	setCacheDisabled (bool disabled)
	Sets if the cache should be disabled because of this node. More...

bool	getCacheDisabled () const
	Gets if the cache should be disabled because of this node. More...

void	setReason (const MString &reason)
	Sets the reason for disabling Cached Playback. More...

void	setMitigation (const MString &mitigation)
	Sets the mitigation to fix the reason for disabling Cached Playback. More...

void	reset ()
	Resets the disabling info to an enabled state. More...

Detailed Description

Defines additional info about why the node disables Cached Playback.

Warning: Do not store pointers to this object; Users cannot construct or destroy this Maya object

Examples:: apiMeshShape/apiMeshShape.cpp, apiMeshShape/apiMeshShape.h, footPrintNode/footPrintNode.cpp, footPrintNode_AnimatedMaterial/footPrintNode_GeometryOverride_AnimatedMaterial.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, rawfootPrintNode/rawfootPrintNode.cpp, simplePhysicsEngine/simplePhysicsEngine.cpp, simpleSimulationNode/simpleSimulationNode.cpp, testMTopologyEvaluator/testMTopologyEvaluator.cpp, and testMTopologyEvaluator/testMTopologyEvaluator.h.

Member Function Documentation

void setCacheDisabled ( bool disabled )

Sets if the cache should be disabled because of this node.

Parameters

[in] disabled True if Cached Playback should be disabled, false otherwise.

bool getCacheDisabled ( ) const

Gets if the cache should be disabled because of this node.

Examples:: apiMeshShape/apiMeshShape.cpp, footPrintNode/footPrintNode.cpp, footPrintNode_AnimatedMaterial/footPrintNode_GeometryOverride_AnimatedMaterial.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, and rawfootPrintNode/rawfootPrintNode.cpp.

void setReason ( const MString & reason )

Sets the reason for disabling Cached Playback.

This method also sets that Cached Playback should be disabled.

Parameters

[in] reason The reason for disabling Cached Playback.

void setMitigation ( const MString & mitigation )

Sets the mitigation to fix the reason for disabling Cached Playback.

This method also sets that Cached Playback should be disabled.

Parameters

[in] mitigation The mitigation to fix the reason for disabling Cached Playback.

void reset ( )

Resets the disabling info to an enabled state.

This method sets the "cache disabled" flag to false and clears the reason and mitigation strings.

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