OrientationOperations.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/Model.h>
namespace NDEVR
{
    class DesignObjectLookup;
    /**--------------------------------------------------------------------------------------------------
    \brief Allows for easy manipulation of a Models orientation.
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_DESIGN_API OrientationOperations : public Model
    {
    public:
        enum AzimuthType
        {
              e_none
            , e_specified_angle
            , e_magnetic_angle
            , e_two_point_location
            , e_same_as_model
            , e_inverse_of_model
        };
        OrientationOperations();
        explicit OrientationOperations(uint01 dimension, const Model& model);
        
        
        void clearOrientation(const void* lock = nullptr);
        void setSpecifiedAngle(const Angle<fltp08>& azimuth, const void* lock = nullptr);
        void setOffsetAngle(const Angle<fltp08>& azimuth, const void* lock = nullptr);
        void setMagneticAngle(const Angle<fltp08>& magnetic_angle, const void* lock = nullptr);
        void setFrontLocation(const Vertex<3, fltp08>& front_location, const void* lock = nullptr);
        void setBackLocation(const Vertex<3, fltp08>& back_location, const void* lock = nullptr);
        void setReferencePoints(const Vertex<3, fltp08>& location_a, const Vertex<3, fltp08>& location_b, const void* lock = nullptr);
        void setReferenceModels(const UUID& front_reference, const UUID& back_reference, const void* lock = nullptr);
        void setMirrorFromAzimuth(const UUID& reference, const void* lock = nullptr);
        void setBackReferenceModel(const UUID& reference, bool is_relative, const void* lock = nullptr);
        void setFrontReferenceModel(const UUID& reference, bool is_relative, const void* lock = nullptr);
        Vertex<3, fltp08> aziLocationA() const;
        Vertex<3, fltp08> aziLocationB() const;
        UUID aziReferenceA() const;
        UUID aziReferenceB() const;
        bool isRelative() const;
        Angle<fltp08> specifiedAngle() const;
        Angle<fltp08> magneticAngle() const;
        Angle<fltp08> offsetAngle() const;
        AzimuthType aziType() const;
        void setAziType(const AzimuthType& type);
        void updateAzimuth(DesignObjectLookup* lookup);
        void updateAzimuth(const void* lock = nullptr);
        void autoUpdateAzimuthType();
        String prefix() const;
    private:
        void _setAzimuth(const Angle<fltp08>& azimuth, const void* lock = nullptr);
        const uint01 m_dimension;
    };
}