selectionNotification.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/selectionNotification.h"
#ifndef _ufeSelectionNotification
#define _ufeSelectionNotification
// ===========================================================================
// Copyright 2020 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 SelectionChanged: public Notification
{
public:
    enum OpType {Append, Remove, Insert, Clear, ReplaceWith, SelectionCompositeNotification};

    SelectionChanged(OpType opType);

    SelectionChanged(const SelectionChanged&) = default;
    
    ~SelectionChanged() override;

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


class UFE_SDK_DECL SelectionItemAppended: public SelectionChanged
{
public:

    SelectionItemAppended(const SceneItem::Ptr& item);
    
    SelectionItemAppended(const SelectionItemAppended&) = default;

    ~SelectionItemAppended() override;

    SceneItem::Ptr item() const;

private:
    SceneItem::Ptr fItem;
};


class UFE_SDK_DECL SelectionItemRemoved: public SelectionChanged
{
public:
    SelectionItemRemoved(const SceneItem::Ptr& item);
    
    SelectionItemRemoved(const SelectionItemRemoved&) = default;

    ~SelectionItemRemoved() override;

    SceneItem::Ptr item() const;

private:
    SceneItem::Ptr fItem;
};


class UFE_SDK_DECL SelectionItemInserted: public SelectionChanged
{
public:
    SelectionItemInserted(
        const SceneItem::Ptr& position,
        const SceneItem::Ptr& item
    );
    
    SelectionItemInserted(const SelectionItemInserted&) = default;

    ~SelectionItemInserted() override;

    SceneItem::Ptr item() const;

    SceneItem::Ptr position() const;

private:
    SceneItem::Ptr fPosition;
    SceneItem::Ptr fItem;
};


class UFE_SDK_DECL SelectionCleared: public SelectionChanged
{
public:
    SelectionCleared();
    
    SelectionCleared(const SelectionCleared&) = default;

    ~SelectionCleared() override;
};


class UFE_SDK_DECL SelectionReplaced: public SelectionChanged
{
public:

    SelectionReplaced();
    
    SelectionReplaced(const SelectionReplaced&) = default;

    ~SelectionReplaced() override;
};


class UFE_SDK_DECL SelectionCompositeNotification : public SelectionChanged
{
public:

    struct UFE_SDK_DECL Op {
        Op(OpType opTypeArg) : opType(opTypeArg) {}
        Op(OpType opTypeArg, const SceneItem::Ptr& itemArg)
            : opType(opTypeArg), item(itemArg) {}
        Op(OpType                opTypeArg, 
           const SceneItem::Ptr& positionArg,
           const SceneItem::Ptr& itemArg)
            : opType(opTypeArg), item(itemArg), position(positionArg) {}

        Op(const SelectionChanged&);

        OpType opType; 
        SceneItem::Ptr item{nullptr};
        SceneItem::Ptr position{nullptr};
    };

    typedef std::list<Op> Ops;

    SelectionCompositeNotification();

    SelectionCompositeNotification(const SelectionCompositeNotification&) = default;

    ~SelectionCompositeNotification() override;

    void appendAppendOp(const SceneItem::Ptr& item);

    void appendRemoveOp(const SceneItem::Ptr& item);

    void appendInsertOp(
        const SceneItem::Ptr& position,
        const SceneItem::Ptr& item
    );

    void appendClearOp();

    void appendReplaceWithOp();

    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 /* _ufeSelectionNotification */