class MPxImagePlane

Jump to documentation

: public MPxNode Base class for user defined imagePlane nodes. (OpenMaya) (OpenMayaMPx.py)

Inheritance:

MPxImagePlane < MPxNode

public members:

MPxImagePlane ()
virtual ~MPxImagePlane ()
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 MObject imageType
controls the source of the image on the Image plane.
static MObject imageName
The file name of the image to be used in the image plane. Only used if Type is set to Image File.
static MObject useFrameExtension
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).
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
Controls the lower-left-corner of the area of the input image that will be used on the image plane.
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
If the Type attribute is set to Texture, then this attribute is connected to the texture node used by the image plane.
static MObject fit
Controls how the image file will be fit into the image plane.
static MObject displayMode
Controls how the image plane will be displayed both in the 3d view, and when rendered.
static MObject displayOnlyIfCurrent
If enabled, you will only see the image plane when you are looking through the camera that the plane is attached to.
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
Controls how much the center of the image plane is offset from the centre of the viewing frustum of the camera.
static MObject offsetX
Horizontal component of Offset
static MObject offsetY
Vertical component of Offset
static MObject center
Controls the world-space position of the center of the image plane.
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
When ray tracing, controls whether the image plane will sppear in reflected surfaces.
static MObject visibleInRefractions
When ray tracing, controls whether the image plane will appear when seen through a transparent, refractive surface.
static MObject rotate
Rotation of the image plane around the view vector.
static MObject alreadyPremult
Indicates if the image plane has already been pre-multiplied by its alpha.
static MObject useDepthMap
Indicates that the image plane has depth information.
static MObject composite
Indicates whether or not the image plane's color should be composited into the final image.
static MObject depthOversample
Indicates if the depth information is at a higher resolution than the image resolution.
static MObject separateDepth
Users can specify a depth buffer that is larger than the image buffer using the 'depthFile' attribute.
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.

Inherited from MPxNode:

public members:

enum Type
kDependNode
kLocatorNode
kDeformerNode
kManipContainer
kSurfaceShape
kFieldNode
kEmitterNode
kSpringNode
kIkSolverNode
kHardwareShader
Custom shader derived from MPxHardwareShader
kHwShaderNode
Custom shader derived from MPxHwShaderNode
kTransformNode
kObjectSet
kFluidEmitterNode
kImagePlaneNode
kParticleAttributeMapperNode
kConstraintNode
kLast
virtual void postConstructor ()
virtual MStatus compute ( const MPlug & plug, MDataBlock & dataBlock )
virtual bool getInternalValueInContext ( const MPlug & plug, MDataHandle & dataHandle, MDGContext & ctx)
virtual bool setInternalValueInContext ( const MPlug & plug, const MDataHandle & dataHandle, MDGContext & ctx)
virtual bool getInternalValue ( const MPlug & plug, MDataHandle & dataHandle)
virtual bool setInternalValue ( const MPlug & plug, const MDataHandle & dataHandle)
virtual int internalArrayCount ( const MPlug & plug, const MDGContext & ctx) const
virtual void copyInternalData ( MPxNode * )
virtual MStatus legalConnection ( const MPlug & plug, const MPlug & otherPlug, bool asSrc, bool& isLegal ) const
virtual MStatus legalDisconnection ( const MPlug & plug, const MPlug & otherPlug, bool asSrc, bool& isLegal ) const
virtual MStatus setDependentsDirty ( const MPlug & plug, MPlugArray & plugArray)
virtual MStatus connectionMade ( const MPlug & plug, const MPlug & otherPlug, bool asSrc )
virtual MStatus connectionBroken ( const MPlug & plug, const MPlug & otherPlug, bool asSrc )
virtual bool isPassiveOutput ( const MPlug & plug ) const
virtual MStatus shouldSave ( const MPlug & plug, bool& isSaving )
virtual MPlug passThroughToOne ( const MPlug & plug ) const
virtual bool passThroughToMany ( const MPlug & plug, MPlugArray & plugArray ) const
MTypeId typeId () const
MString typeName () const
MString name () const
virtual Type type () const
virtual bool isAbstractClass () const
MObject thisMObject () const
static MStatus addAttribute ( const MObject & attr )
static MStatus inheritAttributesFrom ( const MString & parentClassName )
static MStatus attributeAffects ( const MObject & whenChanges, const MObject & isAffected )
MStatus setExistWithoutInConnections ( bool flag )
bool existWithoutInConnections ( MStatus * ReturnStatus = NULL ) const
MStatus setExistWithoutOutConnections ( bool flag )
bool existWithoutOutConnections ( MStatus * ReturnStatus = NULL ) const
static MObject message
static MObject isHistoricallyInteresting
static MObject caching
static MObject state

protected members:

MDataBlock forceCache ( MDGContext & ctx= MDGContext::fsNormal )
void setMPSafe ( bool flag )
MStatus setDoNotWrite ( bool flag )
bool doNotWrite ( MStatus *ReturnStatus = NULL ) const

Documentation

Base class for user defined imagePlane nodes. (OpenMaya) (OpenMayaMPx.py)
Description

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'.

Functions

MPxImagePlane:: MPxImagePlane ()

Description

Class constructor.

MPxImagePlane:: ~MPxImagePlane ()

Description

Class destructor.

MStatus MPxImagePlane:: loadImageMap ( const MString &fileName, int frame, MImage &image )

Description

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

Arguments

  • fileName The name of the file to be loaded.
  • frame The frame number to be displayed.
  • image The image representing the image plane data.

Return Value

  • MStatus::kSuccss The file was successfully loaded.

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

Description

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

Arguments

  • refFileName The file name to be expanded
  • actualName The exact file name.

Return Value

  • 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 )

Description

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.

Arguments

  • refFileName The file name to be expanded

Return Value

  • String containing the image file name, will be empty string on failure

void MPxImagePlane:: refreshImage ( )

Description Forces the image plane to be refreshed.

void MPxImagePlane:: setImageDirty ()

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

This class has no child classes.


Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright