#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:    MDagPath
//
// ****************************************************************************
//
// CLASS DESCRIPTION (MDagPath)
//
//    The DAG Path Class provides methods for obtaining one or all Paths to a
//    specified DAG Node, determining if a Path is valid and if two Paths are
//    equivalent, obtaining the length, transform, and inclusive and exclusive
//    matrices of Path, as well as performing Path to Path assignment.
//
// ****************************************************************************

// ****************************************************************************
// INCLUDED HEADER FILES

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

OPENMAYA_MAJOR_NAMESPACE_OPEN

// ****************************************************************************
// DECLARATIONS
//
//! \ingroup OpenMaya
//! \brief A data structure to store the per path draw override information
/*!
    A simple draw override data structure.
    Draw override is per DAG path information. It checks starting from current
    object and upwards until an enabled draw override is found.
*/

// ****************************************************************************
class OPENMAYA_EXPORT MDAGDrawOverrideInfo{
public:
    /*!
        Draw override type
    */
    OPENMAYA_ENUM(DrawOverrideDisplayType,
        kDisplayTypeNormal,    //!< Display as normal
        kDisplayTypeReference, //!< Display as reference
        kDisplayTypeTemplate   //!< Display as templated(not selectable, only show as wireframe)
    );

    /*!
        Draw override LOD
    */
    OPENMAYA_ENUM(DrawOverrideLOD,
        kLODFull,             //!< Display all render items like shaded, wireframe as full detailed
        kLODBoundingBox       //!< Display only a bounding box, nothing else
    );

    MDAGDrawOverrideInfo():
        //! Draw override enabled or not
        fOverrideEnabled(false),
        //! Display type like normal, reference, templated
        fDisplayType(kDisplayTypeNormal),
        //! Level of detail like Full or bounding box
        fLOD(kLODFull),
        //! Whether allow to draw shaded item
        fEnableShading(true),
        //! Whether allow to draw textured item
        fEnableTexturing(true),
        //! Whether the whole geometry is visible
        fEnableVisible(true),
        //! Whether the object is visible during playback
        fPlaybackVisible(true)
        {}

public:
    bool fOverrideEnabled;
    DrawOverrideDisplayType fDisplayType;
    DrawOverrideLOD fLOD;
    bool    fEnableShading;
    bool    fEnableTexturing;
    bool    fEnableVisible;
    bool    fPlaybackVisible;
};


// ****************************************************************************
// CLASS DECLARATION (MDagPath)

//! \ingroup OpenMaya
//! \brief  DAG Path.
/*!
Provides methods for obtaining one or all Paths to a specified DAG Node,
determining if a Path is valid and if two Paths are equivalent, obtaining the
length, transform, and inclusive and exclusive matrices of a Path, as well as
performing Path to Path assignment.

DAG Paths may be used as parameters to some methods in the DAG Node Function
Set (MFnDagNode).

It is often useful to combine DAG Paths into DAG Path arrays
(MDagPathArray).

Use this DAG Path Class to obtain and query Paths to DAG Nodes.  A DAG path
is a path from the world node to a particular object in the DAG.

If a DAG object is instanced, then an MDagPath is required to identify a
particular instance.  DAG paths are also required when doing world space
transformations.

Use this class in conjunction with the DAG Iterator (MItDag), DAG Node
Function Set (MFnDagNode) and DAG Path Array class (MDagPathArray) to query and
edit the DAG.
*/
class OPENMAYA_EXPORT MDagPath
{

public:
    MDagPath();
    MDagPath( const MDagPath& src );
    virtual ~MDagPath();

    static MStatus getAllPathsTo ( const MObject & node, MDagPathArray & pathArray );
    static MStatus getAPathTo	 ( const MObject & node, MDagPath & path );
    OPENMAYA_AVAILABLE(2022)
    static MStatus matchTransform(const MDagPath & source,
                                  const MDagPath & target,
                                  const MDagPath & relative,
                                  MTransformationMatrix& transformationMatrix,
                                  bool preserveOffsetParentMatrix = true,
                                  bool preservePivot = true,
                                  bool preservePivotOffset = false);

    MStatus      getAllPathsBelow( MDagPathArray & pathArray );
    bool         hasFn			 ( MFn::Type type, MStatus * ReturnStatus = nullptr ) const;
    MFn::Type    apiType		 ( MStatus * ReturnStatus = nullptr ) const;

    bool         isValid		( MStatus * ReturnStatus = nullptr ) const;
    MObject      node			( MStatus * ReturnStatus = nullptr ) const;
    MObject      transform		( MStatus * ReturnStatus = nullptr ) const;
    unsigned int length			( MStatus * ReturnStatus = nullptr ) const;

    MStatus      extendToShape				();
    MStatus      extendToShapeDirectlyBelow	( unsigned int );
    MStatus      numberOfShapesDirectlyBelow( unsigned int& ) const;

    MStatus      push		( const MObject &child );
    MStatus      pop		( unsigned int num = 1 );
    unsigned int childCount	( MStatus * ReturnStatus = nullptr ) const;
    MObject      child		( unsigned int i, MStatus * ReturnStatus = nullptr ) const;

    MMatrix      inclusiveMatrix		( MStatus * ReturnStatus = nullptr ) const;
    MMatrix      exclusiveMatrix		( MStatus * ReturnStatus = nullptr ) const;
    MMatrix      inclusiveMatrixInverse	( MStatus * ReturnStatus = nullptr ) const;
    MMatrix      exclusiveMatrixInverse	( MStatus * ReturnStatus = nullptr ) const;

    MDagPath&    operator = 	( const MDagPath& src);
    bool         operator == 	( const MDagPath& src) const;
    MStatus      set			( const MDagPath& src);

    unsigned int pathCount		( MStatus * ReturnStatus = nullptr ) const;
    MStatus      getPath		( MDagPath & path, unsigned int i = 0 ) const;
    MString      fullPathName	( MStatus *ReturnStatus = nullptr ) const;
    MString      partialPathName( MStatus *ReturnStatus = nullptr ) const;

    bool         isInstanced	( MStatus *ReturnStatus = nullptr ) const;
    unsigned int instanceNumber	( MStatus *ReturnStatus = nullptr ) const;

    bool         isVisible		( MStatus *ReturnStatus = nullptr ) const;
    bool         isTemplated	( MStatus *ReturnStatus = nullptr ) const;

    MDAGDrawOverrideInfo getDrawOverrideInfo() const;

    unsigned int getDisplayStatus() const;

    static const char* className();

    OPENMAYA_DEPRECATED(2019, "The function signature was inconsistent with the rest of the API. Please use the other MDagPath::getAPathTo method instead.")
    static MDagPath getAPathTo( const MObject & node, MStatus * ReturnStatus = nullptr );

protected:
// No protected members

OPENMAYA_PRIVATE:

     void * data;
};

OPENMAYA_NAMESPACE_CLOSE