pathSubject.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/pathSubject.h"
#ifndef _ufePathSubject
#define _ufePathSubject
// ===========================================================================
// Copyright 2018 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================

#include "common/ufeExport.h"

#include "subject.h"
#include "sceneItem.h"
#include "path.h"

#include <memory>
#include <vector>
#include <functional>

UFE_NS_DEF {

class Notification;


class UFE_SDK_DECL PathSubject : public Subject
{
public:
    typedef std::shared_ptr<PathSubject> Ptr;

    // Prevent the re-definition of the private helper methods from hiding
    // the public methods on Subject that we want to remain callable.
    using Subject::addObserver;
    using Subject::removeObserver;

    using AddObserverFcn = std::function<bool(const SceneItem::Ptr& item, const Observer::Ptr& obs)>;

    using RemoveObserverFcn = std::function<bool(const Path& Path, const Observer::Ptr& obs)>;

    ~PathSubject() override;

    PathSubject(const Path& path, AddObserverFcn addObserverFcn, RemoveObserverFcn removeObserverFcn);

private:
    // Use for scene changes
    void addObserver(const Path& path);
    void removeObserver(const Path& path);
    void addObservers(const Path& path, const Path& endAncestor);
    void removeObservers(const Path& path, const Path& endAncestor);

    template<bool ADD_OBSERVER>
    void addRemoveObserverHelper(const Path& path);

    template<bool ADD_OBSERVER>
    void addRemoveObserversHelper(Path path, const Path& endAncestor);

    void reparent(const Path& oldPath, const Path& newPath);
    void rename(const Path& oldPath, const Path& newPath);
    void objectDelete(const Path& path);

    class SceneChangedObserver;

    Path _path;
    const AddObserverFcn _addObserverFcn;
    const RemoveObserverFcn _removeObserverFcn;
    const Observer::Ptr _forwardingObserver;
    const Observer::Ptr _sceneChangedObserver;
    bool _attached;
};

}

#endif /* _ufePathSubject */