notice.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_NOTICE_H
#define PXR_USD_USD_NOTICE_H

#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/common.h"
#include "pxr/usd/usd/object.h"

#include "pxr/usd/sdf/changeList.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/base/tf/notice.h"

PXR_NAMESPACE_OPEN_SCOPE


class UsdNotice {
public:

    class StageNotice : public TfNotice {
    public:
        USD_API
        StageNotice(const UsdStageWeakPtr &stage);
        USD_API
        virtual ~StageNotice();

        const UsdStageWeakPtr &GetStage() const { return _stage; }

    private:
        UsdStageWeakPtr _stage;
    };

    class StageContentsChanged : public StageNotice {
    public:
        explicit StageContentsChanged(const UsdStageWeakPtr& stage)
            : StageNotice(stage) {}
        USD_API virtual ~StageContentsChanged();
    };

    class ObjectsChanged : public StageNotice {
        using _PathsToChangesMap = 
            std::map<SdfPath, std::vector<const SdfChangeList::Entry*>>;

        friend class UsdStage;
        ObjectsChanged(const UsdStageWeakPtr &stage,
                       const _PathsToChangesMap *resyncChanges,
                       const _PathsToChangesMap *infoChanges)
            : StageNotice(stage)
            , _resyncChanges(resyncChanges)
            , _infoChanges(infoChanges) {}
    public:
        USD_API virtual ~ObjectsChanged();

        bool AffectedObject(const UsdObject &obj) const {
            return ResyncedObject(obj) || ChangedInfoOnly(obj);
        }

        USD_API bool ResyncedObject(const UsdObject &obj) const;

        USD_API bool ChangedInfoOnly(const UsdObject &obj) const;

        class PathRange
        {
        public:
            class iterator : public boost::iterator_adaptor<
                iterator,                           // crtp base,
                _PathsToChangesMap::const_iterator, // base iterator
                const SdfPath&                      // value type
            >
            {
            public:
                iterator() 
                    : iterator_adaptor_(base_type()) {}

                USD_API TfTokenVector GetChangedFields() const;

                USD_API bool HasChangedFields() const;

            private:
                friend class PathRange;
                friend class boost::iterator_core_access;

                iterator(base_type baseIter) 
                    : iterator_adaptor_(baseIter) {}
                inline reference dereference() const { 
                    return base()->first;
                }
            };

            using const_iterator = iterator;

            PathRange() : _changes(nullptr) { }

            explicit operator SdfPathVector() const {
                return SdfPathVector(begin(), end());
            }
        
            bool empty() const { 
                return !_changes || _changes->empty(); 
            }

            size_t size() const { 
                return _changes ? _changes->size() : 0; 
            }

            iterator begin() const { 
                return iterator(_changes->cbegin()); 
            }

            const_iterator cbegin() const { 
                return iterator(_changes->cbegin()); 
            }

            iterator end() const { 
                return iterator(_changes->cend()); 
            }

            const_iterator cend() const { 
                return iterator(_changes->cend()); 
            }

            const_iterator find(const SdfPath& path) const {
                return const_iterator(_changes->find(path));
            }

        private:
            friend class ObjectsChanged;
            explicit PathRange(const _PathsToChangesMap* changes)
                : _changes(changes)
            { }

            const _PathsToChangesMap* _changes;
        };

        USD_API PathRange GetResyncedPaths() const;

        USD_API PathRange GetChangedInfoOnlyPaths() const;

        USD_API TfTokenVector GetChangedFields(const UsdObject &obj) const;

        USD_API TfTokenVector GetChangedFields(const SdfPath &path) const;

        USD_API bool HasChangedFields(const UsdObject &obj) const;
        
        USD_API bool HasChangedFields(const SdfPath &path) const;

    private:
        const _PathsToChangesMap *_resyncChanges;
        const _PathsToChangesMap *_infoChanges;
    };

    class StageEditTargetChanged : public StageNotice {
    public:
        explicit StageEditTargetChanged(const UsdStageWeakPtr &stage)
            : StageNotice(stage) {}
        USD_API virtual ~StageEditTargetChanged();
    };

    class LayerMutingChanged : public StageNotice {
    public:
        explicit LayerMutingChanged(const UsdStageWeakPtr &stage, 
                const std::vector<std::string>& mutedLayers, 
                const std::vector<std::string>& unmutedLayers)
            : StageNotice(stage),
             _mutedLayers(mutedLayers),
             _unMutedLayers(unmutedLayers) {}

        USD_API virtual ~LayerMutingChanged();

        const std::vector<std::string>& GetMutedLayers() const {
            return _mutedLayers;
        }

        const std::vector<std::string>& GetUnmutedLayers() const {
            return _unMutedLayers;
        }

    private:
        const std::vector<std::string>& _mutedLayers;
        const std::vector<std::string>& _unMutedLayers;
    };

};


PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_USD_NOTICE_H