#pragma once
// ===========================================================================
// Copyright 2019 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================
//
// CLASS:    MArrayDataBuilder
//
// ****************************************************************************

#include <maya/MStatus.h>
#include <maya/MTypes.h>
#include <maya/MDeprecate.h>

OPENMAYA_MAJOR_NAMESPACE_OPEN

// ****************************************************************************
// CLASS DECLARATION (MArrayDataBuilder)

//! \ingroup OpenMaya
//! \brief Array builder for arrays in data blocks. 
/*!
  An MArrayDataBuilder is used to construct data for attributes/plugs that
  have an array of data.  An array builder is used with an MArrayDataHandle
  for managing data.
*/
class OPENMAYA_EXPORT MArrayDataBuilder
{

public:
	MArrayDataBuilder ( MDataBlock *, const MObject &attribute, unsigned int numElements, MStatus * ReturnStatus = NULL );

	MDataHandle      addLast        (MStatus * ReturnStatus = NULL);
	MDataHandle      addElement     ( unsigned int index, MStatus * ReturnStatus = NULL );
	MArrayDataHandle addLastArray   (MStatus * ReturnStatus = NULL );
	MArrayDataHandle addElementArray( unsigned int index, MStatus * ReturnStatus = NULL  );
	MStatus          removeElement  ( unsigned int index );
	unsigned int     elementCount   ( MStatus * ReturnStatus = NULL ) const;
	MStatus          growArray      ( unsigned int amount );
	MStatus          setGrowSize    ( unsigned int size );

    MArrayDataBuilder( const MArrayDataBuilder &other );
	MArrayDataBuilder& operator=( const MArrayDataBuilder& other );
    ~MArrayDataBuilder();

	static	const char*	className();

protected:
    // No protected members

OPENMAYA_PRIVATE:
    void constructClass(MDataBlock *, const MObject &attribute, unsigned int, MStatus * ReturnStatus = NULL );
	friend class MArrayDataHandle;
	MArrayDataBuilder();
	MArrayDataBuilder( void* );
	char data[40];
	bool fIsNull;

public:
	OPENMAYA_DEPRECATED(2019, "Use the other constructor instead.")
	MArrayDataBuilder ( const MObject & attribute, unsigned int numElements, MStatus * ReturnStatus = NULL );
};

OPENMAYA_NAMESPACE_CLOSE