sceneNotification.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/sceneNotification.h"
#ifndef _ufeSceneNotification
#define _ufeSceneNotification
// ===========================================================================
// 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 "notification.h"
#include "sceneItem.h"

#include <list>
#include <bitset>

UFE_NS_DEF {


class UFE_SDK_DECL SceneChanged: public Notification
{
public:
    enum OpType : unsigned char {
        ObjectAdd,
        ObjectDelete,
        ObjectPathChange,
        SubtreeInvalidate,
        SceneCompositeNotification
    };

    using SubOpStorageType = unsigned char;
    constexpr static SubOpStorageType SubOpTypeNone = 0;

    SceneChanged(const SceneChanged&) = default;

    ~SceneChanged() override;

    virtual Path changedPath() const;

    OpType opType() const;

    virtual SubOpStorageType subOpType() const;

protected:
    SceneChanged(OpType opType);
private:
    const OpType fOpType;
};


class UFE_SDK_DECL ObjectAdd: public SceneChanged
{
public:
    ObjectAdd(const SceneItem::Ptr& item);

    ObjectAdd(const ObjectAdd&) = default;

    ~ObjectAdd() override;

    SceneItem::Ptr item() const;

    Path changedPath() const override;

private:
    const SceneItem::Ptr fItem;
};


class UFE_SDK_DECL ObjectDelete: public SceneChanged
{
public:
    enum SubOpType : SubOpStorageType {
        None = SubOpTypeNone,
        ObjectPostDelete,
        ObjectPreDelete,
        ObjectDestroyed
    };

    ObjectDelete(const Path& path);

    ObjectDelete(const ObjectDelete&) = default;

    ~ObjectDelete() override;

    Path path() const;

    Path changedPath() const override;

    SubOpStorageType subOpType() const override;

protected:
    ObjectDelete(const Path& path, SubOpType objectDeleteOpType);

private:
    const Path fPath;
    const SubOpType fSubOpType;
};


class UFE_SDK_DECL ObjectPostDelete: public ObjectDelete
{
public:
    ObjectPostDelete(const SceneItem::Ptr& item);

    ObjectPostDelete(const ObjectPostDelete&) = default;

    ~ObjectPostDelete() override;

    SceneItem::Ptr item() const;

private:
    const SceneItem::Ptr fItem;
};


class UFE_SDK_DECL ObjectPreDelete: public ObjectDelete
{
public:
    ObjectPreDelete(const SceneItem::Ptr& item);

    ObjectPreDelete(const ObjectPreDelete&) = default;

    ~ObjectPreDelete() override;

    SceneItem::Ptr item() const;

private:
    const SceneItem::Ptr fItem;
};


class UFE_SDK_DECL ObjectDestroyed: public ObjectDelete
{
public:
    ObjectDestroyed(const Path& path);

    ObjectDestroyed(const ObjectDestroyed&) = default;

    ~ObjectDestroyed() override;
};


class UFE_SDK_DECL ObjectPathChange: public SceneChanged
{
public:
    enum SubOpType : SubOpStorageType {
        None = SubOpTypeNone,
        ObjectRename,
        ObjectReparent,
        ObjectPathAdd,
        ObjectPathRemove
    };

    ObjectPathChange();

    ObjectPathChange(const ObjectPathChange&) = default;

    ~ObjectPathChange() override;

    SubOpStorageType subOpType() const override;

protected:
    ObjectPathChange(SubOpType objectPathChangeOpType);
    const SubOpType fSubOpType;
};


class UFE_SDK_DECL ObjectRename: public ObjectPathChange
{
public:
    ObjectRename(const SceneItem::Ptr& item, const Path& previousPath);

    ObjectRename(const ObjectRename&) = default;

    ~ObjectRename() override;

    SceneItem::Ptr item() const;

    Path previousPath() const;

    Path changedPath() const override;

private:
    const SceneItem::Ptr fItem;
    const Path           fPreviousPath;
};


class UFE_SDK_DECL ObjectReparent: public ObjectPathChange
{
public:
    ObjectReparent(const SceneItem::Ptr& item, const Path& previousPath);

    ObjectReparent(const ObjectReparent&) = default;

    ~ObjectReparent() override;

    SceneItem::Ptr item() const;

    Path previousPath() const;

    Path changedPath() const override;

private:
    const SceneItem::Ptr fItem;
    const Path           fPreviousPath;
};


class UFE_SDK_DECL ObjectPathAdd: public ObjectPathChange
{
public:
    ObjectPathAdd(const SceneItem::Ptr& item);

    ObjectPathAdd(const ObjectPathAdd&) = default;

    ~ObjectPathAdd() override;

    SceneItem::Ptr item() const;

    Path changedPath() const override;

private:
    const SceneItem::Ptr fItem;
};


class UFE_SDK_DECL ObjectPathRemove: public ObjectPathChange
{
public:
    ObjectPathRemove(const Path& removedPath);

    ObjectPathRemove(const ObjectPathRemove&) = default;

    ~ObjectPathRemove() override;

    Path removedPath() const;

    Path changedPath() const override;

private:
    const Path fRemovedPath;
};


class UFE_SDK_DECL SubtreeInvalidate : public SceneChanged
{
public:
    SubtreeInvalidate(const SceneItem::Ptr& item);

    SubtreeInvalidate(const SubtreeInvalidate&) = default;

    ~SubtreeInvalidate() override;

    SceneItem::Ptr root() const;

    Path changedPath() const override;

private:
    const SceneItem::Ptr fRoot;
};



class UFE_SDK_DECL SceneCompositeNotification : public SceneChanged
{
public:
    struct UFE_SDK_DECL Op {
        Op(OpType opTypeArg, SubOpStorageType subOpTypeArg)
          : opType(opTypeArg), subOpType(subOpTypeArg){}

        Op(OpType opTypeArg, const SceneItem::Ptr& itemArg)
          : opType(opTypeArg), item(itemArg), path(itemArg->path()) {}

        Op(OpType opTypeArg, SubOpStorageType subOpTypeArg, const SceneItem::Ptr& itemArg)
          : opType(opTypeArg), subOpType(subOpTypeArg), item(itemArg), path(itemArg->path()) {}

        Op(OpType opTypeArg, const Path& pathArg)
          : opType(opTypeArg), path(pathArg){}

        Op(OpType opTypeArg, SubOpStorageType subOpTypeArg, const Path& pathArg)
          : opType(opTypeArg), subOpType(subOpTypeArg), path(pathArg){}

        Op(OpType opTypeArg, SubOpStorageType subOpTypeArg, const SceneItem::Ptr& itemArg, const Path& pathArg)
            : opType(opTypeArg), subOpType(subOpTypeArg), item(itemArg), path(pathArg){}

        Op(const SceneChanged& sceneChanged);

        OpType opType;
        SubOpStorageType subOpType;
        SceneItem::Ptr item;
        Path path;
    };

    typedef std::list<Op> Ops;

    SceneCompositeNotification();

    SceneCompositeNotification(const SceneCompositeNotification&) = default;

    ~SceneCompositeNotification() override;

    Path changedPath() const override;

    void appendSceneChanged(const SceneChanged& sceneChanged);

    void appendOp(const Op& op);

    inline Ops opsList() const { return fOps; }

    std::size_t size() const;

    bool empty() const;

    Ops::const_iterator cbegin() const;
    Ops::const_iterator begin() const;
    Ops::const_iterator cend() const;
    Ops::const_iterator end() const;
    Ops::iterator       begin();
    Ops::iterator       end();

private:
    Ops fOps;
};

}

#endif /* _ufeSceneNotification */