class MDrawInfo

Jump to documentation

Inheritance:

MDrawInfo

public members:

	MDrawInfo ()
	MDrawInfo ( const MDrawInfo & in )
virtual	~MDrawInfo ()
MDrawRequest	getPrototype ( const MPxSurfaceShapeUI & drawHandler ) const
M3dView	view () const
const MDagPath	multiPath () const
const MMatrix	projectionMatrix () const
const MMatrix	inclusiveMatrix () const
M3dView::DisplayStyle	displayStyle () const
M3dView::DisplayStatus	displayStatus () const
bool	objectDisplayStatus ( M3dView::DisplayObjects ) const
bool	inSelect () const
bool	completelyInside () const
bool	canDrawComponent ( bool isDisplayOn, const MSelectionMask & compMask ) const

Documentation

Description

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.

Functions

MDrawInfo:: MDrawInfo ()

Description

Constructor.

MDrawInfo:: MDrawInfo ( const MDrawInfo & other )

Description

Copy constructor.

Arguments

• other draw info object to copy

MDrawInfo:: ~MDrawInfo ()

Description

Destructor.

MDrawRequest MDrawInfo:: getPrototype ( const MPxSurfaceShapeUI & drawHandler) const

Description

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.

Arguments

• drawHandler the ui object that is doing the drawing

Return Value

• a draw request

M3dView MDrawInfo:: view () const

Description

Returns the view that the drawing will take place.

Return Value

• the view

const MDagPath MDrawInfo:: multiPath () const

Description

Returns the path to the object to be drawn.

Return Value

• the path to the object to be drawn

const MMatrix MDrawInfo:: projectionMatrix () const

Description

Returns the camera*projection matrix.

Return Value

• the camera projection matrix

const MMatrix MDrawInfo:: inclusiveMatrix () const

Description

Returns the world space inclusive matrix.

Return Value

• world space inclusive matrix

M3dView::DisplayStyle MDrawInfo:: displayStyle () const

Description

The display appearance.

Return Value

• The display appearance.

M3dView::DisplayStatus MDrawInfo:: displayStatus () const

Description

Returns the status of the object to draw.

Return Value

• object display status

bool MDrawInfo:: objectDisplayStatus ( M3dView::DisplayObjects displayObj ) const

Description

Returns the status of the excluded objects

Return Value

• excluded object display status

bool MDrawInfo:: inSelect () const

Description

Returns true if this is called from within the select method of MPxSurfaceShapeUI.

Return Value

• true in select
• false in draw

bool MDrawInfo:: completelyInside () const

Description

Returns true if the object being drawn is inside the viewing frustum.

Return Value

• true object inside frustum
• false object not completely inside frustum

bool MDrawInfo:: canDrawComponent ( bool isDisplayOn, const MSelectionMask & mask ) const

Description

Convenience method to test if components specified by the given mask can be drawn.

Arguments

• isDisplayOn component display is on
• mask component mask to test

Return Value

• true the specified component can be drawn
• false the specified component cannot be drawn

Direct child classes:

- MSelectInfo