MPxImagePlane Class Reference
[OpenMaya - API module for common classesProxy classes]

#include <MPxImagePlane.h>

Inheritance diagram for MPxImagePlane:

Inheritance graph
[legend]
Collaboration diagram for MPxImagePlane:

Collaboration graph
[legend]

List of all members.


Detailed Description

Base class for user defined imagePlane nodes.

MPxImagePlane provides you with the ability to write your own image plane classes. This allows you to support non-standard image data in an image plane or change the standard behaviour of the image plane.

Note, once you have created a custom image plane and created the node in a scene. You must attach the image plane to a camera using the 'imagePlane' attribute on the 'cameraShape'.

Examples:

customImagePlane.cpp.


Public Member Functions

 MPxImagePlane ()
virtual ~MPxImagePlane ()
virtual MPxNode::Type type () const
virtual MStatus loadImageMap (const MString &fileName, int frame, MImage &image)
bool getExactImageFile (const MString &refFileName, MString &actualName)
MString exactImageFile (const MString &refFileName)
void refreshImage ()
void setImageDirty ()

Static Public Attributes

static MObject imageType
 controls the source of the image on the Image plane.
static MObject imageName
static MObject useFrameExtension
static MObject frameExtension
 The frame extension in Image Name is replaced by the number here.
static MObject coverage
 Controls the amount of the image that will be used in the image plane.
static MObject coverageX
 The width in pixels of the area on the source image to be used.
static MObject coverageY
 The height in pixels of the area on the source image to be used.
static MObject coverageOrigin
static MObject coverageOriginX
 The pixel position of the left edge of the area of the source image to be used.
static MObject coverageOriginY
 The pixel position of the bottom edge of the area of the source image to be used.
static MObject sourceTexture
static MObject fit
 Controls how the image file will be fit into the image plane.
static MObject displayMode
static MObject displayOnlyIfCurrent
static MObject colorGain
 A multiplier applied to the colors in the image plane.
static MObject colorGainR
 The red component of Color Gain.
static MObject colorGainG
 The green component of Color Gain.
static MObject colorGainB
 The blue component of Color Gain.
static MObject colorOffset
 An additive value applied to the colors in the image plane.
static MObject colorOffsetR
 The red component of Color Offset.
static MObject colorOffsetG
 The green component of Color Offset.
static MObject colorOffsetB
 The blue component of Color Offset.
static MObject alphaGain
 A multiplier that is applied to the alpha value.
static MObject shadingSamplesOverride
 The flag to control if this surface should override global shading sample settings.
static MObject shadingSamples
 Specifies the minimum number of shading samples should be taken for this surface during rendering.
static MObject maxShadingSamples
 Specifies the max number of shading samples can be taken for this surface during rendering.
static MObject lockedToCamera
 If enabled, the image plane is locked to the camera's position.
static MObject depth
 Controls the distance of the plane from the camera.
static MObject squeezeCorrection
 Applies a horizontal scaling to an image.
static MObject size
 Controls the width and height of the image plane.
static MObject sizeX
 Image plane width.
static MObject sizeY
 Image plane height.
static MObject offset
static MObject offsetX
 Horizontal component of Offset.
static MObject offsetY
 Vertical component of Offset.
static MObject center
static MObject centerX
 X component of Center.
static MObject centerY
 Y component of Center.
static MObject centerZ
 Z component of Center.
static MObject width
 Controls the width of the image plane in world space.
static MObject height
 Controls the height of the image plane in world space.
static MObject visibleInReflections
static MObject visibleInRefractions
static MObject rotate
 Rotation of the image plane around the view vector.
static MObject alreadyPremult
static MObject useDepthMap
 Indicates that the image plane has depth information.
static MObject composite
static MObject depthOversample
static MObject separateDepth
static MObject depthFile
 Separate file that contains depth information.
static MObject depthBias
 Depth offset value -- centered at the center of the view frustum.
static MObject depthScale
 Scale the depth -- centered at the center of the view frustum.

Constructor & Destructor Documentation

MPxImagePlane::MPxImagePlane (  ) 

Class constructor.

MPxImagePlane::~MPxImagePlane (  )  [virtual]

Class destructor.


Member Function Documentation

MPxNode::Type MPxImagePlane::type (  )  const [virtual]

Returns the type of node that this is. This is used to differentiate user defined nodes that are derived off different MPx base classes.

It is not necessary to override this method.

Returns:
Type of the node

Reimplemented from MPxNode.

MStatus MPxImagePlane::loadImageMap ( const MString fileName,
int  frame,
MImage image 
) [virtual]

Override this method to load the file of name fileName into the image MImage.

Parameters:
[in] fileName The name of the file to be loaded.
[in] frame The frame number to be displayed.
[in] image The image representing the image plane data.
Returns:
MStatus::kSuccss The file was successfully loaded.
Examples:

bool MPxImagePlane::getExactImageFile ( const MString refFileName,
MString actualName 
)

API users can call this method to resolve a file name. Sometimes the file path specified by the user node are relative or contain environment variables that require expansion. Also getExactImageFile() will try to find the image file sequence if use sequence is on. API users do not have to call this method, and it is only provided for convienence purposes. The full path name will be returned in actualName.

Python Notes

This method is not supported in Python, see exactImageFile() instead

Parameters:
[in] refFileName The file name to be expanded
[in] actualName The exact file name.
Returns:
  • true The file was found and the file name was expanded.
  • false The file was not found and the file name was not expanded.

MString MPxImagePlane::exactImageFile ( const MString refFileName  ) 

API users can call this method to resolve a file name. Sometimes the file path specified by the user node are relative or contain environment variables that require expansion. Also getExactImageFile() will try to find the image file sequence if use sequence is on. API users do not have to call this method, and it is only provided for convienence purposes. The full path name will be returned in actualName.

Parameters:
[in] refFileName The file name to be expanded
Returns:
String containing the image file name, will be empty string on failure

void MPxImagePlane::refreshImage (  ) 

Forces the image plane to be refreshed.

void MPxImagePlane::setImageDirty (  ) 

Forces the image plane to be reloaded on the next refresh.


Member Data Documentation

The file name of the image to be used in the image plane. Only used if Type is set to Image File.

When this is on, the system will substitute the frame number in the Image Name with the number from the Frame Extension attribute (see below).

Controls the lower-left-corner of the area of the input image that will be used on the image plane.

If the Type attribute is set to Texture, then this attribute is connected to the texture node used by the image plane.

Controls how the image plane will be displayed both in the 3d view, and when rendered.

If enabled, you will only see the image plane when you are looking through the camera that the plane is attached to.

Controls how much the center of the image plane is offset from the centre of the viewing frustum of the camera.

Controls the world-space position of the center of the image plane.

When ray tracing, controls whether the image plane will sppear in reflected surfaces.

When ray tracing, controls whether the image plane will appear when seen through a transparent, refractive surface.

Indicates if the image plane has already been pre-multiplied by its alpha.

Indicates whether or not the image plane's color should be composited into the final image.

Indicates if the depth information is at a higher resolution than the image resolution.

Users can specify a depth buffer that is larger than the image buffer using the 'depthFile' attribute.


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6