MRDistanceMeasurementObject.h

Go to the documentation of this file.

#pragma once
 
#include "MRMesh/MRMeasurementObject.h"
#include "MRMesh/MRObjectComparableWithReference.h"
 
namespace MR
{
 

class MRMESH_CLASS DistanceMeasurementObject : public MeasurementObject, public ObjectComparableWithReference
{
public:
    DistanceMeasurementObject() {}
 
    DistanceMeasurementObject( DistanceMeasurementObject&& ) noexcept = default;
    DistanceMeasurementObject& operator=( DistanceMeasurementObject&& ) noexcept = default;
 
    constexpr static const char* StaticTypeName() noexcept { return "DistanceMeasurementObject"; }
    const char* typeName() const override { return StaticTypeName(); }
 
    constexpr static const char* StaticClassName() noexcept { return "Distance"; }
    virtual std::string className() const override { return StaticClassName(); }
 
    constexpr static const char* StaticClassNameInPlural() noexcept { return "Distances"; }
    virtual std::string classNameInPlural() const override { return StaticClassNameInPlural(); }

    DistanceMeasurementObject( ProtectedStruct, const DistanceMeasurementObject& obj ) : DistanceMeasurementObject( obj ) {}
 
    MRMESH_API std::shared_ptr<Object> clone() const override;
    MRMESH_API std::shared_ptr<Object> shallowClone() const override;

    [[nodiscard]] MRMESH_API Vector3f getWorldPoint() const;
    [[nodiscard]] MRMESH_API Vector3f getLocalPoint() const;

    [[nodiscard]] MRMESH_API Vector3f getWorldDelta() const;
    [[nodiscard]] MRMESH_API Vector3f getLocalDelta() const;

    MRMESH_API virtual void setLocalPoint( const MR::Vector3f& point );
    MRMESH_API virtual void setLocalDelta( const MR::Vector3f& delta );

    [[nodiscard]] MRMESH_API bool isNegative() const;
    MRMESH_API virtual void setIsNegative( bool value );
 
    enum class DistanceMode
    {
        euclidean, 
        euclideanWithSignedDeltasPerAxis, 
        euclideanWithAbsoluteDeltasPerAxis, 
        xAbsolute,
        yAbsolute,
        zAbsolute,
    };

    [[nodiscard]] MRMESH_API DistanceMode getDistanceMode() const;
    MRMESH_API virtual void setDistanceMode( DistanceMode mode );

    [[nodiscard]] MRMESH_API float computeDistance() const;
 
    [[nodiscard]] MRMESH_API std::vector<std::string> getInfoLines() const override;

    [[nodiscard]] MRMESH_API std::size_t numComparableProperties() const override;
    [[nodiscard]] MRMESH_API std::string_view getComparablePropertyName( std::size_t i ) const override;
    [[nodiscard]] MRMESH_API std::optional<ComparableProperty> computeComparableProperty( std::size_t i ) const override;
    [[nodiscard]] MRMESH_API std::optional<ComparisonTolerance> getComparisonTolerence( std::size_t i ) const override;
    MRMESH_API void setComparisonTolerance( std::size_t i, std::optional<ComparisonTolerance> newTolerance ) override;
    MRMESH_API std::string_view getComparisonReferenceValueName( std::size_t i ) const override;
    [[nodiscard]] MRMESH_API ComparisonReferenceValue getComparisonReferenceValue( std::size_t i ) const override;
    MRMESH_API void setComparisonReferenceValue( std::size_t i, std::optional<ComparisonReferenceValue::Var> value ) override;
 
protected:
    DistanceMeasurementObject( const DistanceMeasurementObject& other ) = default;
 
    MRMESH_API void swapBase_( Object& other ) override;
 
    MRMESH_API void serializeFields_( Json::Value& root ) const override;
    MRMESH_API void deserializeFields_( const Json::Value& root ) override;
 
    MRMESH_API void setupRenderObject_() const override;
 
    MRMESH_API void onWorldXfChanged_() override;
 
private:

    bool isNegative_ = false;

    DistanceMode perCoordDeltas_ = DistanceMode::euclidean;

    mutable std::optional<float> cachedValue_;
 
    std::optional<ComparisonTolerance> tolerance_;
 
    std::optional<float> referenceValue_;
};
 
}