MeasurementModels.h

Go to the documentation of this file.

#pragma once
#include <NDEVR/Model.h>
#if NDEVR_MEASURE_MODELS
namespace NDEVR
{
    class Text;
    /**--------------------------------------------------------------------------------------------------
    \brief Potential decorations that can be used together to represent a point in 3D space 
    **/
    enum MeasurePointType
    {
          e_label
        , e_leader
        , e_90_crosshair
        , e_45_crosshair
        , e_square
        , e_circle
        , e_arrow
        , e_measure_point_size
    };
    /**--------------------------------------------------------------------------------------------------
    \brief The default layer for all Measurement Models
    **/
    NDEVR_DESIGN_API Model MeasurementLayer(Scene& scene);
    /**--------------------------------------------------------------------------------------------------
    \brief Typename for a container of Measurement
    **/
    static constexpr const char* MeasureGroupTypeName() { return "measurement_group"; }
 
    /**--------------------------------------------------------------------------------------------------
    \brief A Model which represents the measurement of a single point
    **/
    class NDEVR_DESIGN_API PointMeasureModel : public Model
    {
    public:
        PointMeasureModel();
        PointMeasureModel(const Model& model);
        Model pointMeasurementLayer();
        void setupDecoration();
        static constexpr const char* TypeName() { return "point_measurement"; }
        static constexpr const char* SubTypeName() { return "sub_point_measurement"; }
        static constexpr const char* DecorationTypeName() { return "point_measurement_decoration"; }
        void setPoint(const Vertex<3, fltp08>& location);
        void setPoint(const Vertex<3, fltp08>& location, const Vertex<3, fltp08>& leader);
        void setPointAndDirection(const Vertex<3, fltp08>& location, const Ray<3, fltp08>& direction);
        void setLabel(const TranslatedString& label);
        void setLabel(const String& label);
        void setFont(const Font& font);
        void setPointTypes(BitFlag pt_types);
        void setMarkerScale(fltp08 scale);
        void updateGeometry();
        Vertex<3, fltp08> measurementPoint() const;
    protected:
        void setupGeometry(MeasurePointType pt_type);
        void setup90Crosshairs(Geometry geo);
        void setup45Crosshairs(Geometry geo);
        void setupSquare(Geometry geo);
        void setupCircle(Geometry geo);
        void setupArrow(Geometry geo);
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief A Model which represents the measurement of 2 points, and potentially the distance between them.
    **/
    class NDEVR_DESIGN_API DistanceMeasureModel : public Model
    {
    public:
        DistanceMeasureModel();
        DistanceMeasureModel(const Model& model);
        void setPointTypes(BitFlag pt_types);
        void setMarkerScale(fltp08 thickness);
        static constexpr const char* TypeName() { return "distance_measurement"; }
        static constexpr const char* DecorationTypeName() { return "distance_measurement_decoration"; }
        void setEndpoints(const Vertex<3, fltp08>& p1, const Vertex<3, fltp08>& p2, const Vertex<3, fltp08>& leader = Constant<Vertex<3, fltp08>>::Invalid);
        void setLabel(const TranslatedString& label);
        void setFont(const Font& font);
        void updateGeometry();
        void setupDecoration();
        Model distanceMeasurementLayer();
        Text labelModel() const;
        LineSegment<3, fltp08> measurementLine() const;
    protected:
        Model decoration() const;
        PointMeasureModel endPoint(uint04 endpoint_number) const;
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief A Model which represents a measured angle.
    **/
    class NDEVR_DESIGN_API AngleMeasureModel : public Model
    {
    public:
        AngleMeasureModel();
        AngleMeasureModel(const Model& model);
 
        static constexpr const char* TypeName() { return "angle_measurement"; }
        static constexpr const char* DecorationTypeName() { return "angle_measurement_decoration"; }
        void setPoints(Vertex<3, fltp08> start, Vertex<3, fltp08> middle, Vertex<3, fltp08> end, Vertex<3, fltp08> perspective);
        void setLabel(const TranslatedString& label);
        void setFixedClockwise(bool clockwise);
        void clearFixedClockwise();
        Angle<fltp08> measurementAngle() const;
        bool isClockwise() const;
    protected:
        Model decoration();
        void init();
        void updateGeometry();
 
    };
}
#endif