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

#include <MPxBakeEngine.h>
Collaboration diagram for MPxBakeEngine:
Collaboration graph
[legend]

List of all members.


Detailed Description

Baking functionality.

The MPxBakeEngine class is a way for users to override the viewport representation of shaders. Users can provide their own baking engine to bake advanced shading properties into a texture. This texture is used by the viewport to represent the shading properties.


Public Member Functions

  MPxBakeEngine ()
virtual  ~MPxBakeEngine ()
void  setNeedTransparency (bool t)
void  getUVRange (MFloatArray minUV, MFloatArray maxUV)
virtual MStatus  bake (const MDagPath &objectPath, const MDagPath &cameraPath, const MPlug &samplePlug, MImage &bakeResult)=0

Friends

class  MFnPlugin

Constructor & Destructor Documentation

MPxBakeEngine::MPxBakeEngine (  ) 

Constructor.

MPxBakeEngine::~MPxBakeEngine (  )  [virtual]

The class destructor.


Member Function Documentation

void MPxBakeEngine::setNeedTransparency ( bool  t  ) 

Set whether the bake engine needs to produce an image with transparency.

Parameters:
[in]  t  whether transparency is needed

void MPxBakeEngine::getUVRange ( MFloatArray  minUV,
MFloatArray  maxUV  
)

Tells Maya the UV range the baked texture should cover.

Parameters:
[out]  minUV  the minimum UV value
[out]  maxUV  the maximum UV value

MStatus MPxBakeEngine::bake ( const MDagPath objectPath,
const MDagPath cameraPath,
const MPlug samplePlug,
MImage result  
) [pure virtual]

Bake the texture Maya will use to approximate shading properties.

Parameters:
[in]  objectPath  the object the texture will be applied to
[in]  cameraPath  the camera that should be used for baking
[in]  samplePlug  the plug being sampled, ie baked
[out]  result  the texture
Returns:
MS::kSuccess if a valid texture was created, MS::kFailure otherwise

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