1.5.6
#include <MDrawRequest.h>
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 :
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 };
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.
Public Member Functions | |
| MDrawRequest () | |
| MDrawRequest (const MDrawRequest &in) | |
| ~MDrawRequest () | |
| M3dView | view () const |
| void | setView (M3dView &) |
| const MDagPath | multiPath () const |
| void | setMultiPath (const MDagPath &) |
| MObject | component () const |
| void | setComponent (MObject &) |
| MDrawData | drawData () const |
| void | setDrawData (MDrawData &) |
| M3dView::DisplayStatus | displayStatus () const |
| void | setDisplayStatus (M3dView::DisplayStatus) |
| bool | displayCulling () const |
| void | setDisplayCulling (bool) |
| bool | displayCullOpposite () const |
| void | setDisplayCullOpposite (bool) |
| M3dView::DisplayStyle | displayStyle () const |
| void | setDisplayStyle (M3dView::DisplayStyle) |
| int | color (M3dView::ColorTable table) const |
| void | setColor (int, M3dView::ColorTable table) |
| MMaterial | material () const |
| void | setMaterial (MMaterial &) |
| bool | isTransparent () const |
| void | setIsTransparent (bool) |
| bool | drawLast () const |
| void | setDrawLast (bool) |
| int | token () const |
| void | setToken (int) |
| MDrawRequest & | operator= (const MDrawRequest &other) |
| MDrawRequest::MDrawRequest | ( | ) |
Constructor.
| MDrawRequest::MDrawRequest | ( | const MDrawRequest & | other | ) |
Copy constructor.
| [in] | other | value to copy |
| MDrawRequest::~MDrawRequest | ( | ) |
Destructor.
| M3dView MDrawRequest::view | ( | ) | const |
Returns the view where drawing will be done.
| void MDrawRequest::setView | ( | M3dView & | theView | ) |
Sets the view where drawing will be done.
| const MDagPath MDrawRequest::multiPath | ( | ) | const |
Returns the path to the object to be drawn.
| void MDrawRequest::setMultiPath | ( | const MDagPath & | thePath | ) |
Sets the path to the object to be drawn.
| MObject MDrawRequest::component | ( | ) | const |
An optional component. If set draw the components that are specified, otherwise draw all components of this type for the object.
| void MDrawRequest::setComponent | ( | MObject & | comp | ) |
Set a component to be drawn.
| [in] | comp | component to be drawn |
| MDrawData MDrawRequest::drawData | ( | ) | const |
Returns the object specific draw data.
| void MDrawRequest::setDrawData | ( | MDrawData & | data | ) |
Set the object specific draw data.
| [in] | data | draw data |
| M3dView::DisplayStatus MDrawRequest::displayStatus | ( | ) | const |
Return the state of object (active, dormant, etc.).
| void MDrawRequest::setDisplayStatus | ( | M3dView::DisplayStatus | status | ) |
Set the state of object (active, dormant, etc.).
| [in] | status | display status |
| bool MDrawRequest::displayCulling | ( | ) | const |
Returns the state of the culling flag for the object.
| void MDrawRequest::setDisplayCulling | ( | bool | value | ) |
Sets the state of the culling flag for the object.
| [in] | value | culling value to be set |
| bool MDrawRequest::displayCullOpposite | ( | ) | const |
Returns the state of the culling flag for the object.
| void MDrawRequest::setDisplayCullOpposite | ( | bool | value | ) |
Sets the state of the culling flag for the object.
| [in] | value | culling value to be set |
| M3dView::DisplayStyle MDrawRequest::displayStyle | ( | ) | const |
Returns how the object should be drawn (wireframe, shaded, etc.).
| void MDrawRequest::setDisplayStyle | ( | M3dView::DisplayStyle | style | ) |
Sets how the object should be drawn (wireframe, shaded, etc.).
| [in] | style | display style to set |
| int MDrawRequest::color | ( | M3dView::ColorTable | table | ) | const |
Returns the wireframe display color.
The color table specifies which of the 4 color planes to use. This table can be active, dormant, template, or background.
| [in] | table | color table |
| void MDrawRequest::setColor | ( | int | value, | |
| M3dView::ColorTable | table | |||
| ) |
Sets the wireframe display color.
The color table specifies which of the 4 color planes to use. This table can be active, dormant, template, or background.
| [in] | value | index into the color table |
| [in] | table | color table |
| MMaterial MDrawRequest::material | ( | ) | const |
Returns the shaded material.
| void MDrawRequest::setMaterial | ( | MMaterial & | material | ) |
Returns the shaded material.
| [in] | material | the material to set |
| bool MDrawRequest::isTransparent | ( | ) | const |
| void MDrawRequest::setIsTransparent | ( | bool | value | ) |
Sets the transparency state of the object.
| [in] | value | the transparency value |
| bool MDrawRequest::drawLast | ( | ) | const |
Returns the order in which this object will be drawn.
| void MDrawRequest::setDrawLast | ( | bool | value | ) |
Specifies the order in which this object will be drawn.
| [in] | value | draw last flag |
| int MDrawRequest::token | ( | ) | const |
Returns the user-defined draw token for this request.
The token is used to identify a particular part of an object to draw. It is also used to distinguish draw requests generated by derived UI objects from those generated by base classes. It some cases, it provides a way of indicating that a component should be displayed without creating a component MObject.
| void MDrawRequest::setToken | ( | int | value | ) |
Set the user-defined draw token for this request.
The token is used to identify a particular part of an object to draw. It is also used to distinguish draw requests generated by derived UI objects from those generated by base classes. It some cases, it provides a way of indicating that a component should be displayed without creating a component MObject.
| MDrawRequest & MDrawRequest::operator= | ( | const MDrawRequest & | other | ) |
| Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. |
Generated with
1.5.6
|