ResInsight/ApplicationCode/ProjectDataModel/Annotations/RimAnnotationLineAppearance.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2018-     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 "cafPdmChildArrayField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"
#include "cafPdmPointer.h"
#include "cafAppEnum.h"
#include "cafPdmUiOrdering.h"

// Include to make Pdm work for cvf::Color
#include "cafPdmFieldCvfColor.h" 
#include "cafPdmChildField.h"
#include "cafPdmFieldCvfVec3d.h"

#include "cvfObject.h"
#include "cvfVector3.h"

#include <vector>

class QString;
class RimGridView;


//==================================================================================================
///
///
//==================================================================================================
class RimAnnotationLineAppearance : public caf::PdmObject
{
    // Friends
    friend class RimReachCircleAnnotation;
    friend class RimUserDefinedPolylinesAnnotation;
    friend class RimPolylinesFromFileAnnotation;

    using Vec3d = cvf::Vec3d;

    CAF_PDM_HEADER_INIT;

public:
    using FieldChangedByUiDelegate = std::function<void(const caf::PdmFieldHandle*, const QVariant&, const QVariant&)>;

    enum LineStyleEnum
    {
        STYLE_SOLID,
        STYLE_DASH
    };
    typedef caf::AppEnum<LineStyleEnum> LineStyle;

public:
    RimAnnotationLineAppearance();

    cvf::Color3f        color() const;
    bool                isDashed() const;
    int                 thickness() const;

    const caf::PdmFieldHandle* colorField() const;
    const caf::PdmFieldHandle* styleField() const;
    const caf::PdmFieldHandle* thicknessField() const;

    void                registerFieldChangedByUiCallback(FieldChangedByUiDelegate func);

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

private:
    caf::PdmField<cvf::Color3f>     m_color;
    caf::PdmField<LineStyle>        m_style;
    caf::PdmField<int>              m_thickness;

    FieldChangedByUiDelegate  m_fieldChangedByUiCallback;
};