MLibrary Class Reference

Search for all occurrences

---

Detailed Description

Set up Maya to run in library mode. (OpenMaya)

Initialize and cleanup routines for Maya running in library mode.

When creating a "library mode" Maya application, this class must be used in the program's main routine to initialize Maya, and later to cleanUp allocated Maya state. A typical usage would be:

    main(int argc, char **argv)
    {
        MStatus status;
        status = MLibrary::initialize (argv[0], true);
        if ( !status ) {
            status.perror("MLibrary::initialize");
            return (1);
        }

        // Maya API code goes here

        MLibrary::cleanup();
        return (0);
    }

If the call to cleanup is omitted, you will get errors when the program exits as the static destructors in the Maya libraries are run.

#include <MLibrary.h>

List of all members.

Public Member Functions
	MLibrary ()
	The default class constructor.
virtual	~MLibrary ()
	The class destructor.
Static Public Member Functions
static MStatus	initialize (const char *applicationName, bool useBatchLicense=false)
	Initialize the Maya library.
static MStatus	initialize (bool wantScriptOutput, const char *applicationName, bool useBatchLicense=false)
	Initialize the Maya library.
static void	cleanup (int exitStatus=0)
	Undo the initialization performed by the initialize method, cleanup allocated Maya structures in an orderly fashion and terminate the application.

---

Member Function Documentation

MStatus initialize	(	const char *	applicationName,
		bool	useBatchLicense = false
	)		[static]

Search for all occurrences

Initialize the Maya library.

This method must be called before any Maya functionsets are used. It is acceptable to instantiate Maya fundamental types before calling this, but attempts to do anything else cause unpredictable results. When writing a Maya library mode application, a call to this method should be the first line of main.

Parameters:

[in]	applicationName	The name of this application. Typically argv[0] from the application's main() function is passed in this parameter.
[in]	useBatchLicense	Determines whether a full or batch license of Maya is required to run the application. Most of Maya's features are accessible to library applications with just a batch license. Note that this setting does not affect the result of MGlobal::mayaState(), which always returns kLibraryApp for library applications, nor does it it affect the result of the about -batch command, which always returns true for library applications.

Returns:

• MS::kSuccess Maya was initialized successfully.
• MS::kLicenseFailure The requested license could not be obtained.
• MS::kFailure Maya failed to initialize.

Examples:

asciiToBinary.cpp, helloWorld.cpp, readAndWrite.cpp, surfaceCreate.cpp, and surfaceTwist.cpp.

MStatus initialize	(	bool	wantScriptOutput,
		const char *	applicationName,
		bool	useBatchLicense = false
	)		[static]

Search for all occurrences

Initialize the Maya library.

This method must be called before any Maya functionsets are used. It is acceptable to instantiate Maya fundamental types before calling this, but attempts to do anything else cause unpredictable results. When writing a Maya library mode application, a call to this method should be the first line of main.

Parameters:

[in]	wantScriptOutput	Set to true if you wish script output to be generated. For example if you are using the the MGlobal::displayInfo() method.
[in]	applicationName	The name of this application. Typically argv[0] from the application's main() function is passed in this parameter.
[in]	useBatchLicense	Determines whether a full or batch license of Maya is required to run the application. Most of Maya's features are accessible to library applications with just a batch license. Note that this setting does not affect the result of MGlobal::mayaState(), which always returns kLibraryApp for library applications, nor does it it affect the result of the about -batch command, which always returns true for library applications.

Returns:

• MS::kSuccess Maya was initialized successfully.
• MS::kLicenseFailure The requested license could not be obtained.
• MS::kFailure Maya failed to initialize.

void cleanup

(

int

exitStatus = 0

)

[static]

Search for all occurrences

Undo the initialization performed by the initialize method, cleanup allocated Maya structures in an orderly fashion and terminate the application.

Note: calling this method will cause the standalone application to exit. As a result this method should be called in place of the usual exit call that would normally be made when the application is finished its work.

Note: when this method causes the application to exit, it does so in a way that prevents any static destructors from being executed.

If a parameter is provided, its value is used as the exit status for the application.

If the application is terminated with exit instead of this method, it will return errors when the application exits as static destructors in the Maya libraries are run.

NOTE: This method will not return control to your application when it completes.

Parameters:

[in]

exitStatus

The exit code the application will return.

Examples:

asciiToBinary.cpp, helloWorld.cpp, readAndWrite.cpp, surfaceCreate.cpp, and surfaceTwist.cpp.