This reference page is linked to from the following overview topics: 描画とリフレッシュ, ハードウェアシェーディングノードプラグインの概要.

Detailed Description

A draw reqeust used in the draw methods of MPxSurfaceShapeUI.

This class encapsulates all the information needed to fulfill a request to draw an object or part of an object. This class is used by the draw methods of MPxSurfaceShapeUI derived objects.

The draw request should be created in the overridden MPxSurfaceShapeUI::getDrawRequests method. Once created the appropriate "set" methods of this class should be used to define what is being requested. Then the request should be placed on the draw reqeust queue using MDrawRequestQueue::add.

When your request gets processed by maya, your overriden MPxSurfaceShape::draw method will get called with your request. Use the query methods of this class to determine what to draw.

You create a draw request using the method MDrawInfo::getPrototype. A draw request automatically picks up certain information (listed below) upon its creation. So you don't have to set any of this information unless you want to change it.

Information automatically set by MDrawInfo::getPrototype :

path path to object to be drawn
view view to draw in
matrix world matrix for object
display appearance how object should be drawn
display status active, dormant etc.

The draw token is an integer value which you can use to specify what is to be drawn. This is object specific and so you should define an enum with the information you require to decide what is being drawn in your MPxSurfaceShapeUI::draw method.

Here is an example of draw token values for a polygonal mesh object as defined in an MPxSurfaceShapeUI derived class.

    // Draw Tokens
    //
    enum {
        kDrawVertices, // component token
        kDrawWireframe,
        kDrawWireframeOnShaded,
        kDrawSmoothShaded,
        kDrawFlatShaded,
        kLastToken
    };

Examples:: apiMeshShapeUI.cpp, apiMeshShapeUI.h, apiSimpleShapeUI.cpp, apiSimpleShapeUI.h, blindDataShader.cpp, blindDataShader.h, hwAnisotropicShader_NV20.cpp, hwAnisotropicShader_NV20.h, hwColorPerVertexShader.cpp, hwDecalBumpShader_NV20.cpp, hwDecalBumpShader_NV20.h, hwPhongShader.cpp, hwPhongShader.h, hwReflectBumpShader_NV20.cpp, hwReflectBumpShader_NV20.h, hwRefractReflectShader_NV20.cpp, hwRefractReflectShader_NV20.h, hwToonShader_NV20.cpp, hwToonShader_NV20.h, hwUnlitShader.cpp, hwUnlitShader.h, pnTrianglesNode.cpp, pnTrianglesNode.h, and quadricShape.cpp.

#include <MDrawRequest.h>

List of all members.

Public Member Functions
	MDrawRequest ()
	Constructor.
	MDrawRequest (const MDrawRequest &in)
	Copy constructor.
	~MDrawRequest ()
	Destructor.
M3dView	view () const
	Returns the view where drawing will be done. Search for all occurrences
void	setView (M3dView &)
	Sets the view where drawing will be done. Search for all occurrences
const MDagPath	multiPath () const
	Returns the path to the object to be drawn. Search for all occurrences
void	setMultiPath (const MDagPath &)
	Sets the path to the object to be drawn.
MObject	component () const
	An optional component.
void	setComponent (MObject &)
	Set a component to be drawn. Search for all occurrences
MDrawData	drawData () const
	Returns the object specific draw data.
void	setDrawData (MDrawData &)
	Set the object specific draw data. Search for all occurrences
M3dView::DisplayStatus	displayStatus () const
	Return the state of object (active, dormant, etc.).
void	setDisplayStatus (M3dView::DisplayStatus)
	Set the state of object (active, dormant, etc.). Search for all occurrences
bool	displayCulling () const
	Returns the state of the culling flag for the object.
void	setDisplayCulling (bool)
	Sets the state of the culling flag for the object. Search for all occurrences
bool	displayCullOpposite () const
	Returns the state of the culling flag for the object.
void	setDisplayCullOpposite (bool)
	Sets the state of the culling flag for the object. Search for all occurrences
M3dView::DisplayStyle	displayStyle () const
	Returns how the object should be drawn (wireframe, shaded, etc.).
void	setDisplayStyle (M3dView::DisplayStyle)
	Sets how the object should be drawn (wireframe, shaded, etc.).
int	color (M3dView::ColorTable table) const
	Returns the wireframe display color.
void	setColor (int, M3dView::ColorTable table)
	Sets the wireframe display color. Search for all occurrences
MMaterial	material () const
	Returns the shaded material.
void	setMaterial (MMaterial &)
	Returns the shaded material. Search for all occurrences
bool	isTransparent () const
	Returns the transparency state of the object.
void	setIsTransparent (bool)
	Sets the transparency state of the object. Search for all occurrences
bool	drawLast () const
	Returns the order in which this object will be drawn.
void	setDrawLast (bool)
	Specifies the order in which this object will be drawn.
int	token () const
	Returns the user-defined draw token for this request.
void	setToken (int)
	Set the user-defined draw token for this request.
const MMatrix &	matrix () const
	Returns the draw matrix.
void	setMatrix (const MMatrix &)
	Set the draw matrix.
MDrawRequest &	operator= (const MDrawRequest &other)
	Assignment operator.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class. Search for all occurrences

Constructor & Destructor Documentation

MDrawRequest ( const MDrawRequest & other )

Copy constructor.

Parameters:

[in] other value to copy

Member Function Documentation

MObject component ( ) const

MDrawRequest Class Reference

OpenMayaUI - API module for user interface

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation