#pragma once
//-
// ===========================================================================
// Copyright 2018 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:    MFnPluginData
//
// ****************************************************************************

#include <maya/MFnData.h>

OPENMAYA_MAJOR_NAMESPACE_OPEN

// ****************************************************************************
// CLASS DECLARATION (MFnPluginData)

//! \ingroup OpenMaya MFn
//! \brief User defined data function set for dependency node data. 
/*!
  All user defined data that is to be passed between nodes in the dependency
  graph must be derived from MPxData.  The use of this class is closely
  linked to the use of MPxData, MFnPluginData, MDataHandle, and
  MTypeId.

  In order to use user defined data, one must first create an instance of the
  MTypeId class that is initialized with a unique id tag.  Then create a new
  class derived from MPxData to hold the user-defined data, As well as a
  helper class derived from MPxData that can create instances of the
  new derived type.

  For data of this type that needs to be passed into a plug, one would get an
  MDataHandle for the attribute that uses the type.  This would result in a
  call to the MPxData helper class that would create an instance of
  the type inside the MDataHandle.  The MDataHandle::data method can then be
  used to get an get an MObject for the user defined data and this should be
  used to initialize an instance of MFnPluginData.  Then the
  MFnPluginData::data method can be used to get an MPxData pointer, which can
  be safely cast to a pointer of the user defined type.  The data can be
  updated through this pointer, after which the MDataHandle::setClean method
  is used to complete the operation.

  To receive data of this type from a plug, an MDataHandle for the attribute
  that uses the new data type is created.  The MDataHandle::type method
  should be used to ascertain that it contains kPlugin data.  Then the
  MDataHandle::data method is used to get an MObject for the user defined
  data and this should be used to initialize an instance of MFnPluginData.
  The MFnPluginData::typeId method can be used to ascertain that the data is
  in fact of the user defined type.  Then the MFnPluginData::data method can
  be used to get an MPxData pointer, which can be safely cast to a pointer to
  the user defined type.
*/
class OPENMAYA_EXPORT MFnPluginData : public MFnData
{

	declareMFn(MFnPluginData, MFnData);

public:
	MTypeId			typeId( MStatus* ReturnStatus = NULL ) const;
	MPxData*		data( MStatus* ReturnStatus = NULL );
	const MPxData*	constData( MStatus* ReturnStatus = NULL ) const;
	MObject			create( const MTypeId& id, MStatus* ReturnStatus = NULL );

BEGIN_NO_SCRIPT_SUPPORT:

 	declareMFnConstConstructor( MFnPluginData, MFnData );

END_NO_SCRIPT_SUPPORT:

protected:
// No protected members

private:
// No private members
};

OPENMAYA_NAMESPACE_CLOSE