SelectionController.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Design
File: SelectionController
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/SelectionArea.h>
#include <NDEVR/SnapController.h>
#if NDEVR_VIEWPORT
namespace NDEVR
{
    enum SubSelectionMode
    {
          e_single_model
        , e_vertex_rectangle_selection
        , e_vertex_polygon_selection
        , e_no_selection
        , e_sub_selection_size
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief Allows user to select data in a DesignObjectLookup
    **/
    class NDEVR_DESIGN_API SelectionController : public SnapController
    {
    public:
        explicit SelectionController(DesignObjectLookup* manager);
        virtual ~SelectionController(){}
        virtual void begin() override;
        virtual void finish() override;
        virtual void cancel() override;
        bool isInvertedSelection() const;
        void setInvertedSelection(bool is_inside);
        void setSubSelectionMode(const SubSelectionMode& mode);
        uint04 addMask(const SelectionArea<3, fltp08>& mask);
        uint04 addCurrentAsMask();
        void setThemeCameraBackgroundColor(const RGBColor& color);//used if no default
        void updateCameraBackgrounds();
        void setCameraShowGrid(bool show_grid);
        void setCameraShowEnvironment(bool show_grid);
        void removeMask(uint04 mask_index);
        void highlightMask(uint04 mask_index);
        void clearMaskHighlight();
        
        const Buffer<SelectionArea<3, fltp08>>& masks() const;
        void setMaskEnabled(uint04 index, bool enabled);
        
        void updateSelectionInfo();
        SubSelectionMode subSelectionMode() const {return m_sub_selection_mode;}
        TranslatedString defaultHint(const TranslatedString& action_hint) const;
        String currentSelectionHint() const;
        virtual bool processMouseEvent(const MouseEvent& mouse_event, DesignObjectLookup* lookup, Camera* camera) override;
        virtual bool processKeyEvent(const KeyEvent& event, DesignObjectLookup* lookup, Camera* camera) override;
        //Returns true if the user has completed the selection
        bool selectionComplete() const {return m_selection_complete;}
        UUID currentSelection() const;
        void clear(bool clear_selection, bool clear_masks);
        void setHideMaskExclusion(bool is_hidden);
        bool darkensMaskExclusion() const { return m_darken_mask_exclusion; }
        void darkenMaskExclusion(bool darken);
 
        void setPreModelFilter(const std::function<bool(const Model&)>& pre_model_filter);//Prevents testing for selection, returns true if should test
        void setPreGeometryFilter(const std::function<bool(const Model&, const Geometry&)>& pre_geometry_filter);//Prevents testing for selection. returns true if should test
        void setSelectionFilter(const std::function<bool(const Model&)>& selection_filter);//Once a selection is made, filters the appropriate parent, returns true if selectable
        void setIsEditSelection(bool is_edit_selection);
    protected:
        void setSelectionMaskInfo(const SelectionInfo& info);
        void updateSelectionMask();
        void clearSelection();
        void clearMasks();
    protected:
        UUID m_current_selection;
        SelectionInfo m_selection_info;
        SelectionInfo m_selection_mask_info;//Used only to select mask objects
        SelectionInfo m_selection_highlight_info;//used to go back to old highlight
        SubSelectionMode m_sub_selection_mode;
        Buffer<UUID> m_last_mask_geometries;
        Buffer<UUID> m_last_selection_geometries;
        bool m_inverted_selection;
        bool m_temp_inverted;
        bool m_selection_complete;
        bool m_is_edit_selection;
        bool m_hide_mask_exclusion;
        bool m_darken_mask_exclusion;
        uint04 m_highlighted_mask;
    };
}
#endif