LayerCommands.h

//
// Copyright 2017 Animal Logic
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.//
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#pragma once

#include "../Api.h"

#include "AL/usdmaya/ForwardDeclares.h"
#include "AL/maya/utils/Api.h"
#include "AL/maya/utils/MayaHelperMacros.h"
#include "maya/MDGModifier.h"
#include "maya/MObject.h"
#include "maya/MPxCommand.h"

#include "pxr/pxr.h"
#include "pxr/usd/usd/stage.h"
#include <functional>

namespace AL {
namespace usdmaya {
namespace cmds {

//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------
class LayerCommandBase
  : public MPxCommand
{
public:

  static MSyntax setUpCommonSyntax();

  nodes::ProxyShape* getShapeNode(const MArgDatabase& args);

  UsdStageRefPtr getShapeNodeStage(const MArgDatabase& args);

  MArgDatabase makeDatabase(const MArgList& args);

//  /// \brief  hunt for the first node of the specified type found in the selection list object args
//  /// \param  args the pre-parsed argument data base
//  /// \param  typeId the typeId of the object type that may appear as one of the selected objects
//  /// \return the MObject of the node if found
//  MObject getSelectedNode(const MArgDatabase& args, const MTypeId typeId);
};

//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------
class LayerGetLayers
  : public LayerCommandBase
{
public:
  AL_MAYA_DECLARE_COMMAND();
private:
  bool isUndoable() const override;
  MStatus doIt(const MArgList& args) override;
};

//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------

class LayerCreateLayer
  : public LayerCommandBase
{
  UsdStageRefPtr m_stage;
  SdfLayerHandle m_rootLayer;
  SdfLayerRefPtr m_newLayer;
  MString m_filePath;
  nodes::ProxyShape* m_shape;
  bool m_addSublayer = false;
  bool m_layerWasInserted;

public:
  AL_MAYA_DECLARE_COMMAND();
private:
  bool isUndoable() const override;
  MStatus undoIt() override;
  MStatus redoIt() override;
  MStatus doIt(const MArgList& args) override;
};

//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------
class LayerSave
  : public LayerCommandBase
{
public:
  AL_MAYA_DECLARE_COMMAND();
private:
  bool isUndoable() const override;
  MStatus doIt(const MArgList& args) override;
};

//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------
class LayerExport
  : public LayerCommandBase
{
public:
  AL_MAYA_DECLARE_COMMAND();
private:
  bool isUndoable() const override;
  MStatus doIt(const MArgList& args) override;
};

//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------
class LayerCurrentEditTarget
  : public LayerCommandBase
{
  LayerCurrentEditTarget() {}
  UsdEditTarget previous;
  UsdEditTarget next;
  UsdStageRefPtr stage;
  bool isQuery;
  bool previouslyAnEditTarget;
  std::function<std::string(SdfLayerHandle)> getLayerId;

public:
  AL_MAYA_DECLARE_COMMAND();
private:
  bool isUndoable() const override;
  MStatus doIt(const MArgList& args) override;
  MStatus undoIt() override;
  MStatus redoIt() override;
  PcpNodeRef determineEditTargetMapping(UsdStageRefPtr stage, const MArgDatabase& args, SdfLayerHandle editTargetLayer) const;
};

//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------
class LayerSetMuted
  : public LayerCommandBase
{
  SdfLayerHandle m_layer;
  bool m_muted;
public:
  AL_MAYA_DECLARE_COMMAND();
private:
  bool isUndoable() const override;
  MStatus doIt(const MArgList& args) override;
  MStatus undoIt() override;
  MStatus redoIt() override;
};

//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------
class LayerManager
  : public LayerCommandBase
{
public:
  AL_MAYA_DECLARE_COMMAND();
private:
  bool isUndoable() const override;
  MStatus doIt(const MArgList& args) override;
  MStatus captureLayerContents(const MString& id, MStringArray& results);
};



AL_USDMAYA_PUBLIC
void constructLayerCommandGuis();

//----------------------------------------------------------------------------------------------------------------------
} // cmds
} // usdmaya
} // AL
//----------------------------------------------------------------------------------------------------------------------