tge/lib/mayasdk6/include/maya/MPlugArray.h
2017-04-17 06:17:10 -06:00

129 lines
3.6 KiB
C++
Executable File

#ifndef _MPlugArray
#define _MPlugArray
//
//-
// ==========================================================================
// Copyright (C) 1995 - 2005 Alias Systems Corp. and/or its licensors. All
// rights reserved.
//
// The coded instructions, statements, computer programs, and/or related
// material (collectively the "Data") in these files contain unpublished
// information proprietary to Alias Systems Corp. ("Alias") and/or its
// licensors, which is protected by Canadian and US federal copyright law and
// by international treaties.
//
// The Data may not be disclosed or distributed to third parties or be copied
// or duplicated, in whole or in part, without the prior written consent of
// Alias.
//
// THE DATA IS PROVIDED "AS IS". ALIAS HEREBY DISCLAIMS ALL WARRANTIES RELATING
// TO THE DATA, INCLUDING, WITHOUT LIMITATION, ANY AND ALL EXPRESS OR IMPLIED
// WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND/OR FITNESS FOR A
// PARTICULAR PURPOSE. IN NO EVENT SHALL ALIAS BE LIABLE FOR ANY DAMAGES
// WHATSOEVER, WHETHER DIRECT, INDIRECT, SPECIAL, OR PUNITIVE, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, OR IN EQUITY,
// ARISING OUT OF ACCESS TO, USE OF, OR RELIANCE UPON THE DATA.
// ==========================================================================
//+
//
// CLASS: MPlugArray
//
// *****************************************************************************
//
// CLASS DESCRIPTION (MPlugArray)
//
// This class implements an array of MPlugs. Common convenience functions
// are available, and the implementation is compatible with the internal
// Maya implementation so that it can be passed efficiently between plugins
// and internal maya data structures.
//
// *****************************************************************************
#if defined __cplusplus
// *****************************************************************************
// INCLUDED HEADER FILES
#include <maya/MTypes.h>
#include <maya/MStatus.h>
// *****************************************************************************
// DECLARATIONS
class MPlug;
// *****************************************************************************
// CLASS DECLARATION (MPlugArray)
/// Array of MPlugs data type
/**
Implement an array of MPlugs data type.
*/
#ifdef _WIN32
#pragma warning(disable: 4522)
#endif // _WIN32
class OPENMAYA_EXPORT MPlugArray
{
public:
///
MPlugArray();
///
MPlugArray( const MPlugArray& other );
///
MPlugArray( const MPlug src[], unsigned count );
///
~MPlugArray();
///
MPlug operator[]( unsigned index ) const;
///
MPlug operator[]( unsigned index );
///
MPlugArray& operator=( const MPlugArray & other );
///
MStatus set( const MPlug& element, unsigned index );
///
MStatus setLength( unsigned length );
///
unsigned length() const;
///
MStatus remove( unsigned index );
///
MStatus insert( const MPlug & element, unsigned index );
///
MStatus append( const MPlug & element );
///
MStatus clear();
///
MStatus get( MPlug dest[] ) const;
///
void setSizeIncrement ( unsigned newIncrement );
///
unsigned sizeIncrement () const;
protected:
// No protected members
private:
MPlugArray ( void * );
friend class MPlug;
void * arr;
bool own;
static const char* className();
};
#ifdef _WIN32
#pragma warning(default: 4522)
#endif // _WIN32
// *****************************************************************************
#endif /* __cplusplus */
#endif /* _MPlugArray */