1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_SLIDESHOW_SHAPE_HXX 25*b1cdbd2cSJim Jagielski #define INCLUDED_SLIDESHOW_SHAPE_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/Reference.hxx> 28*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/XShape.hpp> 29*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/XDrawPage.hpp> 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski #include <basegfx/range/b2drectangle.hxx> 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski #include "viewlayer.hxx" 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp> 36*b1cdbd2cSJim Jagielski #include <boost/noncopyable.hpp> 37*b1cdbd2cSJim Jagielski #include <set> 38*b1cdbd2cSJim Jagielski #include <vector> 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski namespace basegfx { 41*b1cdbd2cSJim Jagielski class B2DRange; 42*b1cdbd2cSJim Jagielski } 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski namespace slideshow 45*b1cdbd2cSJim Jagielski { 46*b1cdbd2cSJim Jagielski namespace internal 47*b1cdbd2cSJim Jagielski { 48*b1cdbd2cSJim Jagielski // forward declaration necessary, because methods use ShapeSharedPtr 49*b1cdbd2cSJim Jagielski class Shape; 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski typedef ::boost::shared_ptr< Shape > ShapeSharedPtr; 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski /** Represents a slide's shape object. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski This interface represents the view-independent aspects of a 56*b1cdbd2cSJim Jagielski slide's shape, providing bound rect, underlying XShape and 57*b1cdbd2cSJim Jagielski basic paint methods. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski class Shape : private boost::noncopyable 60*b1cdbd2cSJim Jagielski { 61*b1cdbd2cSJim Jagielski public: ~Shape()62*b1cdbd2cSJim Jagielski virtual ~Shape() {} 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski /** Get the associated XShape of this shape. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @return the associated XShape. If this method returns 67*b1cdbd2cSJim Jagielski an empty reference, this object might be one of the 68*b1cdbd2cSJim Jagielski special-purpose shapes of a slide, which have no 69*b1cdbd2cSJim Jagielski direct corresponding XShape (the background comes to 70*b1cdbd2cSJim Jagielski mind here). 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Reference< 73*b1cdbd2cSJim Jagielski ::com::sun::star::drawing::XShape > getXShape() const = 0; 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski // View layer methods 77*b1cdbd2cSJim Jagielski //------------------------------------------------------------------ 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski /** Add a new view layer. 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski This method adds a new view layer, this shape shall 82*b1cdbd2cSJim Jagielski show itself on. 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski @param rNewLayer 85*b1cdbd2cSJim Jagielski New layer to show on 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski @param bRedrawLayer 88*b1cdbd2cSJim Jagielski Redraw shape on given layer 89*b1cdbd2cSJim Jagielski */ 90*b1cdbd2cSJim Jagielski virtual void addViewLayer( const ViewLayerSharedPtr& rNewLayer, 91*b1cdbd2cSJim Jagielski bool bRedrawLayer ) = 0; 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski /** Withdraw the shape from a view layer 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski This method removes the shape from the given view 96*b1cdbd2cSJim Jagielski layer. 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski @return true, if the shape was successfully removed 99*b1cdbd2cSJim Jagielski */ 100*b1cdbd2cSJim Jagielski virtual bool removeViewLayer( const ViewLayerSharedPtr& rNewLayer ) = 0; 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski /** Withdraw all view layers at once 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski This method will be faster than repeated 105*b1cdbd2cSJim Jagielski removeViewLayer() calls. 106*b1cdbd2cSJim Jagielski */ 107*b1cdbd2cSJim Jagielski virtual bool clearAllViewLayers() = 0; 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski // render methods 110*b1cdbd2cSJim Jagielski //------------------------------------------------------------------ 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski /** Update the shape 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski This method updates the Shape on all registered view 115*b1cdbd2cSJim Jagielski layers, but only if shape content has actually 116*b1cdbd2cSJim Jagielski changed. 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski @return whether the update finished successfully. 119*b1cdbd2cSJim Jagielski */ 120*b1cdbd2cSJim Jagielski virtual bool update() const = 0; 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski /** Render the shape. 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski This method renders the shape on all registered view 125*b1cdbd2cSJim Jagielski layers, regardless of whether shape content has 126*b1cdbd2cSJim Jagielski changed or not. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @return whether the rendering finished successfully. 129*b1cdbd2cSJim Jagielski */ 130*b1cdbd2cSJim Jagielski virtual bool render() const = 0; 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski /** Query whether shape content changed 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski This method returns true, if shape content changed 135*b1cdbd2cSJim Jagielski since the last rendering (i.e. the shape needs an 136*b1cdbd2cSJim Jagielski update to reflect that changed content on the views). 137*b1cdbd2cSJim Jagielski */ 138*b1cdbd2cSJim Jagielski virtual bool isContentChanged() const = 0; 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski // Shape attributes 142*b1cdbd2cSJim Jagielski //------------------------------------------------------------------ 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski /** Get the current shape position and size. 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski This method yields the currently effective shape 147*b1cdbd2cSJim Jagielski bounds (which might change over time, for animated 148*b1cdbd2cSJim Jagielski shapes). Please note that possibly shape rotations 149*b1cdbd2cSJim Jagielski from its original document state must not be taken 150*b1cdbd2cSJim Jagielski into account here: if you need the screen bounding 151*b1cdbd2cSJim Jagielski box, use getUpdateArea() instead. Note further that 152*b1cdbd2cSJim Jagielski shape rotations, which are already contained in the 153*b1cdbd2cSJim Jagielski shape as displayed in the original document 154*b1cdbd2cSJim Jagielski <em>are</em> included herein (we currently take the 155*b1cdbd2cSJim Jagielski shape as-is from the document, assuming a rotation 156*b1cdbd2cSJim Jagielski angle of 0). 157*b1cdbd2cSJim Jagielski */ 158*b1cdbd2cSJim Jagielski virtual ::basegfx::B2DRange getBounds() const = 0; 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski /** Get the DOM position and size of the shape. 161*b1cdbd2cSJim Jagielski 162*b1cdbd2cSJim Jagielski This method yields the underlying DOM shape bounds, 163*b1cdbd2cSJim Jagielski i.e. the original shape bounds from the document 164*b1cdbd2cSJim Jagielski model. This value is <em>always</em> unaffected by any 165*b1cdbd2cSJim Jagielski animation activity. Note that shape rotations, which 166*b1cdbd2cSJim Jagielski are already contained in the shape as displayed in the 167*b1cdbd2cSJim Jagielski original document are already included herein (we 168*b1cdbd2cSJim Jagielski currently take the shape as-is from the document, 169*b1cdbd2cSJim Jagielski assuming a rotation angle of 0). 170*b1cdbd2cSJim Jagielski */ 171*b1cdbd2cSJim Jagielski virtual ::basegfx::B2DRange getDomBounds() const = 0; 172*b1cdbd2cSJim Jagielski 173*b1cdbd2cSJim Jagielski /** Get the current shape update area. 174*b1cdbd2cSJim Jagielski 175*b1cdbd2cSJim Jagielski This method yields the currently effective update area 176*b1cdbd2cSJim Jagielski for the shape, i.e. the area that needs to be updated, 177*b1cdbd2cSJim Jagielski should the shape be painted. Normally, this will be 178*b1cdbd2cSJim Jagielski the (possibly rotated and sheared) area returned by 179*b1cdbd2cSJim Jagielski getBounds(). 180*b1cdbd2cSJim Jagielski */ 181*b1cdbd2cSJim Jagielski virtual ::basegfx::B2DRange getUpdateArea() const = 0; 182*b1cdbd2cSJim Jagielski 183*b1cdbd2cSJim Jagielski /** Query whether the shape is visible at all. 184*b1cdbd2cSJim Jagielski 185*b1cdbd2cSJim Jagielski @return true, if this shape is visible, false 186*b1cdbd2cSJim Jagielski otherwise. 187*b1cdbd2cSJim Jagielski */ 188*b1cdbd2cSJim Jagielski virtual bool isVisible() const = 0; 189*b1cdbd2cSJim Jagielski 190*b1cdbd2cSJim Jagielski /** Get the shape priority. 191*b1cdbd2cSJim Jagielski 192*b1cdbd2cSJim Jagielski The shape priority defines the relative order of the 193*b1cdbd2cSJim Jagielski shapes on the slide. 194*b1cdbd2cSJim Jagielski 195*b1cdbd2cSJim Jagielski @return the priority. Will be in the [0,+infty) range. 196*b1cdbd2cSJim Jagielski */ 197*b1cdbd2cSJim Jagielski virtual double getPriority() const = 0; 198*b1cdbd2cSJim Jagielski 199*b1cdbd2cSJim Jagielski /** Query whether the Shape is currently detached from the 200*b1cdbd2cSJim Jagielski background. 201*b1cdbd2cSJim Jagielski 202*b1cdbd2cSJim Jagielski This method checks whether the Shape is currently 203*b1cdbd2cSJim Jagielski detached from the slide background, i.e. whether shape 204*b1cdbd2cSJim Jagielski updates affect the underlying slide background or 205*b1cdbd2cSJim Jagielski not. A shape that returnes true here must not alter 206*b1cdbd2cSJim Jagielski slide content in any way when called render() or 207*b1cdbd2cSJim Jagielski update() (this is normally achieved by making this 208*b1cdbd2cSJim Jagielski shape a sprite). 209*b1cdbd2cSJim Jagielski */ 210*b1cdbd2cSJim Jagielski virtual bool isBackgroundDetached() const = 0; 211*b1cdbd2cSJim Jagielski 212*b1cdbd2cSJim Jagielski // Misc 213*b1cdbd2cSJim Jagielski //------------------------------------------------------------------ 214*b1cdbd2cSJim Jagielski 215*b1cdbd2cSJim Jagielski /** Functor struct, for shape ordering 216*b1cdbd2cSJim Jagielski 217*b1cdbd2cSJim Jagielski This defines a strict weak ordering of shapes, primary 218*b1cdbd2cSJim Jagielski sort key is the shape priority, and secondy sort key 219*b1cdbd2cSJim Jagielski the object ptr value. Most typical use is for 220*b1cdbd2cSJim Jagielski associative containers holding shapes (and which also 221*b1cdbd2cSJim Jagielski have to maintain something like a paint order). 222*b1cdbd2cSJim Jagielski */ 223*b1cdbd2cSJim Jagielski struct lessThanShape 224*b1cdbd2cSJim Jagielski { 225*b1cdbd2cSJim Jagielski // make functor adaptable (to boost::bind) 226*b1cdbd2cSJim Jagielski typedef bool result_type; 227*b1cdbd2cSJim Jagielski 228*b1cdbd2cSJim Jagielski // since the ZOrder property on the XShape has somewhat 229*b1cdbd2cSJim Jagielski // peculiar attributes (it's basically the index of the shapes 230*b1cdbd2cSJim Jagielski // in the drawing layer's SdrObjList - which means, it starts 231*b1cdbd2cSJim Jagielski // from 0 for children of group objects), we cannot use it to determine 232*b1cdbd2cSJim Jagielski // drawing order. Thus, we rely on importer-provided order values here, 233*b1cdbd2cSJim Jagielski // which is basically a running counter during shape import (i.e. denotes 234*b1cdbd2cSJim Jagielski // the order of shape import). This is the correct order, at least for the 235*b1cdbd2cSJim Jagielski // current drawing core. 236*b1cdbd2cSJim Jagielski // 237*b1cdbd2cSJim Jagielski // If, someday, the above proposition is no longer true, one directly use 238*b1cdbd2cSJim Jagielski // the shape's ZOrder property 239*b1cdbd2cSJim Jagielski // compareslideshow::internal::Shape::lessThanShape240*b1cdbd2cSJim Jagielski static bool compare(const Shape* pLHS, const Shape* pRHS) 241*b1cdbd2cSJim Jagielski { 242*b1cdbd2cSJim Jagielski const double nPrioL( pLHS->getPriority() ); 243*b1cdbd2cSJim Jagielski const double nPrioR( pRHS->getPriority() ); 244*b1cdbd2cSJim Jagielski 245*b1cdbd2cSJim Jagielski // if prios are equal, tie-break on ptr value 246*b1cdbd2cSJim Jagielski return nPrioL == nPrioR ? pLHS < pRHS : nPrioL < nPrioR; 247*b1cdbd2cSJim Jagielski } 248*b1cdbd2cSJim Jagielski operator ()slideshow::internal::Shape::lessThanShape249*b1cdbd2cSJim Jagielski bool operator()(const ShapeSharedPtr& rLHS, const ShapeSharedPtr& rRHS) const 250*b1cdbd2cSJim Jagielski { 251*b1cdbd2cSJim Jagielski return compare(rLHS.get(),rRHS.get()); 252*b1cdbd2cSJim Jagielski } 253*b1cdbd2cSJim Jagielski operator ()slideshow::internal::Shape::lessThanShape254*b1cdbd2cSJim Jagielski bool operator()(const Shape* pLHS, const Shape* pRHS) const 255*b1cdbd2cSJim Jagielski { 256*b1cdbd2cSJim Jagielski return compare(pLHS, pRHS); 257*b1cdbd2cSJim Jagielski } 258*b1cdbd2cSJim Jagielski }; 259*b1cdbd2cSJim Jagielski }; 260*b1cdbd2cSJim Jagielski 261*b1cdbd2cSJim Jagielski typedef ::boost::shared_ptr< Shape > ShapeSharedPtr; 262*b1cdbd2cSJim Jagielski 263*b1cdbd2cSJim Jagielski /** A set which contains all shapes in an ordered fashion. 264*b1cdbd2cSJim Jagielski */ 265*b1cdbd2cSJim Jagielski typedef ::std::set< ShapeSharedPtr, Shape::lessThanShape > ShapeSet; 266*b1cdbd2cSJim Jagielski } 267*b1cdbd2cSJim Jagielski } 268*b1cdbd2cSJim Jagielski 269*b1cdbd2cSJim Jagielski #endif /* INCLUDED_SLIDESHOW_SHAPE_HXX */ 270