ResInsight/ApplicationLibCode/ProjectDataModel/RimPlotAxisProperties.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2016-2018 Statoil ASA
//  Copyright (C) 2019-     Equinor ASA
//
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE.
//
//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "Appearance/RimFontSizeField.h"
#include "RimPlotAxisPropertiesInterface.h"

#include "RiuPlotAxis.h"

#include "cafAppEnum.h"
#include "cafFontTools.h"
#include "cafPdmChildArrayField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"

#include <QString>

namespace caf
{
class SignalEmitter;
}

class RimPlotAxisAnnotation;

//==================================================================================================
///
///
//==================================================================================================
class RimPlotAxisProperties : public RimPlotAxisPropertiesInterface
{
    CAF_PDM_HEADER_INIT;

public:
    enum NumberFormatType
    {
        NUMBER_FORMAT_AUTO,
        NUMBER_FORMAT_DECIMAL,
        NUMBER_FORMAT_SCIENTIFIC
    };

    enum class Orientation
    {
        HORIZONTAL,
        VERTICAL,
        ANY
    };

public:
    caf::Signal<bool>                                             logarithmicChanged;
    caf::Signal<RimPlotAxisProperties*, RiuPlotAxis, RiuPlotAxis> axisPositionChanged;

public:
    RimPlotAxisProperties();

    void configureForBasicUse();
    void configureForHistogramUse();

    void setAlwaysRequired( bool enable );

    void setEnableTitleTextSettings( bool enable );
    void setEnableTitleLayoutSettings( bool enable );
    void enableRangeSettings( bool enable );
    void setNameForUnusedAxis();
    void setNameAndAxis( const QString& objectName, const QString& axistTitle, RiaDefines::PlotAxis axis, int axisIndex = 0 );
    AxisTitlePositionType titlePosition() const override;

    QString customTitle() const;

    int titleFontSize() const override;
    int valuesFontSize() const override;

    const QString objectName() const override;
    const QString axisTitleText() const override;

    RiuPlotAxis plotAxis() const override;
    bool        useAutoTitle() const;

    void setShowDescription( bool enable );
    bool showDescription() const;

    void setShowAcronym( bool enable );
    bool showAcronym() const;

    void setShowUnitText( bool enable );
    bool showUnitText() const;

    bool isAutoZoom() const override;
    void setAutoZoom( bool enableAutoZoom ) override;
    bool isAxisInverted() const override;
    void setAxisInverted( bool inverted );
    bool showNumbers() const;
    void setShowNumbers( bool enable );

    NumberFormatType numberFormat() const;
    int              decimalCount() const;
    double           scaleFactor() const;

    void setVisible( bool visible );
    void enableAutoValueForScaleFactor( bool enable );
    void computeAndSetAutoValueForScaleFactor();

    bool isDeletable() const override;

    std::vector<RimPlotAxisAnnotation*> annotations() const override;
    void                                appendAnnotation( RimPlotAxisAnnotation* annotation ) override;
    void                                removeAllAnnotations() override;

    bool isLogarithmicScaleEnabled() const override;
    void setLogarithmicScaleEnabled( bool enabled );
    bool isActive() const override;

    void showAnnotationObjectsInProjectTree();

    double visibleRangeMin() const override;
    double visibleRangeMax() const override;

    void enableAutoValueMinMax( bool enable );
    void setAutoValueVisibleRangeMin( double value );
    void setAutoValueVisibleRangeMax( double value );
    void setVisibleRangeMin( double value ) override;
    void setVisibleRangeMax( double value ) override;
    void setAutoZoomIfNoCustomRangeIsSet();

    LegendTickmarkCount majorTickmarkCount() const override;
    void                setMajorTickmarkCount( LegendTickmarkCount count ) override;
    void                setAutoValueForMajorTickmarkCount( LegendTickmarkCount count, bool notifyFieldChanged );
    void                enableAutoValueForMajorTickmarkCount( bool enable );

    void enableAutoValueForAllFields( bool enable );

    void appendMenuItems( caf::CmdFeatureMenuBuilder& menuBuilder ) const override;

protected:
    void                 initAfterRead() override;
    caf::PdmFieldHandle* userDescriptionField() override;
    caf::PdmFieldHandle* objectToggleField() override;
    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
    void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;

    QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions ) override;

private:
    void                     updateOptionSensitivity();
    caf::FontTools::FontSize plotFontSize() const;
    void                     defineObjectEditorAttribute( QString uiConfigName, caf::PdmUiEditorAttribute* attribute ) override;
    void                     onPinnedTagClicked( const caf::SignalEmitter* emitter, size_t index );

private:
    caf::PdmField<bool> m_isActive;

    caf::PdmField<bool> isAutoTitle;
    caf::PdmField<bool> m_displayShortName;
    caf::PdmField<bool> m_displayLongName;
    caf::PdmField<bool> m_displayUnitText;
    caf::PdmField<bool> m_isAutoZoom;
    caf::PdmField<bool> m_isAxisInverted;
    caf::PdmField<bool> m_showNumbers;

    caf::PdmField<double> m_visibleRangeMin;
    caf::PdmField<double> m_visibleRangeMax;

    caf::PdmField<QString> m_objectName;
    caf::PdmField<QString> m_axisTitle;

    caf::PdmField<caf::AppEnum<RiaDefines::PlotAxis>> m_plotAxis;
    caf::PdmField<int>                                m_plotAxisIndex;
    caf::PdmField<LegendTickmarkCountEnum>            m_majorTickmarkCount;

    caf::PdmField<QString> m_customTitle;

    caf::PdmField<caf::AppEnum<NumberFormatType>> m_numberFormat;
    caf::PdmField<int>                            m_numberOfDecimals;
    caf::PdmField<double>                         m_scaleFactor;

    caf::PdmField<bool> m_isLogarithmicScaleEnabled;

    bool m_enableTitleTextSettings;
    bool m_enableTitleLayoutSettings;
    bool m_isRangeSettingsEnabled;
    bool m_isAlwaysRequired;

    RimFontSizeField                                   m_titleFontSize;
    caf::PdmField<caf::AppEnum<AxisTitlePositionType>> m_titlePositionEnum;
    RimFontSizeField                                   m_valuesFontSize;
    caf::PdmChildArrayField<RimPlotAxisAnnotation*>    m_annotations;
};