Initial commit

lib/mayasdk6/include/maya/MArgList.h

@@ -0,0 +1,178 @@
+
+#ifndef _MArgList
+#define _MArgList
+//
+//-
+// ==========================================================================
+// Copyright  (C)  Alias Systems,  a division  of  Silicon Graphics  Limited.
+// All rights  reserved.  These coded  instructions,  statements and computer
+// programs  contain  unpublished information  proprietary to  Alias Systems,
+// a  division  of  Silicon  Graphics  Limited,  which  is  protected by  the
+// Canadian  and  US federal copyright law and  may not be disclosed to third
+// parties or  copied  or  duplicated,  in  whole  or in part,  without prior
+// written  consent  of Alias Systems, a division of Silicon Graphics Limited
+// ==========================================================================
+//+
+//
+// CLASS:    MArgList
+//
+// *****************************************************************************
+//
+// CLASS DESCRIPTION (MArgList)
+//
+//  This class is used to create and retreive argument lists that can be
+//  passed to API class methods that require arglists.
+//
+// *****************************************************************************
+
+#if defined __cplusplus
+
+// *****************************************************************************
+
+// INCLUDED HEADER FILES
+
+
+
+#include <maya/MStatus.h>
+#include <maya/MTypes.h>
+#include <maya/MString.h>
+
+// *****************************************************************************
+
+// DECLARATIONS
+
+class MVector;
+class MPoint;
+class MString;
+class MVectorArray;
+class MPointArray;
+class MStringArray;
+class MMatrix;
+class MDoubleArray;
+class MIntArray;
+class MDistance;
+class MAngle;
+class MTime;
+
+// *****************************************************************************
+
+// CLASS DECLARATION (MArgList)
+
+/// Create and retreive argument lists.
+/**
+  Manipulate argument lists.
+*/
+#ifdef _WIN32
+#pragma warning(disable: 4522)
+#endif // _WIN32
+
+class OPENMAYA_EXPORT MArgList  
+{
+public:
+	///
+	static const unsigned kInvalidArgIndex;
+	///
+					MArgList();
+	///
+					MArgList( const MArgList& in );
+	///
+					~MArgList();
+	///
+	unsigned		length( MStatus* ReturnStatus= NULL ) const;
+	///
+	bool			asBool(		unsigned index, MStatus* ret=NULL ) const;
+	///
+	int				asInt(		unsigned index, MStatus* ret=NULL ) const;
+	///
+	double			asDouble(	unsigned index, MStatus* ret=NULL ) const;
+	///
+	MString			asString(	unsigned index, MStatus* ret=NULL ) const;
+	///
+	MDistance		asDistance(	unsigned index, MStatus* ret=NULL ) const;
+	///
+	MAngle			asAngle(	unsigned index, MStatus* ret=NULL ) const;
+	///
+	MTime			asTime(		unsigned index, MStatus* ret=NULL ) const;
+	///
+	MVector			asVector(	unsigned& indexReadAndUpdate,
+								unsigned numElements=3,
+								MStatus* ret=NULL ) const;
+	///
+	MPoint			asPoint(	unsigned& indexReadAndUpdate,
+							 unsigned numElements=3, MStatus* ret=NULL ) const;
+	///
+	MStatus			get( unsigned index, bool&	) const;
+	///
+	MStatus			get( unsigned index, int&		) const;
+	///
+	MStatus			get( unsigned index, double&	) const;
+	///
+	MStatus			get( unsigned index, MString&	) const;
+	///
+	MStatus			get( unsigned index, MDistance& ) const;
+	///
+	MStatus			get( unsigned index, MAngle& ) const;
+	///
+	MStatus			get( unsigned index, MTime& ) const;
+	///
+	MStatus			get( unsigned& indexReadAndUpdate, MVector&,
+						 unsigned numElements=3 ) const;
+	///
+	MStatus			get( unsigned& indexReadAndUpdate, MPoint&,
+						 unsigned numElements=3 ) const;
+	///
+	MStatus			get( unsigned& indexReadAndUpdate, MMatrix&	) const;
+	///
+	MStatus			get( unsigned& indexReadAndUpdate, MIntArray& ) const;
+	///
+	MStatus			get( unsigned& indexReadAndUpdate, MDoubleArray& ) const;
+	///
+	MStatus         get( unsigned& indexReadAndUpdate, MStringArray& ) const;
+	///
+	MArgList&		operator =( const MArgList& other );
+
+	// Argument list helper methods
+	///
+	unsigned		flagIndex (	const char *shortFlag,
+								const char *longFlag = NULL ) const;
+
+	// Command argument construction methods
+
+	///
+	MStatus			addArg( bool arg );
+	///
+	MStatus			addArg( int arg );
+	///
+	MStatus			addArg( double arg );
+	///
+	MStatus 		addArg( const MString & arg );
+	///
+	MStatus 		addArg( const MDistance & arg );
+	///
+	MStatus 		addArg( const MAngle & arg );
+	///
+	MStatus 		addArg( const MTime & arg );
+	///
+	MStatus			addArg( const MVector & arg );
+	///
+	MStatus			addArg( const MPoint & arg );
+
+
+protected:
+// No protected members
+
+private:
+	const char*		className() const;
+	MArgList ( const void*, unsigned offset );
+	const void*		fArgList;
+	unsigned		fOffset;
+	bool			fOwn;
+};
+
+#ifdef _WIN32
+#pragma warning(default: 4522)
+#endif // _WIN32
+
+// *****************************************************************************
+#endif /* __cplusplus */
+#endif /* _MArgList */