GripsModel.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: GripsModel
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Model.h>
#if NDEVR_GRIPS
namespace NDEVR
{
    class ModelEditController;
    class SnapPoint;
    class DesignObjectLookup;
 
    /**--------------------------------------------------------------------------------------------------
    \brief A Model which contains points to adjust a target orientation, scale, or offset with the mouse.
    **/
    class NDEVR_DESIGN_API GripsModel : public Model
    {
    public:
        enum GripMode
        {
            e_no_grips
            , e_vertex_offset_grips
            , e_model_scale_grips
            , e_model_horizontal_offset_grips
            , e_model_vertical_offset_grips
            , e_model_rotate_grips
            , e_default_grips
        };
    public:
        GripsModel(const Model& model);
        bool processSelection(SelectionInfo& info) const;
        void processSnapPoint(SnapPoint& point, DesignObjectLookup* lookup, SelectionInfo& info) const;
#if NDEVR_VIEWPORT
        GripMode processGripSelection(const SnapPoint& point, const void* lock_ptr);
        GripMode processGripClicked(const SnapPoint& point, ModelEditController& controller, const void* lock_ptr);
#endif
        static UUID CursorID();
        static constexpr const char* TypeName() { return "grips_model"; }
        Model target() const;
        void attachTo(const Model& model);
        void detatch();
        void setToDefaultGrips(const void* lock = nullptr);
        void setToHighlight(const void* lock = nullptr);
        void setColor(const RGBColor& color, const void* lock = nullptr);
        Ray<3, fltp08> getIndexNormal(uint04 index);
        Ray<3, fltp08> getIndexTangent(uint04 index);
        static RGBColor GripColor(GripMode mode);
        BitFlag activeGripFlag() const;
        void setActiveGripFlag(BitFlag flag, const void* lock_ptr = nullptr);
    protected:
        
        void setupBoundsModel();
        void setupDiagonalExpandGrips();
        void setupExpandGrips();
        void setupRotationGrips();
        void setupOffsetGrips(bool horizontal);
        void setupVertexGrips();
        void hideAllGrips() const;
        void showGrip(uint04 index) const;
    protected:
        Model m_bounds_model;
        Model m_diagonal_expand_grips;
        Model m_expand_grips;
        Model m_rotation_grips;
        Model m_horizontal_offset_grips;
        Model m_vertical_offset_grips;
        Model m_vertex_grip;
        static const constexpr uint04 rotate_segs = 128;
    };
}
#endif