This class provides the draw override for the USD proxy shape node. More...

#include <ProxyDrawOverride.h>

Inheritance diagram for AL::usdmaya::nodes::ProxyDrawOverride:

Public Member Functions
	ProxyDrawOverride (const MObject &obj)
	ctor More...

	~ProxyDrawOverride ()
	dtor

bool	isBounded (const MDagPath &objPath, const MDagPath &cameraPath) const override
	Called by Maya to determine if the drawable object is bounded or not. More...

MBoundingBox	boundingBox (const MDagPath &objPath, const MDagPath &cameraPath) const override
	Called by Maya whenever the bounding box of the drawable object is needed. More...

MUserData *	prepareForDraw (const MDagPath &objPath, const MDagPath &cameraPath, const MHWRender::MFrameContext &frameContext, MUserData *oldData) override
	Called by Maya whenever the object is dirty and needs to update for draw. More...

MHWRender::DrawAPI	supportedDrawAPIs () const override
	We support the legacy and VP2 core profile rendering. More...

Static Public Member Functions
static AL_USDMAYA_PUBLIC MHWRender::MPxDrawOverride *	creator (const MObject &obj)
	static creator method More...

static AL_USDMAYA_PUBLIC void	draw (const MHWRender::MDrawContext &context, const MUserData *data)
	The draw callback, performs the actual rendering for the draw override. More...

static AL_USDMAYA_PUBLIC ProxyShape *	getShape (const MDagPath &objPath)
	utility function to get a pointer to the proxy shape node given the specified path More...

Static Public Attributes
static AL_USDMAYA_PUBLIC MString	kDrawDbClassification
	draw classification string for this override

static AL_USDMAYA_PUBLIC MString	kDrawRegistrantId
	draw registration id for this override

Detailed Description

This class provides the draw override for the USD proxy shape node.

Constructor & Destructor Documentation

AL::usdmaya::nodes::ProxyDrawOverride::ProxyDrawOverride ( const MObject & obj )

ctor

Parameters

obj	the object this override will be rendering

Member Function Documentation

MBoundingBox AL::usdmaya::nodes::ProxyDrawOverride::boundingBox	(	const MDagPath &	objPath,
		const MDagPath &	cameraPath
	)		const

override

Called by Maya whenever the bounding box of the drawable object is needed.

Parameters

objPath	The path to the object being drawn
cameraPath	The path to the camera that is being used to draw

Returns: the objects bounding box

static AL_USDMAYA_PUBLIC MHWRender::MPxDrawOverride* AL::usdmaya::nodes::ProxyDrawOverride::creator ( const MObject & obj )

static

static creator method

Parameters

obj	the handle to pass to the constructor

Returns: the new draw override instance

static AL_USDMAYA_PUBLIC void AL::usdmaya::nodes::ProxyDrawOverride::draw	(	const MHWRender::MDrawContext &	context,
		const MUserData *	data
	)

static

The draw callback, performs the actual rendering for the draw override.

Parameters

context	the current draw context
data	the user data generated om the prepareForDraw method

static AL_USDMAYA_PUBLIC ProxyShape* AL::usdmaya::nodes::ProxyDrawOverride::getShape ( const MDagPath & objPath )

static

utility function to get a pointer to the proxy shape node given the specified path

Parameters

objPath the path to the shape you wish to query

Returns: returns a pointer to the proxy shape node at the path (or null if not found)

bool AL::usdmaya::nodes::ProxyDrawOverride::isBounded	(	const MDagPath &	objPath,
		const MDagPath &	cameraPath
	)		const

override

Called by Maya to determine if the drawable object is bounded or not.

Parameters

objPath	The path to the object being drawn
cameraPath	The path to the camera that is being used to draw

Returns: true if the object is bounded

MUserData* AL::usdmaya::nodes::ProxyDrawOverride::prepareForDraw	(	const MDagPath &	objPath,
		const MDagPath &	cameraPath,
		const MHWRender::MFrameContext &	frameContext,
		MUserData *	oldData
	)

override

Called by Maya whenever the object is dirty and needs to update for draw.

Parameters

objPath	The path to the object being drawn
cameraPath	The path to the camera that is being used to draw
frameContext	Frame level context information
oldData	Data cached by the previous draw of the instance

Returns: Pointer to data to be passed to the draw callback method

MHWRender::DrawAPI AL::usdmaya::nodes::ProxyDrawOverride::supportedDrawAPIs ( ) const

inlineoverride

We support the legacy and VP2 core profile rendering.

Returns: MHWRender::kOpenGL | MHWRender::kOpenGLCoreProfile

The documentation for this class was generated from the following file:

src/lib/AL_USDMaya/AL/usdmaya/nodes/ProxyDrawOverride.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation