HUSD_EditLayers.h

Go to the documentation of this file.

/*
 * Copyright 2019 Side Effects Software Inc.
 *
 * 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.
 *
 */

#ifndef __HUSD_EditLayers_h__
#define __HUSD_EditLayers_h__

#include "HUSD_API.h"
#include "HUSD_DataHandle.h"
#include "HUSD_LayerOffset.h"
#include <GU/GU_DetailHandle.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_StringMap.h>

class HUSD_API HUSD_EditLayers
{
public:
                         HUSD_EditLayers(HUSD_AutoWriteLock &lock);
                        ~HUSD_EditLayers();

    // Controls whether this object should edit the layers on the root layer
    // of the stage, or edit the sublayers on the active layer.
    void                 setEditRootLayer(bool edit_root_layer)
                         { myEditRootLayer = edit_root_layer; }
    bool                 editRootLayer() const
                         { return myEditRootLayer; }

    // Controls the position where new layers should be added. A value of
    // zero indicates the strongest layer position, and -1 indicates the
    // weakest layer position.
    void                 setAddLayerPosition(int position)
                         { myAddLayerPosition = position; }
    int                  addLayerPosition() const
                         { return myAddLayerPosition; }

    // Determines if the stage root layer's root prim metadata should be copied
    // from the first new sublayer in an addLayers call.
    void                 setCopyRootPrimMetadataToStage(bool copymetadata)
                         { myCopyRootPrimMetadataToStage = copymetadata; }
    bool                 copyRootPrimMetadataToStage() const
                         { return myCopyRootPrimMetadataToStage; }

    bool                 removeLayers(const UT_StringArray &filepaths) const;
    bool                 addLayers(const UT_StringArray &filepaths,
                                const UT_Array<HUSD_LayerOffset>&offsets,
                                const UT_Array<UT_StringMap<UT_StringHolder>>&refargs =
                                    UT_Array<UT_StringMap<UT_StringHolder>>(),
                                const UT_Array<GU_DetailHandle>&gdhs =
                                    UT_Array<GU_DetailHandle>()) const;
    bool                 addLayer(const UT_StringRef &filepath,
                                const HUSD_LayerOffset &offset =
                                    HUSD_LayerOffset(),
                                const UT_StringMap<UT_StringHolder> &refargs =
                                    UT_StringMap<UT_StringHolder>(),
                                const GU_DetailHandle &gdh =
                                    GU_DetailHandle()) const;
    bool                 addLayerForEdit(const UT_StringRef &filepath,
                                const UT_StringMap<UT_StringHolder> &refargs =
                                    UT_StringMap<UT_StringHolder>(),
                                const GU_DetailHandle &gdh =
                                    GU_DetailHandle()) const;
    bool                 addLayerFromSource(const UT_StringRef &usdsource,
                                bool allow_editing) const;
    bool                 addLayer() const;
    bool                 applyLayerBreak() const;

private:
    HUSD_AutoWriteLock  &myWriteLock;
    int                  myAddLayerPosition;
    bool                 myEditRootLayer;
    bool                 myCopyRootPrimMetadataToStage;
};

#endif