ResInsight/ApplicationLibCode/ProjectDataModel/Surfaces/RimSurface.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2020-     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 "cafPdmField.h"
#include "cafPdmObject.h"

#include "cafPdmFieldCvfColor.h"
#include "cafPdmProxyValueField.h"

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

#include <vector>

class RigSurface;

class RimSurface : public caf::PdmObject
{
    CAF_PDM_HEADER_INIT;

public:
    RimSurface();
    ~RimSurface() override;

    void         setColor( const cvf::Color3f& color );
    cvf::Color3f color() const;

    RigSurface* surfaceData();
    QString     userDescription();
    void        setUserDescription( const QString& description );

    virtual QString     fullName() const;
    virtual bool        onLoadData() = 0;
    virtual RimSurface* createCopy() = 0;

    void loadDataIfRequired();
    void reloadData();

protected:
    void setSurfaceData( RigSurface* surface );

    void   applyDepthOffsetIfNeeded( std::vector<cvf::Vec3d>* vertices ) const;
    double depthOffset() const;
    void   setDepthOffset( double depthoffset );

    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
    void defineEditorAttribute( const caf::PdmFieldHandle* field,
                                QString                    uiConfigName,
                                caf::PdmUiEditorAttribute* attribute ) override;

    static void applyDepthOffset( const cvf::Vec3d& offset, std::vector<cvf::Vec3d>* vertices );

    caf::PdmFieldHandle* userDescriptionField() override;

    virtual bool updateSurfaceData()     = 0;
    virtual void clearCachedNativeData() = 0;

private:
    caf::PdmField<QString>           m_userDescription;
    caf::PdmField<cvf::Color3f>      m_color;
    caf::PdmField<double>            m_depthOffset;
    caf::PdmProxyValueField<QString> m_nameProxy;

    cvf::ref<RigSurface> m_surfaceData;
};