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

139 lines
4.0 KiB
C++
Executable File

#ifndef _MStringArray
#define _MStringArray
//
//-
// ==========================================================================
// 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: MStringArray
//
// *****************************************************************************
//
// CLASS DESCRIPTION (MStringArray)
//
// This class implements an array of MStrings. 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 MString;
// *****************************************************************************
// CLASS DECLARATION (MStringArray)
/// Array of MStrings data type
/**
Implement an array of MStrings data type.
*/
#ifdef _WIN32
#pragma warning(disable: 4522)
#endif // _WIN32
class OPENMAYA_EXPORT MStringArray
{
public:
///
MStringArray();
///
MStringArray( const MStringArray& other );
///
MStringArray( const MString strings[], unsigned count );
///
MStringArray( const char* strings[], unsigned count );
///
MStringArray( unsigned initialSize,
const MString &initialValue );
///
~MStringArray();
///
MString operator[]( unsigned index ) const;
///
MString& operator[]( unsigned index );
///
MStringArray & operator=( const MStringArray & other );
///
MStatus set( const MString& element, unsigned index );
///
MStatus set( char* element, unsigned index );
///
MStatus setLength( unsigned length );
///
unsigned length() const;
///
MStatus remove( unsigned index );
///
MStatus insert( const MString & element, unsigned index );
///
MStatus append( const MString & element );
///
MStatus clear();
///
MStatus get( MString array[] ) const;
///
MStatus get( char* array[] ) const;
///
void setSizeIncrement ( unsigned newIncrement );
///
unsigned sizeIncrement () const;
///
friend OPENMAYA_EXPORT IOS_REF(ostream) &operator<<(IOS_REF(ostream) &os,
const MStringArray &array);
protected:
// No protected members
private:
MStringArray( void* );
void * arr;
bool own;
static const char* className();
};
#ifdef _WIN32
#pragma warning(default: 4522)
#endif // _WIN32
// *****************************************************************************
#endif /* __cplusplus */
#endif /* _MStringArray */