VCoordinateSystem.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#pragma once
 
#include "MinimumAndMaximumSupplier.hxx"
#include <ThreeDHelper.hxx>
#include "VSeriesPlotter.hxx"
#include <chartview/ExplicitScaleValues.hxx>
#include <com/sun/star/drawing/HomogenMatrix.hpp>
#include <com/sun/star/uno/Sequence.h>
#include <rtl/ref.hxx>
#include <svx/unoshape.hxx>
 
#include <map>
#include <memory>
#include <vector>
 
namespace com::sun::star::awt { struct Rectangle; }
namespace com::sun::star::awt { struct Size; }
namespace com::sun::star::beans { class XPropertySet; }
namespace com::sun::star::chart2 { class XAxis; }
namespace com::sun::star::chart2 { class XChartDocument; }
namespace com::sun::star::chart2 { class XCoordinateSystem; }
namespace com::sun::star::drawing { class XShapes; }
namespace com::sun::star::lang { class XMultiServiceFactory; }
namespace com::sun::star::uno { class XComponentContext; }
 
namespace chart
{
class ExplicitCategoriesProvider;
class ScaleAutomatism;
class ChartModel;
class Axis;
class BaseCoordinateSystem;
class GridProperties;
class VAxisBase;
 
class VCoordinateSystem
{
public:
    virtual ~VCoordinateSystem();
 
    static std::unique_ptr<VCoordinateSystem> createCoordinateSystem( const rtl::Reference<
                                ::chart::BaseCoordinateSystem >& xCooSysModel );
 
    void initPlottingTargets(
                  const rtl::Reference< SvxShapeGroupAnyD >& xLogicTarget
                , const rtl::Reference< SvxShapeGroupAnyD >& xFinalTarget
                , rtl::Reference<SvxShapeGroupAnyD>& xLogicTargetForSeriesBehindAxis );
 
    void setParticle( const OUString& rCooSysParticle );
 
    void setTransformationSceneToScreen( const css::drawing::HomogenMatrix& rMatrix );
    const css::drawing::HomogenMatrix& getTransformationSceneToScreen() const { return m_aMatrixSceneToScreen;}
 
    //better performance for big data
    virtual css::uno::Sequence< sal_Int32 > getCoordinateSystemResolution( const css::awt::Size& rPageSize
                                    , const css::awt::Size& rPageResolution );
 
    ExplicitScaleData getExplicitScale( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex ) const;
    ExplicitIncrementData getExplicitIncrement( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex ) const;
 
    void setExplicitCategoriesProvider( ExplicitCategoriesProvider* /*takes ownership*/ );
    ExplicitCategoriesProvider* getExplicitCategoriesProvider();
 
    // returns a complete scale set for a given dimension and index; for example if nDimensionIndex==1 and nAxisIndex==2 you get returned the secondary x axis, main y axis and main z axis
    std::vector< ExplicitScaleData > getExplicitScales( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex ) const;
    // returns a complete increment set for a given dimension and index; for example if nDimensionIndex==1 and nAxisIndex==2 you get returned the secondary x axis, main y axis and main z axis
    std::vector< ExplicitIncrementData > getExplicitIncrements( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex ) const;
 
    void addMinimumAndMaximumSupplier( MinimumAndMaximumSupplier* pMinimumAndMaximumSupplier );
    bool hasMinimumAndMaximumSupplier( MinimumAndMaximumSupplier* pMinimumAndMaximumSupplier );
    void clearMinimumAndMaximumSupplierList();
 
    void prepareAutomaticAxisScaling( ScaleAutomatism& rScaleAutomatism, sal_Int32 nDimIndex, sal_Int32 nAxisIndex );
 
    void setExplicitScaleAndIncrement( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex
        , const ExplicitScaleData& rExplicitScale
        , const ExplicitIncrementData& rExplicitIncrement );
 
    void set3DWallPositions( CuboidPlanePosition eLeftWallPos, CuboidPlanePosition eBackWallPos, CuboidPlanePosition eBottomPos );
 
