#include <MDrawProcedureBase.h>
This method is obsolete.
This class provides an interface through which a plug-in can be writen to implement a class to provide custom hardware drawing effects.
The derived class can be added, removed, or reordered in a list of draw procedures used by the hardware renderer. Please refer to documentation for MHardwareRenderer for more details.
Each procedure has a user defined string name and can be enabled or disabled. Name, and enabling methods must be defined.
All derived classes must over the execute() method. This is the method that will be called by the hardware renderer to which the procedure is attached. The call will only be made if the procedure is enabled.
Public Member Functions | |
MDrawProcedureBase (const MString &name) | |
Constructor for a draw procedure. More... | |
virtual | ~MDrawProcedureBase () |
Default destructor for a draw procedure. | |
virtual bool | execute ()=0 |
This method gets called by the renderer to execture the draw procedure. More... | |
void | setEnabled (bool value) |
This method sets whether the draw procedure is enabled or not. More... | |
bool | enabled () const |
This method returns whether the draw procedure is enabled or not. More... | |
void | setName (const MString &name) |
This method sets the name for the draw procedure. More... | |
const MString & | name () const |
This method returns the name of the draw procedure. | |
OPENMAYA_MAJOR_NAMESPACE_OPEN MDrawProcedureBase | ( | const MString & | name | ) |
Constructor for a draw procedure.
By default the procedure is disabled.
[in] | name | name of the procedure. This is a required argument. |
|
pure virtual |
This method gets called by the renderer to execture the draw procedure.
Derived class of MDrawProcedureBase must implement this method as it defined as a pure virtual method on this class. The implementation is free to perform any drawing functionality from within this method.
void setEnabled | ( | bool | value | ) |
This method sets whether the draw procedure is enabled or not.
[in] | value | Boolean value to set the enabling state. |
bool enabled | ( | ) | const |
This method returns whether the draw procedure is enabled or not.
void setName | ( | const MString & | name | ) |
This method sets the name for the draw procedure.
[in] | name | Name to set. |