| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef INCLUDED_DRAWINGLAYER_GEOMETRY_VIEWINFORMATION2D_HXX |
| #define INCLUDED_DRAWINGLAYER_GEOMETRY_VIEWINFORMATION2D_HXX |
| |
| // the solaris compiler defines 'sun' as '1'. To avoid that (and to allow |
| // pre-declarations of com/sun/star namespace), include sal/config.h here |
| // where sun is redefined as 'sun' (so i guess the problem is known). |
| #include <drawinglayer/drawinglayerdllapi.h> |
| #include <sal/config.h> |
| #include <com/sun/star/uno/Sequence.h> |
| #include <com/sun/star/beans/PropertyValue.hpp> |
| #include <com/sun/star/drawing/XDrawPage.hpp> |
| |
| ////////////////////////////////////////////////////////////////////////////// |
| // predefines |
| |
| namespace drawinglayer { namespace geometry { |
| class ImpViewInformation2D; |
| }} |
| |
| namespace basegfx { |
| class B2DHomMatrix; |
| class B2DRange; |
| } |
| |
| ////////////////////////////////////////////////////////////////////////////// |
| |
| namespace drawinglayer |
| { |
| namespace geometry |
| { |
| /** ViewInformation2D class |
| |
| This class holds all view-relevant information for a 2d geometry. It works |
| together with UNO API definitions and supports holding a sequence of PropertyValues. |
| The most used data is for convenience offered directly using basegfx tooling classes. |
| It is an implementation to support the sequence of PropertyValues used in a |
| ::com::sun::star::graphic::XPrimitive2D for C++ implementations working with those |
| */ |
| class DRAWINGLAYER_DLLPUBLIC ViewInformation2D |
| { |
| private: |
| /// pointer to private implementation class |
| ImpViewInformation2D* mpViewInformation2D; |
| |
| public: |
| /** Constructor: Create a ViewInformation2D |
| |
| @param rObjectTransformation |
| The Transformation from Object to World coordinates (normally logic coordinates). |
| |
| @param rViewTransformation |
| The Transformation from World to View coordinates (normally logic coordinates |
| to discrete units, e.g. pixels). |
| |
| @param rViewport |
| The visible part of the view in World coordinates. If empty (getViewport().isEmpty()) |
| everything is visible. The data is in World coordinates. |
| |
| @param rxDrawPage |
| The currently displaqyed page. This information is needed e.g. due to existing PageNumber |
| fields which need to be interpreted. |
| |
| @param fViewTime |
| The time the view is defined for. Default is 0.0. This parameter is used e.g. for |
| animated objects |
| |
| @param rExtendedParameters |
| A sequence of property values which allows holding various other parameters besides |
| the obvious and needed ones above. For this constructor none of the other parameters |
| should be added as data. The constructor will parse the given parameters and if |
| data for the other parameters is given, the value in rExtendedParameters will |
| be preferred and overwrite the given parameter |
| */ |
| ViewInformation2D( |
| const basegfx::B2DHomMatrix& rObjectTransformation, |
| const basegfx::B2DHomMatrix& rViewTransformation, |
| const basegfx::B2DRange& rViewport, |
| const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >& rxDrawPage, |
| double fViewTime, |
| const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& rExtendedParameters); |
| |
| /** Constructor: Create a ViewInformation2D |
| |
| @param rViewParameters |
| A sequence of property values which allows holding any combination of local and various |
| other parameters. This constructor is feeded completely with a sequence of PropertyValues |
| which will be parsed to be able to offer the most used ones in a convenient way. |
| */ |
| ViewInformation2D(const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& rViewParameters); |
| |
| /// default (empty) constructor |
| ViewInformation2D(); |
| |
| /// copy constructor |
| ViewInformation2D(const ViewInformation2D& rCandidate); |
| |
| /// destructor |
| ~ViewInformation2D(); |
| |
| // checks if the incarnation is default constructed |
| bool isDefault() const; |
| |
| /// assignment operator |
| ViewInformation2D& operator=(const ViewInformation2D& rCandidate); |
| |
| /// compare operators |
| bool operator==(const ViewInformation2D& rCandidate) const; |
| bool operator!=(const ViewInformation2D& rCandidate) const { return !operator==(rCandidate); } |
| |
| /// data access |
| const basegfx::B2DHomMatrix& getObjectTransformation() const; |
| const basegfx::B2DHomMatrix& getViewTransformation() const; |
| const basegfx::B2DRange& getViewport() const; |
| double getViewTime() const; |
| const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >& getVisualizedPage() const; |
| |
| /// On-demand prepared Object to View transformation and it's inerse for convenience |
| const basegfx::B2DHomMatrix& getObjectToViewTransformation() const; |
| const basegfx::B2DHomMatrix& getInverseObjectToViewTransformation() const; |
| |
| /// On-demand prepared Viewport in discrete units for convenience |
| const basegfx::B2DRange& getDiscreteViewport() const; |
| |
| /** support reduced DisplayQuality, PropertyName is 'ReducedDisplayQuality'. This |
| is used e.g. to allow to lower display quality for OverlayPrimitives and |
| may lead to simpler decompositions in the local create2DDecomposition |
| implementations of the primitives |
| */ |
| bool getReducedDisplayQuality() const; |
| |
| /** Get the uno::Sequence< beans::PropertyValue > which contains all ViewInformation |
| |
| Use this call if You need to extract all contained ViewInformation. The ones |
| directly supported for convenience will be added to the ones only available |
| as PropertyValues. This set completely describes this ViewInformation2D and |
| can be used for complete information transport over UNO API. |
| */ |
| const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& getViewInformationSequence() const; |
| |
| /** Get the uno::Sequence< beans::PropertyValue > which contains only ViewInformation |
| not offered directly |
| |
| Use this call if You only need ViewInformation which is not offered conveniently, |
| but only exists as PropertyValue. This is e.g. used to create partially updated |
| incarnations of ViewInformation2D without losing the only with PropertyValues |
| defined data. It does not contain a complete description. |
| */ |
| const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& getExtendedInformationSequence() const; |
| }; |
| } // end of namespace geometry |
| } // end of namespace drawinglayer |
| |
| ////////////////////////////////////////////////////////////////////////////// |
| |
| #endif //INCLUDED_DRAWINGLAYER_GEOMETRY_VIEWINFORMATION2D_HXX |
| |
| // eof |
