StationModel.h

/*--------------------------------------------------------------------------------------------
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: StationModel
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Model.h>
#if NDEVR_STATION_MODEL
namespace NDEVR
{
    class Text;
    class TextConstructor;
    class DesignObjectLookup;
    class NDEVR_DESIGN_API StationModel : public Model
    {
    public:
        enum StationLayout
        {
            e_line    
            , e_spiral  
            , e_block   
        };
        enum OrientationMode
        {
            e_none       
            , e_angle      
            , e_back_point 
            , e_two_point  
        };
    public:
        StationModel();
        explicit StationModel(const Model& model, const void* lock = nullptr);
        void hideGrid() {};
        void setLocation(const Vector<3, fltp08>& location);
        Vertex<3, fltp08> getLocation() const;
        bool isRectangular() const;
        bool isCircular() const;
        void setRectangular(bool rectangular, const void* lock = nullptr);
        void setPreferredSegmentDistance(fltp08 distance);
        void setCircular(bool circular, const void* lock = nullptr);
        void updateStation(const void* lock_ptr = nullptr);
        void updateStation(DesignObjectLookup* lookup);
        void setFont(const Font& font);
        fltp08 preferredSegmentDistance() const;
        fltp08 stationRadius() const;
        Model stationLayer() const;
        bool areAxisLabelsVisible() const;
        bool areDistanceLabelsVisible() const;
        bool isDistanceLineworkVisible() const;
        bool isAxesLineworkVisible() const;

        void setTextFaceCamera(bool face_camera);
        static TranslatedString DefaultStationName(uint04 station_number);
        static StationModel CreateDefault(Model target, DesignObjectLookup* lookup);
        static StationModel CreateDefault(Model target);
        static StationModel CreateDefault(Model target, const Buffer<Model>& other_stations);
        static Vertex<3, fltp08> CalculateDefaultLocation(const StationModel& new_station, const Buffer<Model>& other_stations, StationLayout layout = StationLayout::e_spiral, Vector<3, fltp08> starting_offset = DefaultStationLocation());
        static Vertex<3, fltp08> DefaultStationLocation();
        void ensureModelFormat();
        Model stationVisuals() const;
        Text stationTitle() const;
        Model circles() const;
        Model distanceText() const;
        Model boldCircles() const;
        Model axis() const;
        Model azimuthModel();
        Text text0Degree();
        Text text90Degree();
        Text text180Degree();
        Text text270Degree();
        const Text text0Degree() const;
        const Text text90Degree() const;
        const Text text180Degree() const;
        const Text text270Degree() const;
        Model rectangleRoot() const;
        void invalidateVisuals(const void* lock = nullptr);
        void invalidateFont(const void* lock = nullptr);
        static constexpr StringView TypeName() { return StringView("station"); }
        Model getRow() const;
        Model getPattern() const;
        uint04 getRowNumber() const;
        uint04 getHoleNumber() const;
        void setRowNumber(uint04 number);
        void setHoleNumber(uint04 number);
        void setAllowHeadingAdjustment(bool allow);
        bool allowHeadingAdjustment() const;
        void setAllowPlannedDeployment(bool allow);
        bool allowPlannedDeployment() const;
        void setAllowRelativePosition(bool allow);
        bool allowRelativePositionAdjustment() const;
    private:
        void setupRectangular();
        void setupCircular();
        void setDistanceTextVisible(bool visible, const void* lock = nullptr);
        void setTitleVisible(bool visible, const void* lock = nullptr);
        void setAxesLabelsVisible(bool visible, const void* lock = nullptr);
        void setDistanceLineworkVisible(bool visible, const void* lock = nullptr);
        void setAxesLineworkVisible(bool visible, const void* lock = nullptr);
        bool shouldShowTitle(bool is_selected) const;
        bool shouldShowDistanceText(bool is_selected) const;
        bool shouldShowDistanceLinework(bool is_selected) const;
        bool shouldShowAxes(bool is_selected) const;
        bool shouldShowAxesText(bool is_selected) const;
        void updateVisualModels(bool is_selected, bool coord_space_changed, const Bounds<3, fltp08>& bounds, fltp08 station_radius, const void* lock_ptr);
        void initializeStation();
        void setupStationVisuals();
        void updateTitle(const void* lock_ptr);
        void updateAxisText();
        void setupAxis();
        uint04 circleGeoIndex() const;
        void setupAzimuthModel();
        void updateAllDistanceText(fltp08 station_radius, fltp08 epsilon, fltp08 text_size, bool force, bool selected);
        void updateRings(fltp08 station_radius, fltp08 epsilon);
        void updateRing(uint04 normal_index, fltp08 distance);
        void updateBoldRing(uint04 bold_index, fltp08 distance);
        void updateDistanceText(uint04 text_index, fltp08 distance, fltp08 bold_scale, bool make_bold, bool force);
    private:
        mutable uint04 m_circle_geometry_index;     
        mutable fltp08 m_preferred_segment_distance; 
 
    };
}
#endif