AL_USDMaya  0.16.6
USD to Maya Bridge
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
AL::usdmaya::nodes::ProxyDrawOverride Class Reference

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 MHWRender::MPxDrawOverride * creator (const MObject &obj)
 static creator method More...
 
static void draw (const MHWRender::MDrawContext &context, const MUserData *data)
 The draw callback, performs the actual rendering for the draw override. More...
 
static ProxyShapegetShape (const MDagPath &objPath)
 utility function to get a pointer to the proxy shape node given the specified path More...
 

Static Public Attributes

static MString kDrawDbClassification
 draw classification string for this override
 
static 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
objthe 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
objPathThe path to the object being drawn
cameraPathThe path to the camera that is being used to draw
Returns
the objects bounding box
static MHWRender::MPxDrawOverride* AL::usdmaya::nodes::ProxyDrawOverride::creator ( const MObject &  obj)
static

static creator method

Parameters
objthe handle to pass to the constructor
Returns
the new draw override instance
static 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
contextthe current draw context
datathe user data generated om the prepareForDraw method
static 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
objPaththe 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
objPathThe path to the object being drawn
cameraPathThe 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
objPathThe path to the object being drawn
cameraPathThe path to the camera that is being used to draw
frameContextFrame level context information
oldDataData 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: