ResInsight/ApplicationLibCode/ProjectDataModel/Annotations/RimReachCircleAnnotation.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  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.
//
/////////////////////////////////////////////////////////////////////////////////

#include "RimReachCircleAnnotation.h"

#include "RimAnnotationCollection.h"
#include "RimAnnotationInViewCollection.h"
#include "RimAnnotationLineAppearance.h"
#include "RimGridView.h"
#include "RimProject.h"

#include "RicVec3dPickEventHandler.h"

#include "cafPdmUiPickableLineEditor.h"
#include "cafPdmUiPushButtonEditor.h"

CAF_PDM_SOURCE_INIT( RimReachCircleAnnotation, "RimReachCircleAnnotation" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimReachCircleAnnotation::RimReachCircleAnnotation()
{
    CAF_PDM_InitObject( "CircleAnnotation", ":/ReachCircle16x16.png", "", "" );

    CAF_PDM_InitField( &m_isActive, "IsActive", true, "Is Active", "", "", "" );
    m_isActive.uiCapability()->setUiHidden( true );

    CAF_PDM_InitField( &m_centerPointXyd, "CenterPointXyd", Vec3d::ZERO, "Center Point", "", "", "" );
    m_centerPointXyd.uiCapability()->setUiEditorTypeName( caf::PdmUiPickableLineEditor::uiEditorTypeName() );
    CAF_PDM_InitField( &m_centerPointPickEnabled, "AnchorPointPick", false, "", "", "", "" );
    caf::PdmUiPushButtonEditor::configureEditorForField( &m_centerPointPickEnabled );
    m_centerPointPickEnabled.uiCapability()->setUiLabelPosition( caf::PdmUiItemInfo::LabelPosType::HIDDEN );

    CAF_PDM_InitField( &m_radius, "Radius", 100.0, "Radius", "", "", "" );
    CAF_PDM_InitField( &m_name, "Name", QString( "Circle Annotation" ), "Name", "", "", "" );

    CAF_PDM_InitFieldNoDefault( &m_appearance, "Appearance", "Appearance", "", "", "" );

    m_appearance = new RimReachCircleLineAppearance();
    m_appearance.uiCapability()->setUiTreeHidden( true );
    m_appearance.uiCapability()->setUiTreeChildrenHidden( true );

    m_centerPointEventHandler.reset( new RicVec3dPickEventHandler( &m_centerPointXyd ) );

    setDeletable( true );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimReachCircleAnnotation::isActive()
{
    return m_isActive();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimReachCircleAnnotation::isVisible()
{
    RimAnnotationCollectionBase* coll;
    firstAncestorOrThisOfType( coll );

    return coll && coll->isActive() && m_isActive;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimReachCircleAnnotation::enablePicking( bool enable )
{
    m_centerPointPickEnabled = enable;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
cvf::Vec3d RimReachCircleAnnotation::centerPoint() const
{
    auto pos = m_centerPointXyd();
    pos.z()  = -pos.z();
    return pos;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
double RimReachCircleAnnotation::radius() const
{
    return m_radius;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimReachCircleAnnotation::name() const
{
    return m_name;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimReachCircleLineAppearance* RimReachCircleAnnotation::appearance() const
{
    return m_appearance;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimReachCircleAnnotation::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
    uiOrdering.add( &m_name );
    uiOrdering.add( &m_centerPointXyd );
    uiOrdering.add( &m_centerPointPickEnabled, false );
    uiOrdering.add( &m_radius );

    auto appearanceGroup = uiOrdering.addNewGroup( "Appearance" );
    appearance()->uiOrdering( uiConfigName, *appearanceGroup );

    uiOrdering.skipRemainingFields( true );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimReachCircleAnnotation::fieldChangedByUi( const caf::PdmFieldHandle* changedField,
                                                 const QVariant&            oldValue,
                                                 const QVariant&            newValue )
{
    if ( changedField == &m_centerPointXyd )
    {
        m_centerPointPickEnabled = false;
        this->updateConnectedEditors();
    }
    if ( changedField == &m_centerPointPickEnabled )
    {
        this->updateConnectedEditors();
    }
    RimAnnotationCollection* annColl = nullptr;
    this->firstAncestorOrThisOfTypeAsserted( annColl );

    annColl->scheduleRedrawOfRelevantViews();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
caf::PdmFieldHandle* RimReachCircleAnnotation::userDescriptionField()
{
    return &m_name;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
caf::PdmFieldHandle* RimReachCircleAnnotation::objectToggleField()
{
    return &m_isActive;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimReachCircleAnnotation::defineEditorAttribute( const caf::PdmFieldHandle* field,
                                                      QString                    uiConfigName,
                                                      caf::PdmUiEditorAttribute* attribute )
{
    if ( field == &m_centerPointXyd )
    {
        auto* attr = dynamic_cast<caf::PdmUiPickableLineEditorAttribute*>( attribute );
        if ( attr )
        {
            attr->pickEventHandler = m_centerPointEventHandler;
            attr->enablePicking    = m_centerPointPickEnabled;
            if ( m_centerPointXyd().isZero() )
            {
                attr->enablePicking = true;
            }
        }
    }

    if ( field == &m_centerPointPickEnabled )
    {
        auto* attr = dynamic_cast<caf::PdmUiPushButtonEditorAttribute*>( attribute );
        if ( attr )
        {
            if ( m_centerPointPickEnabled )
            {
                attr->m_buttonText = "Stop";
            }
            else
            {
                attr->m_buttonText = "Pick";
            }
        }
    }
}