    const rtl::Reference< ::chart::BaseCoordinateSystem >&
        getModel() const { return m_xCooSysModel;}
 
    virtual void createVAxisList(
            const rtl::Reference<::chart::ChartModel> & xChartDoc,
            const css::awt::Size& rFontReferenceSize,
            const css::awt::Rectangle& rMaximumSpaceForLabels,
            bool bLimitSpaceForLabels,
            std::vector<std::unique_ptr<VSeriesPlotter>>& rSeriesPlotterList,
            css::uno::Reference<css::uno::XComponentContext> const& rComponentContext);
 
    virtual void initVAxisInList();
    virtual void updateScalesAndIncrementsOnAxes();
 
    void createMaximumAxesLabels();
    void createAxesLabels();
    void updatePositions();
    void createAxesShapes();
 
    virtual void createGridShapes();
 
    bool getPropertySwapXAndYAxis() const;
 
    sal_Int32 getMaximumAxisIndexByDimension( sal_Int32 nDimensionIndex ) const;
 
    bool needSeriesNamesForAxis() const;
    void setSeriesNamesForAxis( const css::uno::Sequence< OUString >& rSeriesNames );
 
protected: //methods
    VCoordinateSystem( rtl::Reference< ::chart::BaseCoordinateSystem > xCooSys );
 
    rtl::Reference< ::chart::Axis >
        getAxisByDimension( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex  ) const;
    static std::vector< rtl::Reference< ::chart::GridProperties > >
        getGridListFromAxis( const rtl::Reference< ::chart::Axis >& xAxis );
 
    VAxisBase* getVAxis( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex );
 
    OUString createCIDForAxis( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex );
    OUString createCIDForGrid( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex );
 
    sal_Int32 getNumberFormatKeyForAxis( const rtl::Reference< ::chart::Axis >& xAxis
                     , const rtl::Reference<::chart::ChartModel>& xChartDoc);
 
private: //methods
    static void impl_adjustDimension( sal_Int32& rDimensionIndex );
    void impl_adjustDimensionAndIndex( sal_Int32& rDimensionIndex, sal_Int32& rAxisIndex ) const;
 
protected: //member
    rtl::Reference< ::chart::BaseCoordinateSystem > m_xCooSysModel;
 
    OUString m_aCooSysParticle;
 
    typedef std::pair< sal_Int32, sal_Int32 > tFullAxisIndex; //first index is the dimension, second index is the axis index that indicates whether this is a main or secondary axis
 
    rtl::Reference<SvxShapeGroupAnyD>                m_xLogicTargetForGrids;
    rtl::Reference<SvxShapeGroupAnyD>                m_xLogicTargetForAxes;
    rtl::Reference<SvxShapeGroupAnyD>                m_xFinalTarget;
    css::drawing::HomogenMatrix                            m_aMatrixSceneToScreen;
 
    CuboidPlanePosition m_eLeftWallPos;
    CuboidPlanePosition m_eBackWallPos;
    CuboidPlanePosition m_eBottomPos;
 
    MergedMinimumAndMaximumSupplier m_aMergedMinMaxSupplier;
 
    css::uno::Sequence< OUString > m_aSeriesNamesForZAxis;
 
    typedef std::map< tFullAxisIndex, std::shared_ptr< VAxisBase > > tVAxisMap;
 
    tVAxisMap m_aAxisMap;
 
private:
    std::vector< ExplicitScaleData >     m_aExplicitScales;
    std::vector< ExplicitIncrementData > m_aExplicitIncrements;
 
    typedef std::map< tFullAxisIndex, ExplicitScaleData > tFullExplicitScaleMap;
    typedef std::map< tFullAxisIndex, ExplicitIncrementData > tFullExplicitIncrementMap;
 
    tFullExplicitScaleMap       m_aSecondaryExplicitScales;
    tFullExplicitIncrementMap   m_aSecondaryExplicitIncrements;
 
    std::unique_ptr< ExplicitCategoriesProvider > m_apExplicitCategoriesProvider;
};
 
} //namespace chart
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */