selection.h

Go to the documentation of this file.

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

UFE_NS_DEF {


class UFE_SDK_DECL Selection
{
public:

    typedef SceneItemList::const_iterator const_iterator;
    typedef SceneItemList::const_reverse_iterator const_reverse_iterator;

    Selection();
    
    Selection(const Selection&);

    virtual ~Selection();

    Selection& operator=(const Selection&);

    Selection(Selection&&);

    Selection& operator=(Selection&& rhs);

    std::size_t size() const;
    
    bool empty() const;
    
    bool append(const SceneItem::Ptr& item);

    bool remove(const SceneItem::Ptr& item);

    bool insert(const SceneItem::Ptr& position, const SceneItem::Ptr& item);

    void clear();

    void replaceWith(const Selection& selection);
    
    bool contains(const Path& path) const;

    bool containsDescendant(const Path& path) const;

    bool containsDescendantInclusive(const Path& path) const;

    bool containsAncestor(const Path& path) const;

    bool containsAncestorInclusive(const Path& path) const;

    SceneItem::Ptr closestCommonAncestor() const;

    SceneItem::Ptr next(const SceneItem::Ptr& item) const;

    const SceneItem::Ptr& front() const;
    const SceneItem::Ptr& back() const;

    const_iterator cbegin() const;
    const_iterator begin() const;
    const_iterator cend() const;
    const_iterator end() const;
    const_reverse_iterator crbegin() const;
    const_reverse_iterator rbegin() const;
    const_reverse_iterator crend() const;
    const_reverse_iterator rend() const;
protected:

    bool doAppend(const SceneItem::Ptr& item);
    bool doRemove(const SceneItem::Ptr& item);
    bool doInsert(const SceneItem::Ptr& position, const SceneItem::Ptr& item);
    void doClear();
    void doReplaceWith(const Selection& selection);

    // Hook methods for append, remove, insert, clear, and replaceWith.  
    // postAppend(), postRemove(), and postInsert() are only called if
    // doAppend(), doRemove(), and doInsert() return true, respectively.
    // Implementations in this class do nothing.
    virtual void postAppend(const SceneItem::Ptr& item);
    virtual void postRemove(const SceneItem::Ptr& item);
    virtual void postInsert(
        const SceneItem::Ptr& position, const SceneItem::Ptr& item
    );
    virtual void postClear();
    virtual void postReplaceWith();

    SelectionTrie&              trie();
    const SelectionTrie&        trie() const;

    inline SceneItemList&       list() { return fList; }

private:
    SceneItemList fList;

    void* fTrieStorage[2];
};

}

#endif /* _ufeSelection */