AbcImport/CreateSceneHelper.h

//-*****************************************************************************
//
// Copyright (c) 2009-2013,
//  Sony Pictures Imageworks, Inc. and
//  Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// *       Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// *       Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// *       Neither the name of Sony Pictures Imageworks, nor
// Industrial Light & Magic nor the names of their contributors may be used
// to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//-*****************************************************************************

#ifndef ABCIMPORT_CREATE_SCENE_H_
#define ABCIMPORT_CREATE_SCENE_H_

#include <maya/cxx17_enter_legacy_scope.hpp>
#include <Alembic/AbcGeom/ICamera.h>
#include <Alembic/AbcGeom/ICurves.h>
#include <Alembic/AbcGeom/IPoints.h>
#include <Alembic/AbcGeom/IPolyMesh.h>
#include <Alembic/AbcGeom/ISubD.h>
#include <Alembic/AbcGeom/IXform.h>
#include <maya/cxx17_exit_legacy_scope.hpp>

#include "NodeIteratorVisitorHelper.h"

#include <maya/MObject.h>
#include <maya/MString.h>
#include <maya/MDagPath.h>
#include <maya/MDataHandle.h>
#include <maya/MSelectionList.h>
#include <maya/MFnMesh.h>

#include <set>
#include <map>
#include <vector>

struct ltMObj
{
  bool operator()(const MObject & s1, const MObject & s2) const
  {
    return (&s1) < (&s2);
  }
};

class AlembicObject;
typedef Alembic::Util::shared_ptr<AlembicObject> AlembicObjectPtr;

class AlembicObject
{
public:
    AlembicObject(const Alembic::Abc::IObject& iObject) : mObject( iObject ) {}

    const   Alembic::Abc::IObject&  object() const { return mObject; }
            Alembic::Abc::IObject&  object()       { return mObject; }

    void    addChild(AlembicObjectPtr iChild)   { mChildren.push_back(iChild); }
    size_t  getNumChildren()                    { return mChildren.size(); }

    AlembicObjectPtr      getChild(size_t index){ return mChildren[index]; }
private:
    Alembic::Abc::IObject       mObject;
    std::vector<AlembicObjectPtr> mChildren;
};

class CreateSceneVisitor
{
public:

    enum Action
    {
        NONE = 0,
        CONNECT = 1,
        CREATE = 2,
        REMOVE = 3,
        CREATE_REMOVE = 4
    };

    CreateSceneVisitor(double iFrame = 0,
        bool iUnmarkedFaceVaryingColors = false,
        const MObject & iParent = MObject::kNullObj,
        Action iAction = CREATE, MString iRootNodes = MString(),
        MString iFilterString = MString(),
        MString iExcludeFilterString = MString());

    ~CreateSceneVisitor();

    // previsit the hierarchy and return a tree of selected nodes.
    AlembicObjectPtr previsit(AlembicObjectPtr iParentObj);

    // gets the ball rolling starting the hierarchy walk
    MStatus walk(Alembic::Abc::IArchive & iRoot);

    void visit(AlembicObjectPtr iAlembicObj);

    MStatus operator()(Alembic::AbcGeom::ICamera & iNode);
    MStatus operator()(Alembic::AbcGeom::ICurves & iNode);
    MStatus operator()(Alembic::AbcGeom::INuPatch & iNode);
    MStatus operator()(Alembic::AbcGeom::IPoints & iNode);
    MStatus operator()(Alembic::AbcGeom::IPolyMesh & iNode);
    MStatus operator()(Alembic::AbcGeom::ISubD & iNode);
    MStatus operator()(Alembic::AbcGeom::IXform & iNode,
                       AlembicObjectPtr iNodeObject);
    MStatus createEmptyObject(AlembicObjectPtr iNodeObject);

    bool hasSampledData();

    void getData(WriterData & oData);

    // re-add the shader selection back to the sets for meshes
    void applyShaderSelection();

    // add face sets after the connections are made
    void addFaceSetsAfterConnection();

private:

    // helper function for building mShaderMeshMap
    // Remembers what sets a mesh was part of, gets those sets as a selection
    // and then clears the sets for reassignment later
    // This is only used when -connect flag is set to hook up a AlembicNode
    // to a previous hierarchy
    void checkShaderSelection(MFnMesh & iMesh, unsigned int iInst);

    void addToPropList(std::size_t iFirst, MObject & iParent);

    // given one of the children of the root of the Alembic asset, find the
    // closest match to mRootNodes when appropriate
    std::string searchRootNames(const std::string & iName);

    double mFrame;
    MObject mParent;

    // member variable related to flags -connect,
    // -createIfNotFound and -removeIfNoUpdate
    std::set<std::string> mRootNodes;
    bool mAnyRoots;

    // used with one of the flags (tbd)
    // determines if C3fGeomParam and C4fGeomParam for MFnMeshes
    // without the appropriate metadata hint should be treated as a color
    // set (if true) or as an attribute on the node (if false)
    bool mUnmarkedFaceVaryingColors;

    MDagPath mConnectDagNode;

    Action mAction;

    WriterData  mData;

    // regular expression strings for filtering the input cache.
    MStringArray mOnlyPatterns;
    MStringArray mExceptPatterns;

    // special map of shaders to selection lists that have selections
    // of parts of meshes.  They are to get around a problem where a shape
    // wont shade correctly after a swap if it is shaded per face
    std::map < MObject, MSelectionList, ltMObj > mShaderMeshMap;

    // adding face sets after the connections are made. The order is
    // important to deal with construction history.
    std::map < MObject, Alembic::Abc::IObject, ltMObj > mAddFaceSetsMap;
};  // class CreateSceneVisitor


#endif  // ABCIMPORT_CREATE_SCENE_H_