ResInsight/ApplicationCode/ProjectDataModel/RimWellPathGeometryDef.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 "RiaLineArcWellPathCalculator.h"
#include "RiaWellPlanCalculator.h"

#include "cafAppEnum.h"
#include "cafPdmChildArrayField.h"
#include "cafPdmChildField.h"
#include "cafPdmField.h"
#include "cafPdmFieldCvfVec3d.h"
#include "cafPdmObject.h"
#include "cafPdmPtrField.h"

#include "cvfObject.h"

class RimWellPath;
class RimWellPathTarget;
class RicCreateWellTargetsPickEventHandler;

class RigWellPath;

class RimWellPathGeometryDef : public caf::PdmObject
{
    CAF_PDM_HEADER_INIT;

public:
    RimWellPathGeometryDef();
    ~RimWellPathGeometryDef() override;

    cvf::Vec3d referencePointXyz() const;
    void       setReferencePointXyz( const cvf::Vec3d& refPointXyz );

    double airGap() const;
    void   setAirGap( double airGap );
    double mdAtFirstTarget() const;
    void   setMdAtFirstTarget( double mdrkb );

    cvf::ref<RigWellPath> createWellPathGeometry();

    void updateWellPathVisualization();
    std::pair<RimWellPathTarget*, RimWellPathTarget*>
        findActiveTargetsAroundInsertionPoint( const RimWellPathTarget* targetToInsertBefore );

    void insertTarget( const RimWellPathTarget* targetToInsertBefore, RimWellPathTarget* targetToInsert );
    void deleteTarget( RimWellPathTarget* targetTodelete );
    void deleteAllTargets();
    void appendTarget();

    const RimWellPathTarget* firstActiveTarget() const;
    const RimWellPathTarget* lastActiveTarget() const;

    void enableTargetPointPicking( bool isEnabling );

    std::vector<RiaWellPlanCalculator::WellPlanSegment> wellPlan() const;
    std::vector<RimWellPathTarget*>                     activeWellTargets() const;

protected:
    void defineCustomContextMenu( const caf::PdmFieldHandle* fieldNeedingMenu, QMenu* menu, QWidget* fieldEditorWidget ) override;

    void defineEditorAttribute( const caf::PdmFieldHandle* field,
                                QString                    uiConfigName,
                                caf::PdmUiEditorAttribute* attribute ) override;

    virtual void defineObjectEditorAttribute( QString uiConfigName, caf::PdmUiEditorAttribute* attribute ) override;

private:
    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
    void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
    void defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName ) override;
    void initAfterRead() override;
    QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions,
                                                         bool*                      useOptionsOnly ) override;

    RiaLineArcWellPathCalculator lineArcWellPathCalculator() const;

    void updateTargetAtSeaLevel();
    void test();

private:
    caf::PdmField<cvf::Vec3d> m_referencePointUtmXyd;

    caf::PdmField<double> m_airGap;

    caf::PdmField<double>                       m_mdAtFirstTarget;
    caf::PdmChildArrayField<RimWellPathTarget*> m_wellTargets;
    caf::PdmField<bool>                         m_useAutoGeneratedTargetAtSeaLevel;
    caf::PdmChildField<RimWellPathTarget*>      m_autoTargetAtSeaLevel;
    caf::PdmField<bool>                         m_pickPointsEnabled;

    std::shared_ptr<RicCreateWellTargetsPickEventHandler> m_pickTargetsEventHandler;
};