oox/source/drawingml/chart/plotareaconverter.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include "oox/drawingml/chart/plotareaconverter.hxx"
  21
  22 #include <com/sun/star/chart/XChartDocument.hpp>
  23 #include <com/sun/star/chart/XDiagramPositioning.hpp>
  24 #include <com/sun/star/chart2/XChartDocument.hpp>
  25 #include <com/sun/star/chart2/XCoordinateSystemContainer.hpp>
  26 #include <com/sun/star/chart2/XDiagram.hpp>
  27 #include <com/sun/star/drawing/Direction3D.hpp>
  28 #include <com/sun/star/drawing/ProjectionMode.hpp>
  29 #include <com/sun/star/drawing/ShadeMode.hpp>
  30 #include "oox/drawingml/chart/axisconverter.hxx"
  31 #include "oox/drawingml/chart/plotareamodel.hxx"
  32 #include "oox/drawingml/chart/typegroupconverter.hxx"
  33
  34 namespace oox {
  35 namespace drawingml {
  36 namespace chart {
  37
  38 // ============================================================================
  39
  40 using namespace ::com::sun::star;
  41 using namespace ::com::sun::star::chart2;
  42 using namespace ::com::sun::star::uno;
  43
  44 // ============================================================================
  45
  46 namespace {
  47
  48 /** Axes set model. This is a helper for the plot area converter collecting all
  49     type groups and axes of the primary or secondary axes set. */
  50 struct AxesSetModel
  51 {
  52     typedef ModelVector< TypeGroupModel >       TypeGroupVector;
  53     typedef ModelMap< sal_Int32, AxisModel >    AxisMap;
  54
  55     TypeGroupVector     maTypeGroups;       /// All type groups containing data series.
  56     AxisMap             maAxes;             /// All axes mapped by API axis type.
  57
  58     inline explicit     AxesSetModel() {}
  59     inline              ~AxesSetModel() {}
  60 };
  61
  62 // ============================================================================
  63
  64 /** Axes set converter. This is a helper class for the plot area converter. */
  65 class AxesSetConverter : public ConverterBase< AxesSetModel >
  66 {
  67 public:
  68     explicit            AxesSetConverter( const ConverterRoot& rParent, AxesSetModel& rModel );
  69     virtual             ~AxesSetConverter();
  70
  71     /** Converts the axes set model to a chart2 diagram. Returns an automatic
  72         chart title from a single series title, if possible. */
  73     void                convertFromModel(
  74                             const Reference< XDiagram >& rxDiagram,
  75                             View3DModel& rView3DModel,
  76                             sal_Int32 nAxesSetIdx,
  77                             bool bSupportsVaryColorsByPoint );
  78
  79     /** Returns the automatic chart title if the axes set contains only one series. */
  80     inline const OUString& getAutomaticTitle() const { return maAutoTitle; }
  81     /** Returns true, if the chart is three-dimensional. */
  82     inline bool         is3dChart() const { return mb3dChart; }
  83     /** Returns true, if chart type supports wall and floor format in 3D mode. */
  84     inline bool         isWall3dChart() const { return mbWall3dChart; }
  85     /** Returns true, if chart is a pie chart or doughnut chart. */
  86     inline bool         isPieChart() const { return mbPieChart; }
  87
  88 private:
  89     OUString     maAutoTitle;
  90     bool                mb3dChart;
  91     bool                mbWall3dChart;
  92     bool                mbPieChart;
  93 };
  94
  95 // ----------------------------------------------------------------------------
  96
  97 AxesSetConverter::AxesSetConverter( const ConverterRoot& rParent, AxesSetModel& rModel ) :
  98     ConverterBase< AxesSetModel >( rParent, rModel ),
  99     mb3dChart( false ),
 100     mbWall3dChart( false ),
 101     mbPieChart( false )
 102 {
 103 }
 104
 105 AxesSetConverter::~AxesSetConverter()
 106 {
 107 }
 108
 109 ModelRef< AxisModel > lclGetOrCreateAxis( const AxesSetModel::AxisMap& rFromAxes, sal_Int32 nAxisIdx, sal_Int32 nDefTypeId )
 110 {
 111     ModelRef< AxisModel > xAxis = rFromAxes.get( nAxisIdx );
 112     if( !xAxis )
 113         xAxis.create( nDefTypeId ).mbDeleted = true;  // missing axis is invisible
 114     return xAxis;
 115 }
 116
 117 void AxesSetConverter::convertFromModel( const Reference< XDiagram >& rxDiagram,
 118         View3DModel& rView3DModel, sal_Int32 nAxesSetIdx, bool bSupportsVaryColorsByPoint )
 119 {
 120     // create type group converter objects for all type groups
 121     typedef RefVector< TypeGroupConverter > TypeGroupConvVector;
 122     TypeGroupConvVector aTypeGroups;
 123     for( AxesSetModel::TypeGroupVector::iterator aIt = mrModel.maTypeGroups.begin(), aEnd = mrModel.maTypeGroups.end(); aIt != aEnd; ++aIt )
 124         aTypeGroups.push_back( TypeGroupConvVector::value_type( new TypeGroupConverter( *this, **aIt ) ) );
 125
 126     OSL_ENSURE( !aTypeGroups.empty(), "AxesSetConverter::convertFromModel - no type groups in axes set" );
 127     if( !aTypeGroups.empty() ) try
 128     {
 129         // first type group needed for coordinate system and axis conversion
 130         TypeGroupConverter& rFirstTypeGroup = *aTypeGroups.front();
 131
 132         // get automatic chart title, if there is only one type group
 133         if( aTypeGroups.size() == 1 )
 134             maAutoTitle = rFirstTypeGroup.getSingleSeriesTitle();
 135
 136         /*  Create a coordinate system. For now, all type groups from all axes sets
 137             have to be inserted into one coordinate system. Later, chart2 should
 138             support using one coordinate system for each axes set. */
 139         Reference< XCoordinateSystem > xCoordSystem;
 140         Reference< XCoordinateSystemContainer > xCoordSystemCont( rxDiagram, UNO_QUERY_THROW );
 141         Sequence< Reference< XCoordinateSystem > > aCoordSystems = xCoordSystemCont->getCoordinateSystems();
 142         if( aCoordSystems.hasElements() )
 143         {
 144             OSL_ENSURE( aCoordSystems.getLength() == 1, "AxesSetConverter::convertFromModel - too many coordinate systems" );
 145             xCoordSystem = aCoordSystems[ 0 ];
 146             OSL_ENSURE( xCoordSystem.is(), "AxesSetConverter::convertFromModel - invalid coordinate system" );
 147         }
 148         else
 149         {
 150             xCoordSystem = rFirstTypeGroup.createCoordinateSystem();
 151             if( xCoordSystem.is() )
 152                 xCoordSystemCont->addCoordinateSystem( xCoordSystem );
 153         }
 154
 155         // 3D view settings
 156         mb3dChart = rFirstTypeGroup.is3dChart();
 157         mbWall3dChart = rFirstTypeGroup.isWall3dChart();
 158         mbPieChart = rFirstTypeGroup.getTypeInfo().meTypeCategory == TYPECATEGORY_PIE;
 159         if( mb3dChart )
 160         {
 161             View3DConverter aView3DConv( *this, rView3DModel );
 162             aView3DConv.convertFromModel( rxDiagram, rFirstTypeGroup );
 163         }
 164
 165         /*  Convert all chart type groups. Each type group will add its series
 166             to the data provider attached to the chart document. */
 167         if( xCoordSystem.is() )
 168         {
 169             // convert all axes (create missing axis models)
 170             ModelRef< AxisModel > xXAxis = lclGetOrCreateAxis( mrModel.maAxes, API_X_AXIS, rFirstTypeGroup.getTypeInfo().mbCategoryAxis ? C_TOKEN( catAx ) : C_TOKEN( valAx ) );
 171             ModelRef< AxisModel > xYAxis = lclGetOrCreateAxis( mrModel.maAxes, API_Y_AXIS, C_TOKEN( valAx ) );
 172
 173             AxisConverter aXAxisConv( *this, *xXAxis );
 174             aXAxisConv.convertFromModel( xCoordSystem, rFirstTypeGroup, xYAxis.get(), nAxesSetIdx, API_X_AXIS );
 175             AxisConverter aYAxisConv( *this, *xYAxis );
 176             aYAxisConv.convertFromModel( xCoordSystem, rFirstTypeGroup, xXAxis.get(), nAxesSetIdx, API_Y_AXIS );
 177
 178             if( rFirstTypeGroup.isDeep3dChart() )
 179             {
 180                 ModelRef< AxisModel > xZAxis = lclGetOrCreateAxis( mrModel.maAxes, API_Z_AXIS, C_TOKEN( serAx ) );
 181                 AxisConverter aZAxisConv( *this, *xZAxis );
 182                 aZAxisConv.convertFromModel( xCoordSystem, rFirstTypeGroup, 0, nAxesSetIdx, API_Z_AXIS );
 183             }
 184
 185             // convert all chart type groups, this converts all series data and formatting
 186             for( TypeGroupConvVector::iterator aTIt = aTypeGroups.begin(), aTEnd = aTypeGroups.end(); aTIt != aTEnd; ++aTIt )
 187                 (*aTIt)->convertFromModel( rxDiagram, xCoordSystem, nAxesSetIdx, bSupportsVaryColorsByPoint );
 188         }
 189     }
 190     catch( Exception& )
 191     {
 192     }
 193 }
 194
 195 } // namespace
 196
 197 // ============================================================================
 198
 199 View3DConverter::View3DConverter( const ConverterRoot& rParent, View3DModel& rModel ) :
 200     ConverterBase< View3DModel >( rParent, rModel )
 201 {
 202 }
 203
 204 View3DConverter::~View3DConverter()
 205 {
 206 }
 207
 208 void View3DConverter::convertFromModel( const Reference< XDiagram >& rxDiagram, TypeGroupConverter& rTypeGroup )
 209 {
 210     namespace cssd = ::com::sun::star::drawing;
 211     PropertySet aPropSet( rxDiagram );
 212
 213     sal_Int32 nRotationY = 0;
 214     sal_Int32 nRotationX = 0;
 215     bool bRightAngled = false;
 216     sal_Int32 nAmbientColor = 0;
 217     sal_Int32 nLightColor = 0;
 218
 219     if( rTypeGroup.getTypeInfo().meTypeCategory == TYPECATEGORY_PIE )
 220     {
 221         // Y rotation used as 'first pie slice angle' in 3D pie charts
 222         rTypeGroup.convertPieRotation( aPropSet, mrModel.monRotationY.get( 0 ) );
 223         // X rotation a.k.a. elevation (map OOXML [0..90] to Chart2 [-90,0])
 224         nRotationX = getLimitedValue< sal_Int32, sal_Int32 >( mrModel.monRotationX.get( 15 ), 0, 90 ) - 90;
 225         // no right-angled axes in pie charts
 226         bRightAngled = false;
 227         // ambient color (Gray 30%)
 228         nAmbientColor = 0xB3B3B3;
 229         // light color (Gray 70%)
 230         nLightColor = 0x4C4C4C;
 231     }
 232     else // 3D bar/area/line charts
 233     {
 234         // Y rotation (OOXML [0..359], Chart2 [-179,180])
 235         nRotationY = mrModel.monRotationY.get( 20 );
 236         // X rotation a.k.a. elevation (OOXML [-90..90], Chart2 [-179,180])
 237         nRotationX = getLimitedValue< sal_Int32, sal_Int32 >( mrModel.monRotationX.get( 15 ), -90, 90 );
 238         // right-angled axes
 239         bRightAngled = mrModel.mbRightAngled;
 240         // ambient color (Gray 20%)
 241         nAmbientColor = 0xCCCCCC;
 242         // light color (Gray 60%)
 243         nLightColor = 0x666666;
 244     }
 245
 246     // Y rotation (map OOXML [0..359] to Chart2 [-179,180])
 247     nRotationY %= 360;
 248     if( nRotationY > 180 ) nRotationY -= 360;
 249     /*  Perspective (map OOXML [0..200] to Chart2 [0,100]). Seems that MSO 2007 is
 250         buggy here, the XML plugin of MSO 2003 writes the correct perspective in
 251         the range from 0 to 100. We will emulate the wrong behaviour of MSO 2007. */
 252     sal_Int32 nPerspective = getLimitedValue< sal_Int32, sal_Int32 >( mrModel.mnPerspective / 2, 0, 100 );
 253     // projection mode (parallel axes, if right-angled, #i90360# or if perspective is at 0%)
 254     bool bParallel = bRightAngled || (nPerspective == 0);
 255     cssd::ProjectionMode eProjMode = bParallel ? cssd::ProjectionMode_PARALLEL : cssd::ProjectionMode_PERSPECTIVE;
 256
 257     // set rotation properties
 258     aPropSet.setProperty( PROP_RotationVertical, nRotationY );
 259     aPropSet.setProperty( PROP_RotationHorizontal, nRotationX );
 260     aPropSet.setProperty( PROP_Perspective, nPerspective );
 261     aPropSet.setProperty( PROP_RightAngledAxes, bRightAngled );
 262     aPropSet.setProperty( PROP_D3DScenePerspective, eProjMode );
 263
 264     // set light settings
 265     aPropSet.setProperty( PROP_D3DSceneShadeMode, cssd::ShadeMode_FLAT );
 266     aPropSet.setProperty( PROP_D3DSceneAmbientColor, nAmbientColor );
 267     aPropSet.setProperty( PROP_D3DSceneLightOn1, false );
 268     aPropSet.setProperty( PROP_D3DSceneLightOn2, true );
 269     aPropSet.setProperty( PROP_D3DSceneLightColor2, nLightColor );
 270     aPropSet.setProperty( PROP_D3DSceneLightDirection2, cssd::Direction3D( 0.2, 0.4, 1.0 ) );
 271 }
 272
 273 // ============================================================================
 274
 275 WallFloorConverter::WallFloorConverter( const ConverterRoot& rParent, WallFloorModel& rModel ) :
 276     ConverterBase< WallFloorModel >( rParent, rModel )
 277 {
 278 }
 279
 280 WallFloorConverter::~WallFloorConverter()
 281 {
 282 }
 283
 284 void WallFloorConverter::convertFromModel( const Reference< XDiagram >& rxDiagram, ObjectType eObjType )
 285 {
 286     if( rxDiagram.is() )
 287     {
 288         PropertySet aPropSet;
 289         switch( eObjType )
 290         {
 291             case OBJECTTYPE_FLOOR:  aPropSet.set( rxDiagram->getFloor() );  break;
 292             case OBJECTTYPE_WALL:   aPropSet.set( rxDiagram->getWall() );   break;
 293             default:                OSL_FAIL( "WallFloorConverter::convertFromModel - invalid object type" );
 294         }
 295         if( aPropSet.is() )
 296             getFormatter().convertFrameFormatting( aPropSet, mrModel.mxShapeProp, mrModel.mxPicOptions.getOrCreate(), eObjType );
 297     }
 298 }
 299
 300 // ============================================================================
 301
 302 PlotAreaConverter::PlotAreaConverter( const ConverterRoot& rParent, PlotAreaModel& rModel ) :
 303     ConverterBase< PlotAreaModel >( rParent, rModel ),
 304     mb3dChart( false ),
 305     mbWall3dChart( false ),
 306     mbPieChart( false )
 307 {
 308 }
 309
 310 PlotAreaConverter::~PlotAreaConverter()
 311 {
 312 }
 313
 314 void PlotAreaConverter::convertFromModel( View3DModel& rView3DModel )
 315 {
 316     /*  Create the diagram object and attach it to the chart document. One
 317         diagram is used to carry all coordinate systems and data series. */
 318     Reference< XDiagram > xDiagram;
 319     try
 320     {
 321         xDiagram.set( createInstance( "com.sun.star.chart2.Diagram" ), UNO_QUERY_THROW );
 322         getChartDocument()->setFirstDiagram( xDiagram );
 323     }
 324     catch( Exception& )
 325     {
 326     }
 327
 328     // store all axis models in a map, keyed by axis identifier
 329     typedef ModelMap< sal_Int32, AxisModel > AxisMap;
 330     AxisMap aAxisMap;
 331     for( PlotAreaModel::AxisVector::iterator aAIt = mrModel.maAxes.begin(), aAEnd = mrModel.maAxes.end(); aAIt != aAEnd; ++aAIt )
 332     {
 333         PlotAreaModel::AxisVector::value_type xAxis = *aAIt;
 334         OSL_ENSURE( xAxis->mnAxisId >= 0, "PlotAreaConverter::convertFromModel - invalid axis identifier" );
 335         OSL_ENSURE( !aAxisMap.has( xAxis->mnAxisId ), "PlotAreaConverter::convertFromModel - axis identifiers not unique" );
 336         if( xAxis->mnAxisId >= 0 )
 337             aAxisMap[ xAxis->mnAxisId ] = xAxis;
 338     }
 339
 340     // group the type group models into different axes sets
 341     typedef ModelVector< AxesSetModel > AxesSetVector;
 342     AxesSetVector aAxesSets;
 343     sal_Int32 nMaxSeriesIdx = -1;
 344     for( PlotAreaModel::TypeGroupVector::iterator aTIt = mrModel.maTypeGroups.begin(), aTEnd = mrModel.maTypeGroups.end(); aTIt != aTEnd; ++aTIt )
 345     {
 346         PlotAreaModel::TypeGroupVector::value_type xTypeGroup = *aTIt;
 347         if( !xTypeGroup->maSeries.empty() )
 348         {
 349             // try to find a compatible axes set for the type group
 350             AxesSetModel* pAxesSet = 0;
 351             for( AxesSetVector::iterator aASIt = aAxesSets.begin(), aASEnd = aAxesSets.end(); !pAxesSet && (aASIt != aASEnd); ++aASIt )
 352                 if( (*aASIt)->maTypeGroups.front()->maAxisIds == xTypeGroup->maAxisIds )
 353                     pAxesSet = aASIt->get();
 354
 355             // not possible to insert into an existing axes set -> start a new axes set
 356             if( !pAxesSet )
 357             {
 358                 pAxesSet = &aAxesSets.create();
 359                 // find axis models used by the type group
 360                 const TypeGroupModel::AxisIdVector& rAxisIds = xTypeGroup->maAxisIds;
 361                 if( rAxisIds.size() >= 1 )
 362                     pAxesSet->maAxes[ API_X_AXIS ] = aAxisMap.get( rAxisIds[ 0 ] );
 363                 if( rAxisIds.size() >= 2 )
 364                     pAxesSet->maAxes[ API_Y_AXIS ] = aAxisMap.get( rAxisIds[ 1 ] );
 365                 if( rAxisIds.size() >= 3 )
 366                     pAxesSet->maAxes[ API_Z_AXIS ] = aAxisMap.get( rAxisIds[ 2 ] );
 367             }
 368
 369             // insert the type group model
 370             pAxesSet->maTypeGroups.push_back( xTypeGroup );
 371
 372             // collect the maximum series index for automatic series formatting
 373             for( TypeGroupModel::SeriesVector::iterator aSIt = xTypeGroup->maSeries.begin(), aSEnd = xTypeGroup->maSeries.end(); aSIt != aSEnd; ++aSIt )
 374                 nMaxSeriesIdx = ::std::max( nMaxSeriesIdx, (*aSIt)->mnIndex );
 375         }
 376     }
 377     getFormatter().setMaxSeriesIndex( nMaxSeriesIdx );
 378
 379     // varying point colors only for single series in single chart type
 380     bool bSupportsVaryColorsByPoint = mrModel.maTypeGroups.size() == 1;
 381
 382     // convert all axes sets
 383     for( AxesSetVector::iterator aASBeg = aAxesSets.begin(), aASIt = aASBeg, aASEnd = aAxesSets.end(); aASIt != aASEnd; ++aASIt )
 384     {
 385         AxesSetConverter aAxesSetConv( *this, **aASIt );
 386         sal_Int32 nAxesSetIdx = static_cast< sal_Int32 >( aASIt - aASBeg );
 387         aAxesSetConv.convertFromModel( xDiagram, rView3DModel, nAxesSetIdx, bSupportsVaryColorsByPoint );
 388         if( nAxesSetIdx == 0 )
 389         {
 390             maAutoTitle = aAxesSetConv.getAutomaticTitle();
 391             mb3dChart = aAxesSetConv.is3dChart();
 392             mbWall3dChart = aAxesSetConv.isWall3dChart();
 393             mbPieChart = aAxesSetConv.isPieChart();
 394         }
 395         else
 396         {
 397             maAutoTitle = OUString();
 398         }
 399     }
 400
 401     // plot area formatting
 402     if( xDiagram.is() && !mb3dChart )
 403     {
 404         PropertySet aPropSet( xDiagram->getWall() );
 405         getFormatter().convertFrameFormatting( aPropSet, mrModel.mxShapeProp, OBJECTTYPE_PLOTAREA2D );
 406     }
 407 }
 408
 409 void PlotAreaConverter::convertPositionFromModel()
 410 {
 411     LayoutModel& rLayout = mrModel.mxLayout.getOrCreate();
 412     LayoutConverter aLayoutConv( *this, rLayout );
 413     awt::Rectangle aDiagramRect;
 414     if( aLayoutConv.calcAbsRectangle( aDiagramRect ) ) try
 415     {
 416         namespace cssc = ::com::sun::star::chart;
 417         Reference< cssc::XChartDocument > xChart1Doc( getChartDocument(), UNO_QUERY_THROW );
 418         Reference< cssc::XDiagramPositioning > xPositioning( xChart1Doc->getDiagram(), UNO_QUERY_THROW );
 419         // for pie charts, always set inner plot area size to exclude the data labels as Excel does
 420         sal_Int32 nTarget = (mbPieChart && (rLayout.mnTarget == XML_outer)) ? XML_inner : rLayout.mnTarget;
 421         switch( nTarget )
 422         {
 423             case XML_inner:
 424                 xPositioning->setDiagramPositionExcludingAxes( aDiagramRect );
 425             break;
 426             case XML_outer:
 427                 xPositioning->setDiagramPositionIncludingAxes( aDiagramRect );
 428             break;
 429             default:
 430                 OSL_FAIL( "PlotAreaConverter::convertPositionFromModel - unknown positioning target" );
 431         }
 432     }
 433     catch( Exception& )
 434     {
 435     }
 436 }
 437
 438 // ============================================================================
 439
 440 } // namespace chart
 441 } // namespace drawingml
 442 } // namespace oox
 443
 444 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */