Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor LayoutOptions to improve readability #10809

Merged
merged 13 commits into from
Nov 10, 2023
20 changes: 10 additions & 10 deletions ApplicationLibCode/Application/RiaPreferences.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -337,26 +337,26 @@ void RiaPreferences::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering&
{
caf::PdmUiGroup* colorGroup = uiOrdering.addNewGroup( "Default Colors" );
colorGroup->add( &defaultViewerBackgroundColor );
colorGroup->add( &defaultGridLineColors, false );
colorGroup->appendToRow( &defaultGridLineColors );
colorGroup->add( &defaultFaultGridLineColors );
colorGroup->add( &defaultWellLabelColor, false );
colorGroup->add( &m_guiTheme, { true, 2 } );
colorGroup->appendToRow( &defaultWellLabelColor );
colorGroup->add( &m_guiTheme, { .newRow = true, .totalColumnSpan = 2 } );

caf::PdmUiGroup* fontGroup = uiOrdering.addNewGroup( "Default Font Sizes" );
fontGroup->add( &defaultSceneFontSize );
fontGroup->add( &defaultAnnotationFontSize, false );
fontGroup->appendToRow( &defaultAnnotationFontSize );
fontGroup->add( &defaultWellLabelFontSize );
fontGroup->add( &defaultPlotFontSize, false );
fontGroup->appendToRow( &defaultPlotFontSize );

caf::PdmUiGroup* viewsGroup = uiOrdering.addNewGroup( "3d Views" );
viewsGroup->add( &m_defaultMeshModeType );
viewsGroup->add( &m_navigationPolicy );
viewsGroup->add( &m_defaultScaleFactorZ );

viewsGroup->add( &m_showLegendBackground );
viewsGroup->add( &m_enableFaultsByDefault, { false, 1 } );
viewsGroup->add( &m_enableFaultsByDefault, { .newRow = false, .totalColumnSpan = 1 } );
viewsGroup->add( &m_showInfoBox );
viewsGroup->add( &m_showGridBox, { false, 1 } );
viewsGroup->add( &m_showGridBox, { .newRow = false, .totalColumnSpan = 1 } );

caf::PdmUiGroup* otherGroup = uiOrdering.addNewGroup( "Other" );
otherGroup->add( &ssihubAddress );
Expand Down Expand Up @@ -400,11 +400,11 @@ void RiaPreferences::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering&

caf::PdmUiGroup* pageSetup = generalGrp->addNewGroup( "Page Setup" );
pageSetup->add( &m_pageSize );
pageSetup->add( &m_pageOrientation, false );
pageSetup->appendToRow( &m_pageOrientation );
pageSetup->add( &m_pageLeftMargin );
pageSetup->add( &m_pageRightMargin, false );
pageSetup->appendToRow( &m_pageRightMargin );
pageSetup->add( &m_pageTopMargin );
pageSetup->add( &m_pageBottomMargin, false );
pageSetup->appendToRow( &m_pageBottomMargin );

generalGrp->add( &m_useQtChartsPlotByDefault );
m_useQtChartsPlotByDefault.uiCapability()->setUiHidden( true );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -314,16 +314,16 @@ void RicExportEclipseSectorModelUi::defineUiOrdering( QString uiConfigName, caf:
exportInLocalCoordinates.uiCapability()->setUiReadOnly( !exportGrid() );

caf::PdmUiGroup* gridBoxGroup = uiOrdering.addNewGroup( "Grid Box Selection" );
gridBoxGroup->add( &exportGridBox, { true, 4, 1 } );
gridBoxGroup->add( &exportGridBox, { .newRow = true, .totalColumnSpan = 4, .leftLabelColumnSpan = 1 } );

gridBoxGroup->add( &minI, { true, 2, 1 } );
gridBoxGroup->add( &minJ, false );
gridBoxGroup->add( &minK, false );
gridBoxGroup->add( &minI, { .newRow = true, .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );
gridBoxGroup->appendToRow( &minJ );
gridBoxGroup->appendToRow( &minK );

gridBoxGroup->add( &maxI, { true, 2, 1 } );
gridBoxGroup->add( &maxJ, false );
gridBoxGroup->add( &maxK, false );
gridBoxGroup->add( &makeInvisibleCellsInactive, { true, 2, 1 } );
gridBoxGroup->add( &maxI, { .newRow = true, .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );
gridBoxGroup->appendToRow( &maxJ );
gridBoxGroup->appendToRow( &maxK );
gridBoxGroup->add( &makeInvisibleCellsInactive, { .newRow = true, .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );

minI.uiCapability()->setUiReadOnly( exportGridBox() != MANUAL_SELECTION );
minJ.uiCapability()->setUiReadOnly( exportGridBox() != MANUAL_SELECTION );
Expand All @@ -333,9 +333,9 @@ void RicExportEclipseSectorModelUi::defineUiOrdering( QString uiConfigName, caf:
maxK.uiCapability()->setUiReadOnly( exportGridBox() != MANUAL_SELECTION );

caf::PdmUiGroup* gridRefinement = uiOrdering.addNewGroup( "Grid Refinement" );
gridRefinement->add( &refinementCountI, { true, 2, 1 } );
gridRefinement->add( &refinementCountJ, { false } );
gridRefinement->add( &refinementCountK, { false } );
gridRefinement->add( &refinementCountI, { .newRow = true, .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );
gridRefinement->appendToRow( &refinementCountJ );
gridRefinement->appendToRow( &refinementCountK );
refinementCountI.uiCapability()->setUiReadOnly( !exportGrid() );
refinementCountJ.uiCapability()->setUiReadOnly( !exportGrid() );
refinementCountK.uiCapability()->setUiReadOnly( !exportGrid() );
Expand Down
10 changes: 5 additions & 5 deletions ApplicationLibCode/Commands/ExportCommands/RicExportLgrUi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -220,19 +220,19 @@ void RicExportLgrUi::fieldChangedByUi( const caf::PdmFieldHandle* changedField,
//--------------------------------------------------------------------------------------------------
void RicExportLgrUi::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
caf::PdmUiOrdering::LayoutOptions layout( true, 6, 1 );
caf::PdmUiOrdering::LayoutOptions layout = { .newRow = true, .totalColumnSpan = 6, .leftLabelColumnSpan = 1 };
uiOrdering.add( &m_caseToApply, layout );
uiOrdering.add( &m_timeStep, layout );
uiOrdering.add( &m_exportFolder, layout );
uiOrdering.add( &m_includeFractures, layout );
uiOrdering.add( &m_includeFishbones, layout );
uiOrdering.add( &m_includePerforations, layout );
uiOrdering.add( &m_splitType, { true, 6, 1 } );
uiOrdering.add( &m_splitType, { .newRow = true, .totalColumnSpan = 6, .leftLabelColumnSpan = 1 } );

caf::PdmUiGroup* gridRefinement = uiOrdering.addNewGroup( "Grid Refinement" );
gridRefinement->add( &m_cellCountI, { true, 2, 1 } );
gridRefinement->add( &m_cellCountJ, { false } );
gridRefinement->add( &m_cellCountK, { false } );
gridRefinement->add( &m_cellCountI, { .newRow = true, .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );
gridRefinement->appendToRow( &m_cellCountJ );
gridRefinement->appendToRow( &m_cellCountK );

// uiOrdering.add(&m_wellPathsInfo);
uiOrdering.skipRemainingFields( true );
Expand Down
5 changes: 1 addition & 4 deletions ApplicationLibCode/Commands/RicGridCalculatorUi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,8 @@ void RicGridCalculatorUi::defineUiOrdering( QString uiConfigName, caf::PdmUiOrde
caf::PdmUiGroup* group = uiOrdering.findGroup( calculationsGroupName() );
if ( group )
{
caf::PdmUiOrdering::LayoutOptions layoutOptions;
layoutOptions.newRow = false;

group->add( &m_importCalculations );
group->add( &m_exportCalculations, layoutOptions );
group->appendToRow( &m_exportCalculations );
}
}

Expand Down
5 changes: 1 addition & 4 deletions ApplicationLibCode/Commands/RicUserDefinedCalculatorUi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,7 @@ void RicUserDefinedCalculatorUi::defineUiOrdering( QString uiConfigName, caf::Pd
caf::PdmUiGroup* group = uiOrdering.addNewGroupWithKeyword( "Calculations", calculationsGroupName() );
group->add( &m_currentCalculation );
group->add( &m_newCalculation );

caf::PdmUiOrdering::LayoutOptions layoutOptions;
layoutOptions.newRow = false;
group->add( &m_deleteCalculation, layoutOptions );
group->appendToRow( &m_deleteCalculation );
}

{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -489,8 +489,8 @@ void RimAnalysisPlot::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering
{
caf::PdmUiGroup* selVectorsGrp = uiOrdering.addNewGroup( "Selected Vectors" );
selVectorsGrp->add( &m_selectedVarsUiField );
selVectorsGrp->add( &m_selectVariablesButtonField, { false } );
selVectorsGrp->add( &m_referenceCase, { true, 3, 2 } );
selVectorsGrp->appendToRow( &m_selectVariablesButtonField );
selVectorsGrp->add( &m_referenceCase, { .newRow = true, .totalColumnSpan = 3, .leftLabelColumnSpan = 2 } );

QString vectorNames;
if ( updateAndGetCurveAnalyzer() )
Expand Down Expand Up @@ -521,22 +521,22 @@ void RimAnalysisPlot::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering

caf::PdmUiGroup* titleGrp = uiOrdering.addNewGroup( "Title and Legend" );
titleGrp->add( &m_showPlotTitle );
titleGrp->add( &m_useAutoPlotTitle, { false } );
titleGrp->add( &m_description, { false } );
titleGrp->appendToRow( &m_useAutoPlotTitle );
titleGrp->appendToRow( &m_description );
m_description.uiCapability()->setUiReadOnly( m_useAutoPlotTitle() );
titleGrp->add( &m_showPlotLegends );
titleGrp->add( &m_legendFontSize );
m_legendFontSize.uiCapability()->setUiReadOnly( !m_showPlotLegends() );

caf::PdmUiGroup* chartSettings = uiOrdering.addNewGroup( "Bar Settings" );
chartSettings->add( &m_barOrientation, { true, 3, 2 } );
chartSettings->add( &m_barOrientation, { .newRow = true, .totalColumnSpan = 3, .leftLabelColumnSpan = 2 } );

chartSettings->add( &m_majorGroupType );
chartSettings->add( &m_mediumGroupType );
chartSettings->add( &m_minorGroupType );
chartSettings->add( &m_valueSortOperation );
chartSettings->add( &m_useTopBarsFilter );
chartSettings->add( &m_maxBarCount, { false } );
chartSettings->appendToRow( &m_maxBarCount );
m_maxBarCount.uiCapability()->setUiReadOnly( !m_useTopBarsFilter() );
chartSettings->add( &m_sortGroupForColors );

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -336,19 +336,19 @@ void RimPlotDataFilterItem::defineUiOrdering( QString uiConfigName, caf::PdmUiOr

updateMaxMinAndDefaultValues( false );

uiOrdering.add( &m_filterTarget, { true, -1, 1 } );
uiOrdering.add( &m_filterTarget, { .leftLabelColumnSpan = 1 } );
if ( m_filterTarget() == ENSEMBLE_CASE )
{
uiOrdering.add( &m_filterEnsembleParameter, { true, caf::PdmUiOrdering::LayoutOptions::MAX_COLUMN_SPAN, 1 } );
uiOrdering.add( &m_filterEnsembleParameter, { .leftLabelColumnSpan = 1 } );
}
else
{
uiOrdering.add( &m_filterQuantityUiField, { true, caf::PdmUiOrdering::LayoutOptions::MAX_COLUMN_SPAN, 1 } );
uiOrdering.add( &m_filterQuantityUiField, { .leftLabelColumnSpan = 1 } );
// uiOrdering.add( &m_filterQuantitySelectButton, {false, 1, 0} );
}
if ( m_filterTarget() != ENSEMBLE_CASE )
{
uiOrdering.add( &m_consideredTimestepsType, { true, caf::PdmUiOrdering::LayoutOptions::MAX_COLUMN_SPAN, 1 } );
uiOrdering.add( &m_consideredTimestepsType, { .leftLabelColumnSpan = 1 } );
if ( m_consideredTimestepsType == SELECT_TIMESTEPS || m_consideredTimestepsType == SELECT_TIMESTEP_RANGE )
{
uiOrdering.add( &m_explicitlySelectedTimeSteps );
Expand All @@ -367,16 +367,16 @@ void RimPlotDataFilterItem::defineUiOrdering( QString uiConfigName, caf::PdmUiOr
}
else
{
uiOrdering.add( &m_filterOperation, { true, 2, 1 } );
uiOrdering.add( &m_filterOperation, { .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );

if ( m_filterOperation() == RANGE )
{
uiOrdering.add( &m_max, { true, caf::PdmUiOrdering::LayoutOptions::MAX_COLUMN_SPAN, 1 } );
uiOrdering.add( &m_min, { true, caf::PdmUiOrdering::LayoutOptions::MAX_COLUMN_SPAN, 1 } );
uiOrdering.add( &m_max, { .leftLabelColumnSpan = 1 } );
uiOrdering.add( &m_min, { .leftLabelColumnSpan = 1 } );
}
else if ( m_filterOperation == TOP_N || m_filterOperation == BOTTOM_N )
{
uiOrdering.add( &m_topBottomN, { false } );
uiOrdering.appendToRow( &m_topBottomN );
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ void RimReachCircleAnnotation::defineUiOrdering( QString uiConfigName, caf::PdmU
{
uiOrdering.add( &m_name );
uiOrdering.add( &m_centerPointXyd );
uiOrdering.add( &m_centerPointPickEnabled, false );
uiOrdering.appendToRow( &m_centerPointPickEnabled );
uiOrdering.add( &m_radius );

auto appearanceGroup = uiOrdering.addNewGroup( "Appearance" );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,9 @@ const QString& RimTextAnnotation::text() const
void RimTextAnnotation::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
uiOrdering.add( &m_anchorPointXyd );
uiOrdering.add( &m_anchorPointPickEnabledButtonField, false );
uiOrdering.appendToRow( &m_anchorPointPickEnabledButtonField );
uiOrdering.add( &m_labelPointXyd );
uiOrdering.add( &m_labelPointPickEnabledButtonField, false );
uiOrdering.appendToRow( &m_labelPointPickEnabledButtonField );

uiOrdering.add( &m_text );

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -259,9 +259,9 @@ void RimWellPathFracture::defineUiOrdering( QString uiConfigName, caf::PdmUiOrde

if ( m_fractureTemplate() )
{
uiOrdering.add( nameField(), caf::PdmUiOrdering::LayoutOptions( true, 3, 1 ) );
uiOrdering.add( &m_fractureTemplate, { true, 2, 1 } );
uiOrdering.add( &m_editFractureTemplate, { false, 1, 0 } );
uiOrdering.add( nameField(), { .newRow = true, .totalColumnSpan = 3, .leftLabelColumnSpan = 1 } );
uiOrdering.add( &m_fractureTemplate, { .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );
uiOrdering.add( &m_editFractureTemplate, { .newRow = false, .totalColumnSpan = 1, .leftLabelColumnSpan = 0 } );
}
else
{
Expand All @@ -270,7 +270,7 @@ void RimWellPathFracture::defineUiOrdering( QString uiConfigName, caf::PdmUiOrde
if ( RimProject::current()->allFractureTemplates().empty() )
{
uiOrdering.add( &m_createEllipseFractureTemplate );
uiOrdering.add( &m_createStimPlanFractureTemplate, false );
uiOrdering.appendToRow( &m_createStimPlanFractureTemplate );
}
else
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -510,14 +510,14 @@ void RimWellPathValve::defineUiOrdering( QString uiConfigName, caf::PdmUiOrderin
{
uiOrdering.skipRemainingFields( true );

uiOrdering.add( &m_valveTemplate, { true, 2, 1 } );
uiOrdering.add( &m_valveTemplate, { .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );

{
if ( m_valveTemplate() != nullptr )
{
uiOrdering.add( &m_editValveTemplate, false );
uiOrdering.appendToRow( &m_editValveTemplate );
}
uiOrdering.add( &m_createValveTemplate, false );
uiOrdering.appendToRow( &m_createValveTemplate );
}

if ( uiConfigName != "TemplateOnly" )
Expand All @@ -538,7 +538,7 @@ void RimWellPathValve::defineUiOrdering( QString uiConfigName, caf::PdmUiOrderin
m_measuredDepth.uiCapability()->setUiName( "Measured Depth [ft]" );
}
}
uiOrdering.add( &m_measuredDepth, { true, 3, 1 } );
uiOrdering.add( &m_measuredDepth, { .totalColumnSpan = 3, .leftLabelColumnSpan = 1 } );
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -748,13 +748,13 @@ void RimAbstractCorrelationPlot::appendDataSourceFields( QString uiConfigName, c
m_selectedVarsUiField = selectedVectorNamesText();

curveDataGroup->add( &m_selectedVarsUiField );
curveDataGroup->add( &m_pushButtonSelectSummaryAddress, { false, 1, 0 } );
curveDataGroup->add( &m_pushButtonSelectSummaryAddress, { .newRow = false, .totalColumnSpan = 1, .leftLabelColumnSpan = 0 } );
curveDataGroup->add( &m_timeStepFilter );
curveDataGroup->add( &m_timeStep );
curveDataGroup->add( &m_useCaseFilter );
curveDataGroup->add( &m_curveSetForFiltering );
m_curveSetForFiltering.uiCapability()->setUiHidden( !m_useCaseFilter() );
curveDataGroup->add( &m_editCaseFilter, { false, 1, 0 } );
curveDataGroup->add( &m_editCaseFilter, { .newRow = false, .totalColumnSpan = 1, .leftLabelColumnSpan = 0 } );
m_editCaseFilter.uiCapability()->setUiHidden( !m_useCaseFilter() );
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ void RimWellConnectivityTable::defineUiOrdering( QString uiConfigName, caf::PdmU
caf::PdmUiGroup* producerGroup = selectionGroup->addNewGroup( "Producers" );
producerGroup->add( &m_selectedProducerTracersUiField );
producerGroup->add( &m_syncSelectedInjectorsFromProducerSelection );
caf::PdmUiGroup* injectorGroup = selectionGroup->addNewGroup( "Injectors", false );
caf::PdmUiGroup* injectorGroup = selectionGroup->addNewGroup( "Injectors", { .newRow = false } );
injectorGroup->add( &m_selectedInjectorTracersUiField );
injectorGroup->add( &m_syncSelectedProducersFromInjectorSelection );

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1006,7 +1006,7 @@ void RimGridCrossPlotDataSet::defineUiOrdering( QString uiConfigName, caf::PdmUi
caf::PdmUiGroup* xAxisGroup = invisibleFullWidthGroup->addNewGroup( "X-Axis Property" );
m_xAxisProperty->uiOrdering( uiConfigName, *xAxisGroup );

caf::PdmUiGroup* yAxisGroup = invisibleFullWidthGroup->addNewGroup( "Y-Axis Property", false );
caf::PdmUiGroup* yAxisGroup = invisibleFullWidthGroup->addNewGroup( "Y-Axis Property", { .newRow = false } );
m_yAxisProperty->uiOrdering( uiConfigName, *yAxisGroup );
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ void RimCustomObjectiveFunctionWeight::fieldChangedByUi( const caf::PdmFieldHand
void RimCustomObjectiveFunctionWeight::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
uiOrdering.add( &m_objectiveValuesSummaryAddressesUiField );
uiOrdering.add( &m_objectiveValuesSelectSummaryAddressPushButton, { false, 1, 0 } );
uiOrdering.add( &m_objectiveValuesSelectSummaryAddressPushButton, { .newRow = false, .totalColumnSpan = 1, .leftLabelColumnSpan = 0 } );
uiOrdering.add( &m_weightValue );
uiOrdering.add( &m_objectiveFunction );

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1485,7 +1485,7 @@ void RimEclipseResultDefinition::defineUiOrdering( QString uiConfigName, caf::Pd
injectorGroup->add( &m_selectedInjectorTracersUiField );
injectorGroup->add( &m_syncInjectorToProducerSelection );

caf::PdmUiGroup* producerGroup = selectionGroup->addNewGroup( "Producers", false );
caf::PdmUiGroup* producerGroup = selectionGroup->addNewGroup( "Producers", { .newRow = false } );
producerGroup->add( &m_selectedProducerTracersUiField );
producerGroup->add( &m_syncProducerToInjectorSelection );
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1275,8 +1275,8 @@ void RimRegularLegendConfig::defineUiOrdering( QString uiConfigName, caf::PdmUiO
formatGr->add( &m_precision );
formatGr->add( &m_tickNumberFormat );

formatGr->add( &m_colorLegend, { true, 2, 1 } );
formatGr->add( &m_selectColorLegendButton, { false, 1, 0 } );
formatGr->add( &m_colorLegend, { .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );
formatGr->add( &m_selectColorLegendButton, { .newRow = false, .totalColumnSpan = 1, .leftLabelColumnSpan = 0 } );

caf::PdmUiOrdering* mappingGr = uiOrdering.addNewGroup( "Mapping" );
mappingGr->add( &m_mappingMode );
Expand All @@ -1297,8 +1297,8 @@ void RimRegularLegendConfig::defineUiOrdering( QString uiConfigName, caf::PdmUiO
//--------------------------------------------------------------------------------------------------
void RimRegularLegendConfig::defineUiOrderingColorOnly( caf::PdmUiOrdering* colorGroup )
{
colorGroup->add( &m_colorLegend, { true, 2, 1 } );
colorGroup->add( &m_selectColorLegendButton, { false, 1, 0 } );
colorGroup->add( &m_colorLegend, { .newRow = true, .totalColumnSpan = 2, .leftLabelColumnSpan = 1 } );
colorGroup->add( &m_selectColorLegendButton, { .newRow = false, .totalColumnSpan = 1, .leftLabelColumnSpan = 0 } );
}

//--------------------------------------------------------------------------------------------------
Expand Down
Loading