stagePopulationMask.h

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_USD_USD_STAGE_POPULATION_MASK_H
#define PXR_USD_USD_STAGE_POPULATION_MASK_H

#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/sdf/path.h"

#include <iosfwd>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE


class UsdStagePopulationMask
{
public:
    static UsdStagePopulationMask
    All() {
        return UsdStagePopulationMask().Add(SdfPath::AbsoluteRootPath());
    }

    UsdStagePopulationMask() = default;

    UsdStagePopulationMask(UsdStagePopulationMask const &) = default;
    UsdStagePopulationMask(UsdStagePopulationMask &&) = default;
    UsdStagePopulationMask &operator=(UsdStagePopulationMask const &) = default;
    UsdStagePopulationMask &operator=(UsdStagePopulationMask &&) = default;

    template <class Iter>
    explicit UsdStagePopulationMask(Iter f, Iter l) : _paths(f, l) {
        _ValidateAndNormalize();
    }

    explicit UsdStagePopulationMask(std::vector<SdfPath> const &paths) :
        UsdStagePopulationMask(std::vector<SdfPath>(paths)) {};

    USD_API
    explicit UsdStagePopulationMask(std::vector<SdfPath> &&paths);
    
    USD_API
    static UsdStagePopulationMask
    Union(UsdStagePopulationMask const &l, UsdStagePopulationMask const &r);

    USD_API
    UsdStagePopulationMask GetUnion(UsdStagePopulationMask const &other) const;

    USD_API
    UsdStagePopulationMask GetUnion(SdfPath const &path) const;
 
    USD_API
    static UsdStagePopulationMask
    Intersection(UsdStagePopulationMask const &l,
                 UsdStagePopulationMask const &r);

    USD_API
    UsdStagePopulationMask
    GetIntersection(UsdStagePopulationMask const &other) const;

    USD_API
    bool Includes(UsdStagePopulationMask const &other) const;
    
    USD_API
    bool Includes(SdfPath const &path) const;

    USD_API
    bool IncludesSubtree(SdfPath const &path) const;

    bool IsEmpty() const {
        return _paths.empty();
    }

    USD_API
    bool GetIncludedChildNames(SdfPath const &path, 
                               std::vector<TfToken> *childNames) const;

    USD_API
    std::vector<SdfPath> GetPaths() const;

    UsdStagePopulationMask &Add(UsdStagePopulationMask const &other) {
        *this = GetUnion(other);
        return *this;
    }
        
    UsdStagePopulationMask &Add(SdfPath const &path) {
        *this = GetUnion(path);
        return *this;
    }

    bool operator==(UsdStagePopulationMask const &other) const {
        return _paths == other._paths;
    }

    bool operator!=(UsdStagePopulationMask const &other) const {
        return !(*this == other);
    }

    void swap(UsdStagePopulationMask &other) {
        _paths.swap(other._paths);
    }

private:
    friend USD_API size_t hash_value(UsdStagePopulationMask const &);

    USD_API void _ValidateAndNormalize();
    
    std::vector<SdfPath> _paths;
};

USD_API
std::ostream &operator<<(std::ostream &, UsdStagePopulationMask const &);

inline void swap(UsdStagePopulationMask &l, UsdStagePopulationMask &r)
{
    l.swap(r);
}

USD_API
size_t hash_value(UsdStagePopulationMask const &);

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_USD_STAGE_POPULATION_MASK_H