HUSD_Prune.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_Prune_h__
#define __HUSD_Prune_h__

#include "HUSD_API.h"
#include "HUSD_DataHandle.h"
#include "HUSD_Path.h"
#include "HUSD_PathSet.h"
#include "HUSD_Utils.h"
#include <UT/UT_StringArray.h>
#include <UT/UT_StringMap.h>
#include <SYS/SYS_Types.h>

class HUSD_FindPrims;
class HUSD_TimeCode;
template <typename T> class UT_Array;

class HUSD_API HUSD_Prune
{
public:
                         HUSD_Prune(HUSD_AutoWriteLock &dest);
                        ~HUSD_Prune();

    enum PruneMethod
    {
        Deactivate,
        MakeInvisible
    };

    static bool          calculatePruneSet(const HUSD_FindPrims &findprims,
                                const HUSD_FindPrims *excludeprims,
                                const HUSD_FindPrims *limitpruneprims,
                                bool prune_unselected,
                                HUSD_PathSet &paths);

    bool                 pruneCalculatedSet(HUSD_PathSet &paths,
                                const HUSD_TimeCode &timecode,
                                HUSD_Prune::PruneMethod prune_method,
                                bool prune,
                                bool prune_ancestors_automatically,
                                bool prune_point_instances_separately,
                                UT_StringArray *pruned_prims) const;

    bool                 prunePointInstances(
                                const UT_StringMap<UT_Array<int64>> &ptinstmap,
                                const HUSD_TimeCode &timecode,
                                const UT_StringMap<bool> &pruneprimmap,
                                bool prune_unselected) const;

    bool                 getIsTimeVarying() const;

    void                 setCreateMissingPrimsAsOvers(bool create);

    bool                 getCreateMissingPrimsAsOvers() const;

private:
    HUSD_AutoWriteLock          &myWriteLock;
    bool                         myCreateMissingPrimsAsOvers;
    mutable HUSD_TimeSampling    myTimeSampling;
};

#endif