Public Types | Public Member Functions | Static Public Member Functions

MTextureEditorDrawInfo Class Reference

Search for all occurrences

Detailed Description

Drawing state for drawing to the UV texture window with custom shapes.

This class is used by drawUV method of MPxSurfaceShapeUI to specify the current UV drawing state for a user defined shape. API users must override the canDrawUV method on MPxSurfaceShapeUI to recieve drawUV calls. The only situation where the drawing style can change is during a selection event. However, selection events are currently not passed onto the API user. Therefore, most of the functionality in this class is place holder for future work.

See also:
MPxSurfaceShapeUI
Examples:

apiMeshShapeUI.cpp, and apiMeshShapeUI.h.

#include <MTextureEditorDrawInfo.h>

List of all members.

Public Types

enum  DrawingFunction {
  kDrawFunctionFirst = 1, kDrawWireframe = kDrawFunctionFirst, kDrawEverything, kDrawVertexForSelect,
  kDrawEdgeForSelect, kDrawFacetForSelect, kDrawUVForSelect, kDrawFunctionLast = kDrawUVForSelect
}
 

Draw modes.

More...

Public Member Functions

 MTextureEditorDrawInfo ()
 Constructor.
 MTextureEditorDrawInfo (const MTextureEditorDrawInfo &in)
 Copy constructor.
virtual ~MTextureEditorDrawInfo ()
 Destructor.
DrawingFunction drawingFunction () const
 Indicates the current drawing state for a drawUV method call.
void setDrawingFunction (DrawingFunction func)
 Sets the current drawing state.

Static Public Member Functions

static const char * className ()
 Returns the name of this class.

Member Enumeration Documentation

Draw modes.

Enumerator:
kDrawFunctionFirst 

Lowest possible enum value.

kDrawWireframe 

Draw wireframe only (default)

kDrawEverything 

Draw vertices, uvs, faces, and edges.

kDrawVertexForSelect 

Draw vertices for selection.

kDrawEdgeForSelect 

Draw edges for selection.

kDrawFacetForSelect 

Draw faces for selection.

kDrawUVForSelect 

Draw uvs for selection.

kDrawFunctionLast 

Highest possible enum value.


Constructor & Destructor Documentation

Copy constructor.

Parameters:
[in]othertexture draw info object to copy

Member Function Documentation

MTextureEditorDrawInfo::DrawingFunction drawingFunction ( ) const

Indicates the current drawing state for a drawUV method call.

Returns:
The current drawing function.
void setDrawingFunction ( MTextureEditorDrawInfo::DrawingFunction  func)

Sets the current drawing state.

Currently the API user is unable to set these values. All drawing state values are determined internally and passed onto the API programmer.

Parameters:
[in]funcdrawing function.
const char * className ( ) [static]

Returns the name of this class.

Returns:
Name of this class.

MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo
MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo MTextureEditorDrawInfo