MaxwellMayaAPI class

MaxwellMayaAPI class

Description

This is the main interface to the Maxwell plug-in API. You obtain a pointer to this class by calling the GetMaxwellMayaAPI() function exported by the maxwell plug-in, or by using the convenience static method MaxwellMayaAPI::LoadAPI. For details on the loading process, see this page.

The interface allows you to:

  • query the exporter state and scene settings.

  • create new objects in the Maxwell scene.

  • locate existing objects in the Maxwell scene.

  • translate, create or find materials.

  • add extension objects to the scene (Maxwell plug-ins which perform modifications at render time).

  • list the available Maxwell extensions and their parameters.

Methods

void

EnableDebugMessages(bool enable)

ExporterState

GetExporterState() const

double

GetScalingFactor() const

MotionBlurType

GetGlobalMotionBlurType() const

MObject

GetMaxwellRenderOptionsNode() const

unsigned int

GetNumMotionSteps() const

double

GetRenderCamExposure() const

double

GetShutterOpenTime() const

double

GetShutterCloseTime() const

double

GetCurrentMotionTime() const

bool

GetCurrentShapePath(MDagPath& path) const

const MObjectArray&

GetCurrentShapeShaders() const

bool

GetCurrentShapeWorldMatrix(MMatrix& worldMatrix) const

bool

SetCurrentShapeOutput(MaxwellMayaShape* shape, unsigned int processingFlags)

MaxwellMayaShape*

GetCurrentMotionShape() const

bool

GetExportedShapeName(MString& name, const MDagPath& path) const

MaxwellMayaShape*

FindShape(const MString& name) const

MaxwellMayaCamera*

CreateCamera(const MString& name, unsigned int numMotionSteps)

MaxwellMayaCamera*

FindCamera(const MString& name) const

MaxwellMayaCamera*

GetActiveCamera() const

MaxwellMayaMaterial*

TranslateMaterial(const MObject& materialNode)

MaxwellMayaMaterial*

FindMaterial(const MString& name) const

MaxwellMayaReferencedMaterial*

CreateReferencedMaterial(const MString& name)

MaxwellMayaEmbeddedMaterial*

CreateEmbeddedMaterial(const MString& name)

MaxwellMayaEmbeddedMaterial*

LoadMaterial(const MString& fileName)

MaxwellMayaExtensionParams*

CreateExtensionParamBlock(const MString& extensionName)

MaxwellMayaMesh*

CreateMesh(const MString& name, unsigned int numVertices, unsigned int numNormals, unsigned int numTriangles, unsigned int numSteps)

MaxwellMayaInstance*

CreateInstance(const MString& name, const MaxwellMayaShape* originalShape)

MaxwellMayaInstance*

CreateInstance(const MString& name, const MString& originalShapeName)

MaxwellMayaExtensionShape*

CreateExtensionShape(const MString& name, ExtensionShapeType type, const MaxwellMayaExtensionParams* params)

MaxwellMayaMXSReference*

CreateMXSReference(const MString& name, const MString& fileName)

bool

AddSceneModifierExtension(const MaxwellMayaExtensionParams* params)

bool

AddSkyExtension(const MaxwellMayaExtensionParams* params)

unsigned int

GetNumExtensions(MaxwellMayaExtensionInfo::ExtensionType type) const

MaxwellMayaExtensionInfo*

GetExtensionInfo(MaxwellMayaExtensionInfo::ExtensionType type, unsigned int index) const

MaxwellMayaExtensionInfo*

GetExtensionInfo(const MString& name) const

unsigned int

GetCurrentAPIVersion() const

unsigned int

GetLowestSupportedAPIVersion() const

static const char*

GetStateName(ExporterState state)

static bool

SetExportCallback(const MString& pluginName, ExportCallbackType type, const MString& command, ExportCallbackLanguage language)

static bool

RemoveExportCallback(const MString& pluginName, ExportCallbackType type)

static bool

RemoveExportCallbacks(const MString& pluginName)

static MaxwellMayaAPI*

LoadAPI()