MPxImagePlaneOverride Class Reference

#include <MPxImagePlaneOverride.h>

Class Description

Base class for user defined image plane draw overrides.

+ Examples:

Public Member Functions

 MPxImagePlaneOverride (const MObject &obj)
 Construct an MPxImagePlaneOverride. More...
 
virtual ~MPxImagePlaneOverride ()
 Destructor.
 
virtual ::MHWRender::DrawAPI supportedDrawAPIs () const
 Returns the draw API supported by this override. More...
 
MString getFileName (bool useImageSequence)
 This method can get the exact file name of image sequence or just return the original name if input is not sequence. More...
 
virtual void updateDG ()
 This method is called every time Maya needs to update the parameter which will later be used in method updateTexture(). More...
 
virtual void updateColorTexture ()
 This method is used for update texture which will be used to draw image plane. More...
 

Static Public Member Functions

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

Constructor & Destructor Documentation

MPxImagePlaneOverride ( const MObject obj)

Construct an MPxImagePlaneOverride.

Parameters
[in]objThe DAG object this override translates

Member Function Documentation

DrawAPI supportedDrawAPIs ( ) const

Returns the draw API supported by this override.

The returned value may be formed as the bitwise 'or' of MHWRender::DrawAPI elements to indicate that the override supports multiple draw APIs. This method returns 'MHWRender::kAllDevices' by default.

Returns
The draw API supported by this override
+ Examples:
const char * className ( )
static

Returns the name of this class.

Returns
Name of this class.
MString getFileName ( bool  useImageSequence)

This method can get the exact file name of image sequence or just return the original name if input is not sequence.

Parameters
[in]Ifuser use image sequence or not.
Returns
return the exact file name of the input texture.
void updateDG ( )
virtual

This method is called every time Maya needs to update the parameter which will later be used in method updateTexture().

The default implementation does nothing.

+ Examples:
void updateColorTexture ( )
virtual

This method is used for update texture which will be used to draw image plane.

User can set custom raw data to the texture. This method only deal with color texture. The default implementation does nothing.

+ Examples:

The documentation for this class was generated from the following files:
  • MPxImagePlaneOverride.h
  • MPxImagePlaneOverride.cpp