Initial commit
This commit is contained in:
Eagle517
319
Torque/SDK/lib/mayasdk5/include/maya/MGlobal.h
Normal file
319
Torque/SDK/lib/mayasdk5/include/maya/MGlobal.h
Normal file
@@ -0,0 +1,319 @@
|
||||
|
||||
#ifndef _MGlobal
|
||||
#define _MGlobal
|
||||
//
|
||||
// *****************************************************************************
|
||||
//
|
||||
// Copyright (C) 1997-2003 Alias|Wavefront Inc.
|
||||
//
|
||||
// These coded instructions, statements and computer programs contain
|
||||
// unpublished information proprietary to Alias|Wavefront Inc. and are
|
||||
// protected by Canadian and US federal copyright laws. They may not be
|
||||
// disclosed to third parties or copied or duplicated, in whole or in part,
|
||||
// without prior written consent of Alias|Wavefront Inc.
|
||||
//
|
||||
// Unpublished-rights reserved under the Copyright Laws of the United States.
|
||||
//
|
||||
// *****************************************************************************
|
||||
//
|
||||
// CLASS: MGlobal
|
||||
//
|
||||
// *****************************************************************************
|
||||
//
|
||||
// CLASS DESCRIPTION (MGlobal)
|
||||
//
|
||||
// MGlobal is a static class which provides access to Maya's model (3d
|
||||
// graphical database).
|
||||
//
|
||||
// MGlobal provides methods for selection, 3d-views, setting the global
|
||||
// time, adding to the DAG, and executing MEL commands from within the API.
|
||||
//
|
||||
// MGlobal also provides methods for controlling error logging in the API.
|
||||
//
|
||||
// *****************************************************************************
|
||||
|
||||
#if defined __cplusplus
|
||||
|
||||
// *****************************************************************************
|
||||
|
||||
// INCLUDED HEADER FILES
|
||||
|
||||
|
||||
#include <maya/MIntArray.h>
|
||||
#include <maya/MDoubleArray.h>
|
||||
#include <maya/MString.h>
|
||||
#include <maya/MStringArray.h>
|
||||
#include <maya/MObject.h>
|
||||
#include <maya/MStatus.h>
|
||||
#include <maya/MSelectionMask.h>
|
||||
#include <maya/MTransformationMatrix.h>
|
||||
|
||||
// *****************************************************************************
|
||||
|
||||
// DECLARATIONS
|
||||
|
||||
class MPoint;
|
||||
class MString;
|
||||
class MTime;
|
||||
class MVector;
|
||||
class MSelectionList;
|
||||
class MDagPath;
|
||||
class MObjectArray;
|
||||
class MCommandResult;
|
||||
|
||||
// *****************************************************************************
|
||||
|
||||
// CLASS DECLARATION (MGlobal)
|
||||
|
||||
/// Static class providing common API global functions
|
||||
/**
|
||||
Provide methods for selection, 3D-views, time, model manipulation and MEL
|
||||
commands.
|
||||
*/
|
||||
#ifdef _WIN32
|
||||
#pragma warning(disable: 4522)
|
||||
#endif // _WIN32
|
||||
|
||||
class OPENMAYA_EXPORT MGlobal
|
||||
{
|
||||
public:
|
||||
///
|
||||
static MString mayaVersion ();
|
||||
|
||||
///
|
||||
enum MMayaState {
|
||||
/// running with a UI
|
||||
kInteractive,
|
||||
/// running without a UI
|
||||
kBatch,
|
||||
/// rendering without a UI
|
||||
kBatchRender,
|
||||
/// A standalone (MLibrary) application is running
|
||||
kLibraryApp,
|
||||
/// Running in baseUI mode
|
||||
kBaseUIMode
|
||||
};
|
||||
|
||||
///
|
||||
static MMayaState mayaState( MStatus * ReturnStatus = NULL );
|
||||
///
|
||||
static MStatus getFunctionSetList( MObject forObject,
|
||||
MStringArray & array );
|
||||
///
|
||||
static MStatus getAssociatedSets( MSelectionList & list,
|
||||
MObjectArray & setArray );
|
||||
///
|
||||
static MStatus getSelectionListByName( const MString& name,
|
||||
MSelectionList &list );
|
||||
|
||||
///
|
||||
enum ListAdjustment { // Comments use active list as example.
|
||||
///
|
||||
kReplaceList, // Totally replace the active list with the given items.
|
||||
///
|
||||
kXORWithList, // If one of the given items is in the active list take
|
||||
// it out, otherwise add it to the active list.
|
||||
///
|
||||
kAddToList, // Add the items to the list
|
||||
///
|
||||
kRemoveFromList // Remove the items from the list
|
||||
};
|
||||
|
||||
///
|
||||
static MStatus getActiveSelectionList( MSelectionList & dest );
|
||||
///
|
||||
static MStatus getLiveList( MSelectionList & dest );
|
||||
///
|
||||
static MStatus getHiliteList( MSelectionList & dest );
|
||||
///
|
||||
static MStatus setActiveSelectionList( MSelectionList & src,
|
||||
ListAdjustment=kReplaceList);
|
||||
///
|
||||
static MStatus selectCommand( MSelectionList & src,
|
||||
ListAdjustment=kReplaceList);
|
||||
///
|
||||
static MStatus selectByName( const MString& name,
|
||||
ListAdjustment=kAddToList );
|
||||
///
|
||||
static MStatus unselectByName( const MString& name );
|
||||
///
|
||||
static MStatus select( MObject& object, ListAdjustment=kAddToList );
|
||||
///
|
||||
static MStatus select( MDagPath& object, MObject& component,
|
||||
ListAdjustment=kAddToList );
|
||||
///
|
||||
static MStatus unselect( MObject& object );
|
||||
///
|
||||
static MStatus unselect( MDagPath& object, MObject& component );
|
||||
///
|
||||
static MStatus selectFromScreen( short& x_pos, short& y_pos,
|
||||
ListAdjustment=kAddToList );
|
||||
///
|
||||
static MStatus selectFromScreen( short& start_x, short& start_y,
|
||||
short& end_x, short& end_y,
|
||||
ListAdjustment=kAddToList );
|
||||
|
||||
///
|
||||
enum MSelectionMode {
|
||||
///
|
||||
kSelectObjectMode,
|
||||
///
|
||||
kSelectComponentMode,
|
||||
///
|
||||
kSelectRootMode,
|
||||
///
|
||||
kSelectLeafMode,
|
||||
///
|
||||
kSelectTemplateMode
|
||||
};
|
||||
|
||||
///
|
||||
static MSelectionMode selectionMode( MStatus * ReturnStatus = NULL );
|
||||
///
|
||||
static MStatus setSelectionMode( MSelectionMode mode );
|
||||
|
||||
///
|
||||
static MSelectionMask objectSelectionMask( MStatus * ReturnStatus = NULL );
|
||||
///
|
||||
static MStatus setObjectSelectionMask( MSelectionMask& mask );
|
||||
///
|
||||
static MSelectionMask componentSelectionMask( MStatus * ReturnStatus =
|
||||
NULL );
|
||||
///
|
||||
static MStatus setComponentSelectionMask( MSelectionMask& mask );
|
||||
///
|
||||
static MSelectionMask animSelectionMask( MStatus * ReturnStatus = NULL );
|
||||
///
|
||||
static MStatus setAnimSelectionMask( MSelectionMask& mask );
|
||||
///
|
||||
static MSelectionMask miscSelectionMask( MStatus * ReturnStatus = NULL );
|
||||
///
|
||||
static MStatus setMiscSelectionMask( MSelectionMask& mask );
|
||||
|
||||
///
|
||||
static MStatus clearSelectionList();
|
||||
///
|
||||
static bool isSelected( MObject& object,
|
||||
MStatus * ReturnStatus = NULL );
|
||||
|
||||
///
|
||||
static MStatus viewFrame( const MTime & time );
|
||||
///
|
||||
static MStatus viewFrame( double time);
|
||||
|
||||
///
|
||||
static MStatus sourceFile( const MString& fileName );
|
||||
///
|
||||
static MStatus executeCommand( const MString& command,
|
||||
bool displayEnabled = false,
|
||||
bool undoEnabled = false);
|
||||
///
|
||||
static MStatus executeCommand( const MString& command,
|
||||
MCommandResult& result,
|
||||
bool displayEnabled = false,
|
||||
bool undoEnabled = false );
|
||||
///
|
||||
static MStatus executeCommand( const MString& command,
|
||||
int& result,
|
||||
bool displayEnabled = false,
|
||||
bool undoEnabled = false );
|
||||
///
|
||||
static MStatus executeCommand( const MString& command,
|
||||
MIntArray& result,
|
||||
bool displayEnabled = false,
|
||||
bool undoEnabled = false );
|
||||
///
|
||||
static MStatus executeCommand( const MString& command,
|
||||
double& result,
|
||||
bool displayEnabled = false,
|
||||
bool undoEnabled = false );
|
||||
///
|
||||
static MStatus executeCommand( const MString& command,
|
||||
MDoubleArray& result,
|
||||
bool displayEnabled = false,
|
||||
bool undoEnabled = false );
|
||||
///
|
||||
static MStatus executeCommand( const MString& command,
|
||||
MString& result,
|
||||
bool displayEnabled = false,
|
||||
bool undoEnabled = false );
|
||||
///
|
||||
static MStatus executeCommand( const MString& command,
|
||||
MStringArray& result,
|
||||
bool displayEnabled = false,
|
||||
bool undoEnabled = false );
|
||||
|
||||
///
|
||||
static MStatus addToModel( MObject & object,
|
||||
MObject & parent = MObject::kNullObj );
|
||||
///
|
||||
static MStatus addToModelAt( MObject&, const MVector& point,
|
||||
const double scale[3] = NULL,
|
||||
const double rotation[3] = NULL,
|
||||
MTransformationMatrix::RotationOrder order =
|
||||
MTransformationMatrix::kXYZ );
|
||||
///
|
||||
static MStatus removeFromModel( MObject& );
|
||||
///
|
||||
static MStatus deleteNode( MObject& );
|
||||
///
|
||||
static MStatus setYAxisUp( bool rotateView = false );
|
||||
///
|
||||
static MStatus setZAxisUp( bool rotateView = false );
|
||||
///
|
||||
static bool isYAxisUp( MStatus* = NULL );
|
||||
///
|
||||
static bool isZAxisUp( MStatus* = NULL );
|
||||
///
|
||||
static MVector upAxis( MStatus* = NULL );
|
||||
|
||||
///
|
||||
static void displayInfo( const MString & theMessage );
|
||||
///
|
||||
static void displayWarning( const MString & theWarning );
|
||||
///
|
||||
static void displayError( const MString & theError );
|
||||
|
||||
// Support for DEBUG/NDEBUG API
|
||||
//
|
||||
///
|
||||
static MString defaultErrorLogPathName( MStatus* ReturnStatus = NULL );
|
||||
///
|
||||
static MStatus resetToDefaultErrorLogPathName();
|
||||
///
|
||||
static MStatus setErrorLogPathName( const MString& logPathName );
|
||||
///
|
||||
static MString errorLogPathName( MStatus* ReturnStatus = NULL );
|
||||
///
|
||||
static MStatus startErrorLogging();
|
||||
///
|
||||
static MStatus startErrorLogging( const MString& logPathName );
|
||||
///
|
||||
static bool errorLoggingIsOn( MStatus* ReturnStatus = NULL );
|
||||
///
|
||||
static MStatus stopErrorLogging();
|
||||
///
|
||||
static MStatus closeErrorLog();
|
||||
///
|
||||
static MStatus doErrorLogEntry( const MString& errorLogEntry );
|
||||
///
|
||||
static bool isUndoing();
|
||||
///
|
||||
static bool isRedoing();
|
||||
|
||||
protected:
|
||||
static const char* className();
|
||||
private:
|
||||
~MGlobal();
|
||||
#ifdef __GNUC__
|
||||
friend class shutUpAboutPrivateDestructors;
|
||||
#endif
|
||||
};
|
||||
|
||||
#ifdef _WIN32
|
||||
#pragma warning(default: 4522)
|
||||
#endif // _WIN32
|
||||
|
||||
// *****************************************************************************
|
||||
#endif /* __cplusplus */
|
||||
#endif /* _MGlobal */
|
||||
Reference in New Issue
Block a user