C++ API Reference
|
Hardware shader swatch generator utility class. More...
#include <MHWShaderSwatchGenerator.h>
Public Member Functions | |
MHWShaderSwatchGenerator (MObject obj, MObject renderObj, int res) | |
Class constructor. More... | |
bool | doIteration () override |
This method will be called from the MSwatchRenderRegister for generating a swatch image. More... | |
Public Member Functions inherited from MSwatchRenderBase | |
MSwatchRenderBase (MObject obj, MObject renderObj, int res) | |
Class constructor. More... | |
virtual | ~MSwatchRenderBase () |
Class destructor. | |
virtual bool | renderParallel () |
Method indicates if the swatch is rendered parallel. More... | |
virtual void | cancelParallelRendering () |
Method to cancel the parallel rendering. More... | |
MObject | swatchNode () const |
This method returns the node for which the swatch is required to be generated. | |
MObject | node () const |
This method returns the node that is used to compute the swatch. | |
int | resolution () const |
This method returns the expected resolution of the swatch. | |
MImage & | image () |
This method returns the the render swatch as an image. | |
void | setRenderQuality (int) |
Method to set the render quality in which the swatch will be rendered. More... | |
int | renderQuality () const |
Returns the quality in which the swatch will be rendered. More... | |
Static Public Member Functions | |
static MSwatchRenderBase * | createObj (MObject obj, MObject renderObj, int res) |
Class constructor. More... | |
static const MString & | initialize () |
This method sets a swatch name, and registers a new swatch generator creation function for the swatch name. More... | |
static void | getSwatchBackgroundColor (float &r, float &g, float &b, float &a) |
This method returns the default background color for the hardware rendered swatch. More... | |
Static Public Member Functions inherited from MSwatchRenderBase | |
static void | cancelCurrentSwatchRender () |
The method cancels the swatch which is being rendered in parallel, and push the swatch render item back to the render queue after. More... | |
static void | enableSwatchRender (bool enable) |
Enable/disable swatch rendering. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from MSwatchRenderBase | |
void | finishParallelRender () |
Method to update the swatch image when the parallel rendering is finished. More... | |
Hardware shader swatch generator utility class.
Derived from the MSwatchRenderBase class as a utility for generating a swatch for a plugin hardware shader class. This class supports hardware shaders derived from both MPxHardwareShader and the older MPxHwShaderNode base classes.
OPENMAYA_MAJOR_NAMESPACE_OPEN MHWShaderSwatchGenerator | ( | MObject | obj, |
MObject | renderObj, | ||
int | res | ||
) |
Class constructor.
Initializes base class
[in] | obj | The node object for which the swatch needs to be generated. |
[in] | renderObj | The node used to actually compute the swatch. In most situations, this can be the same as obj. This parameter can be used to request the computation of the swatch on another node, and display the swatch on the obj node. |
[in] | res | The expected resolution of the swatch image. |
|
static |
Class constructor.
Saves the Node object and image resolution as data members for future use.
[in] | obj | The node object for which the swatch needs to be generated. |
[in] | renderObj | The node used to actually compute the swatch. In most situations, this can be the same as obj. This parameter can be used to request the computation of the swatch on another node, and display the swatch on the obj node. |
[in] | resolution | The expected resolution of the swatch image. |
|
static |
This method sets a swatch name, and registers a new swatch generator creation function for the swatch name.
The string returned from this method can be used for node classification purpose.
|
static |
This method returns the default background color for the hardware rendered swatch.
[out] | r | Storage variable for red component. |
[out] | g | Storage variable for green component. |
[out] | b | Storage variable for blue component. |
[out] | a | Storage variable for alpha component. |
|
overridevirtual |
This method will be called from the MSwatchRenderRegister for generating a swatch image.
This doIteration function is called repeatedly (during idle events) till it returns true.
Reimplemented from MSwatchRenderBase.