|
C++ API Reference
|
|
C++ API Reference
|
This class is used by the getDrawRequests method of MPxSurfaceShapeUI to specify the current object drawing state for a user defined shape. More...
#include <MDrawInfo.h>
Inheritance diagram for MDrawInfo:Public Member Functions | |
| MDrawInfo () | |
| Constructor. | |
| MDrawInfo (const MDrawInfo &in) | |
| Copy constructor. More... | |
| virtual | ~MDrawInfo () |
| Destructor. | |
| MDrawRequest | getPrototype (const MPxSurfaceShapeUI &drawHandler) const |
| This method creates a draw request based on the current draw state. More... | |
| M3dView | view () const |
| Returns the view that the drawing will take place. More... | |
| const MDagPath | multiPath () const |
| Returns the path to the object to be drawn. More... | |
| void | setMultiPath (const MDagPath &) |
| Sets the path of the object to be drawn. | |
| const MMatrix | projectionMatrix () const |
| Returns the camera*projection matrix. More... | |
| const MMatrix | inclusiveMatrix () const |
| Returns the world space inclusive matrix. More... | |
| M3dView::DisplayStyle | displayStyle () const |
| The display appearance. More... | |
| M3dView::DisplayStatus | displayStatus () const |
| Returns the status of the object to draw. More... | |
| bool | objectDisplayStatus (M3dView::DisplayObjects) const |
| Determines whether the specified objects are allowed to be displayed. More... | |
| bool | pluginObjectDisplayStatus (const MString &pluginDisplayFilter) const |
| Determines whether the specified plugin object is allowed to be displayed. More... | |
| bool | inSelect () const |
| Returns true if this is called from within the select method of MPxSurfaceShapeUI. More... | |
| bool | inUserInteraction () const |
| Returns true during any interactive refresh, as when user is interacting with the scene in any way including camera changes, object or component TRS changes, etc. More... | |
| bool | userChangingViewContext () const |
| Returns true during any interactive refresh, as when user is changing the view using view context tools such as tumble, dolly or track. More... | |
| bool | completelyInside () const |
| Returns true if the object being drawn is inside the viewing frustum. More... | |
| bool | canDrawComponent (bool isDisplayOn, const MSelectionMask &compMask) const |
| Convenience method to test if components specified by the given mask can be drawn. More... | |
Static Public Member Functions | |
| static const char * | className () |
| Returns the name of this class. More... | |
This class is used by the getDrawRequests method of MPxSurfaceShapeUI to specify the current object drawing state for a user defined shape.
This getPrototype method is used to construct a draw request object based on the current draw state for the object.
See MDrawRequest for more information.
Deprecated in 2016.0
| MDrawRequest getPrototype | ( | const MPxSurfaceShapeUI & | drawHandler | ) | const |
This method creates a draw request based on the current draw state.
The draw request is placed onto maya's drawing queue (MDrawRequestQueue) where it can be processed in turn. The drawHandler argument is the shape that will be doing the drawing which is the object calling this function.
See MDrawRequest for more information.
| [in] | drawHandler | the ui object that is doing the drawing |
| M3dView view | ( | ) | const |
Returns the view that the drawing will take place.
| const MDagPath multiPath | ( | ) | const |
Returns the path to the object to be drawn.
| const MMatrix projectionMatrix | ( | ) | const |
Returns the camera*projection matrix.
| const MMatrix inclusiveMatrix | ( | ) | const |
Returns the world space inclusive matrix.
| M3dView::DisplayStyle displayStyle | ( | ) | const |
| M3dView::DisplayStatus displayStatus | ( | ) | const |
Returns the status of the object to draw.
| bool objectDisplayStatus | ( | M3dView::DisplayObjects | displayObj | ) | const |
Determines whether the specified objects are allowed to be displayed.
| bool pluginObjectDisplayStatus | ( | const MString & | pluginDisplayFilter | ) | const |
Determines whether the specified plugin object is allowed to be displayed.
| [in] | pluginDisplayFilter | The name of the plugin display filter which is registered by pluginDisplayFilter command. |
| bool inSelect | ( | ) | const |
Returns true if this is called from within the select method of MPxSurfaceShapeUI.
| bool inUserInteraction | ( | ) | const |
Returns true during any interactive refresh, as when user is interacting with the scene in any way including camera changes, object or component TRS changes, etc.
Use userChangingViewContext for determining whether user is changing the view using view context tools such as tumble, dolly or track.
| bool userChangingViewContext | ( | ) | const |
Returns true during any interactive refresh, as when user is changing the view using view context tools such as tumble, dolly or track.
Useful for changing drawing mode to something simpler to speed up interaction re-draw. Use inUserInteraction for determining whether user is interacting with the scene in any way.
| bool completelyInside | ( | ) | const |
Returns true if the object being drawn is inside the viewing frustum.
| bool canDrawComponent | ( | bool | isDisplayOn, |
| const MSelectionMask & | mask | ||
| ) | const |
Convenience method to test if components specified by the given mask can be drawn.
| [in] | isDisplayOn | component display is on |
| [in] | mask | component mask to test |
|
static |
Returns the name of this class.
1.8.10 
