?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Bump version to 6.0-36
[LibreOffice.git] / slideshow / source / inc / shapeattributelayer.hxx
blob27ed2c1ae22d5cea5b4fd3b8096a1d0cd6845bb7
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 #ifndef INCLUDED_SLIDESHOW_SOURCE_INC_SHAPEATTRIBUTELAYER_HXX
21 #define INCLUDED_SLIDESHOW_SOURCE_INC_SHAPEATTRIBUTELAYER_HXX
22
23 #include <com/sun/star/drawing/FillStyle.hpp>
24 #include <com/sun/star/drawing/LineStyle.hpp>
25 #include <com/sun/star/awt/FontSlant.hpp>
26
27 #include <basegfx/vector/b2dsize.hxx>
28 #include <basegfx/point/b2dpoint.hxx>
29 #include <basegfx/range/b2drectangle.hxx>
30 #include <basegfx/polygon/b2dpolypolygon.hxx>
31
32 #include "rgbcolor.hxx"
33
34 #include <stack>
35 #include <memory>
36
37
38 namespace slideshow
39 {
40 namespace internal
41 {
42
43 /** This interface represents a stateful object.
44
45 The state ID returned by the getStateId() method
46 abstractly encodes the object's state. When this ID
47 changes, clients can assume that the object's state has
48 changed.
49 */
50 class State final
51 {
52 public:
53
54 /// Abstract, numerically encoded state ID
55 typedef ::std::size_t StateId;
56 };
57
58 class ShapeAttributeLayer;
59
60 typedef ::std::shared_ptr< ShapeAttributeLayer > ShapeAttributeLayerSharedPtr;
61
62 /** Encapsulates all modifiable attributes of a shape.
63
64 This class holds all modifiable attributes of a shape, and
65 at the same time provides means to layer attributes on top
66 of each other..
67
68 And yes, there's a reason why we even pass bools and ints
69 by const reference. Namely, that makes the set* methods
70 differ only in the value type, which greatly reduces
71 template variability (e.g. in AnimationFactory).
72 */
73 class ShapeAttributeLayer
74 {
75 public:
76 /** Create a ShapeAttributeLayer instance, with all
77 attributes set to default.
78
79 Furthermore, this constructor gets a pointer to a
80 child layer, which is used as the fallback (or the
81 base value) for all attributes
82
83 @param rChildLayer
84 Layer below this one
85
86 @attention
87 This method is only supposed to be called from Shape objects
88 */
89 explicit ShapeAttributeLayer( const ShapeAttributeLayerSharedPtr& rChildLayer );
90
91 // Children management methods
92
93
94 /** Revoke the given layer.
95
96 This method revokes the given layer from this object
97 or one of the children. That is, if this object does
98 have children, and the given layer is no direct child,
99 it is recursively passed to the children for removal.
100
101 @return true, if removal was successful.
102
103 @attention
104 This method is only supposed to be called from Shape objects
105 */
106 bool revokeChildLayer( const ShapeAttributeLayerSharedPtr& rChildLayer );
107
108 /** Query the child layer of this object.
109
110 @attention
111 This method is only supposed to be called from Shape objects
112 */
113 const ShapeAttributeLayerSharedPtr& getChildLayer() const;
114
115 /** Set the additive mode for possible child attributes
116
117 This method sets the additive mode for child
118 attributes. That is the way underlying attribute
119 layers are combined with this one (i.e. to overrule
120 lower layers, or how to combine the values). The
121 default is
122 css::animations::AnimationAdditiveMode::BASE,
123 which means, take the value of the underlying layers,
124 or from the model shape itself.
125
126 @param nMode
127 Must be one of
128 css::animations::AnimationAdditiveMode.
129 */
130 void setAdditiveMode( sal_Int16 nMode );
131
132 // Attribute methods
133
134
135 /** Query whether the width attribute is valid.
136 */
137 bool isWidthValid() const;
138 /** Query the current width of the shape
139 */
140 double getWidth() const;
141 /** Set the new width of the shape
142
143 @param rNewWidth
144 A negative width mirrors the shape.
145 */
146 void setWidth( const double& rNewWidth );
147
148 /** Query whether the height attribute is valid.
149 */
150 bool isHeightValid() const;
151 /** Query the current height of the shape
152 */
153 double getHeight() const;
154 /** Set the new height of the shape
155
156 @param rNewHeight
157 A negative height mirrors the shape.
158 */
159 void setHeight( const double& rNewHeight );
160
161 /** Set the new size of the shape
162
163 @param rNewSize
164 A negative size mirrors the shape.
165 */
166 void setSize( const ::basegfx::B2DSize& rNewSize );
167
168 /** Query whether the x position attribute is valid
169 */
170 bool isPosXValid() const;
171 /** Query the current x position of the shape.
172
173 The current x position of the shape is always relative
174 to the <em>center</em> of the shape (in contrast to
175 the Shape::getBounds() and Shape::getUpdateArea()
176 methods).
177 */
178 double getPosX() const;
179 /** Set the new x position of the shape
180
181 The current x position of the shape is always relative
182 to the <em>center</em> of the shape (in contrast to
183 the Shape::getBounds() and Shape::getUpdateArea()
184 methods).
185 */
186 void setPosX( const double& rNewX );
187
188 /** Query whether the y position attribute is valid
189 */
190 bool isPosYValid() const;
191 /** Query the current y position of the shape
192
193 The current y position of the shape is always relative
194 to the <em>center</em> of the shape (in contrast to
195 the Shape::getBounds() and Shape::getUpdateArea()
196 methods).
197 */
198 double getPosY() const;
199 /** Set the new y position of the shape
200
201 The current y position of the shape is always relative
202 to the <em>center</em> of the shape (in contrast to
203 the Shape::getBounds() and Shape::getUpdateArea()
204 methods).
205 */
206 void setPosY( const double& rNewY );
207
208 /** Set the new position of the shape
209
210 The current position of the shape is always relative
211 to the <em>center</em> of the shape (in contrast to
212 the Shape::getBounds() and Shape::getUpdateArea()
213 methods).
214 */
215 void setPosition( const ::basegfx::B2DPoint& rNewPos );
216
217 /** Query whether the rotation angle attribute is valid
218 */
219 bool isRotationAngleValid() const;
220 /** Query the current rotation angle of the shape
221
222 @return the rotation angle in degrees.
223 */
224 double getRotationAngle() const;
225 /** Set the new rotation angle of the shape
226
227 @param rNewAngle
228 New rotation angle in degrees.
229 */
230 void setRotationAngle( const double& rNewAngle );
231
232 /** Query whether the shear x angle attribute is valid
233 */
234 bool isShearXAngleValid() const;
235 /** Query the current shear angle at the x axis of the shape
236
237 @return the shear angle in degrees.
238 */
239 double getShearXAngle() const;
240 /** Set the new shear angle at the x axis of the shape
241
242 @param rNewAngle
243 New shear angle in radians.
244 */
245 void setShearXAngle( const double& rNewAngle );
246
247 /** Query whether the shear y angle attribute is valid
248 */
249 bool isShearYAngleValid() const;
250 /** Query the current shear angle at the y axis of the shape
251
252 @return the shear angle in degrees.
253 */
254 double getShearYAngle() const;
255 /** Set the new shear angle at the y axis of the shape
256
257 @param rNewAngle
258 New shear angle in radians.
259 */
260 void setShearYAngle( const double& rNewAngle );
261
262 /** Query whether the alpha attribute is valid
263 */
264 bool isAlphaValid() const;
265 /** Query the current alpha value of the shape
266 */
267 double getAlpha() const;
268 /** Set the new alpha value of the shape
269
270 @param rNewValue
271 New alpha value, must be in the [0,1] range
272 */
273 void setAlpha( const double& rNewValue );
274
275 /** Query whether the clip attribute is valid
276 */
277 bool isClipValid() const;
278 /** Query the current clip polygon of the shape
279 */
280 ::basegfx::B2DPolyPolygon getClip() const;
281 /** Set the new clip polygon of the shape
282
283 @param rNewClip
284 New clip polygon, is interpreted in shape view coordinates, but
285 relative to the shape (i.e. the origin of the shape coincides
286 with the origin of the clip polygon).
287 */
288 void setClip( const ::basegfx::B2DPolyPolygon& rNewClip );
289
290 /** Query whether the dim color attribute is valid
291
292 The dim color globally 'dims' the shape towards that
293 color
294 */
295 bool isDimColorValid() const;
296 /** Get the dim color for the whole shape.
297 */
298 RGBColor getDimColor() const;
299 /** Set the dim color globally for the whole shape.
300 */
301 void setDimColor( const RGBColor& nNewColor );
302
303 /** Query whether the fill color attribute is valid
304 */
305 bool isFillColorValid() const;
306 /** Get the fill color for the whole shape.
307
308 If there's no unique fill color, the color from the
309 first filled polygon is returned.
310 */
311 RGBColor getFillColor() const;
312 /** Set the fill color globally for the whole shape.
313 */
314 void setFillColor( const RGBColor& nNewColor );
315
316 /** Query whether the line color attribute is valid
317 */
318 bool isLineColorValid() const;
319 /** Get the line color for the whole shape.
320
321 If there's no unique line color, the color from the
322 first line is returned.
323 */
324 RGBColor getLineColor() const;
325 /** Set the line color globally for the whole shape.
326 */
327 void setLineColor( const RGBColor& nNewColor );
328
329 /** Query whether the fill mode attribute is valid
330 */
331 bool isFillStyleValid() const;
332 /** Get the current fill mode for polygon fillings.
333
334 @returns the current style
335 */
336 sal_Int16 getFillStyle() const;
337 /** Changes polygon fillings.
338 */
339 void setFillStyle( const sal_Int16& rStyle );
340
341 /** Query whether the line mode attribute is valid
342 */
343 bool isLineStyleValid() const;
344 /** Get the current line mode for line drawing.
345
346 @returns the current line style
347 */
348 sal_Int16 getLineStyle() const;
349 /** Set line style for the whole shape
350 */
351 void setLineStyle( const sal_Int16& rStyle );
352
353 /** Query whether the visibility state attribute is valid
354 */
355 bool isVisibilityValid() const;
356 /** Get the current shape visibility.
357
358 @returns true for visible, false for invisible.
359 */
360 bool getVisibility() const;
361 /** Set the shape visibility
362 */
363 void setVisibility( const bool& bVisible );
364
365 /** Query whether the char color attribute is valid
366 */
367 bool isCharColorValid() const;
368 /** Get the text color for the whole shape.
369
370 If there's no unique text color, the color from the
371 first text drawn is returned.
372 */
373 RGBColor getCharColor() const;
374 /** Set the text color globally for the whole shape.
375 */
376 void setCharColor( const RGBColor& nNewColor );
377
378 /** Query whether the char rotation angle attribute is valid
379 */
380 bool isCharRotationAngleValid() const;
381 /** Query the current text rotation angle of the shape
382
383 @return the text rotation angle in degrees.
384 */
385 double getCharRotationAngle() const;
386 /** Set the new text rotation angle of the shape
387
388 @param rNewAngle
389 New text rotation angle in degrees.
390 */
391 void setCharRotationAngle( const double& rNewAngle );
392
393 /** Query whether the char weight attribute is valid
394 */
395 bool isCharWeightValid() const;
396 /** Get the current char weight value for the whole shape.
397
398 @returns the value for the char weight. The value must
399 be out of the css::awt::FontWeight
400 constant group.
401 */
402 double getCharWeight() const;
403 /** Set the char weight globally for the whole shape.
404
405 The value must be out of the
406 css::awt::FontWeight constant group.
407 */
408 void setCharWeight( const double& rStyle );
409
410 /** Query whether the underline mode attribute is valid
411 */
412 bool isUnderlineModeValid() const;
413 /** Get the current text underline status for the whole shape.
414
415 If there is no unique underline status, false is returned.
416
417 @returns true for underlined text, false for normal.
418 */
419 sal_Int16 getUnderlineMode() const;
420 /** Set the underline status globally for the whole shape
421 */
422 void setUnderlineMode( const sal_Int16& bUnderline );
423
424 /** Query whether the font family attribute is valid
425 */
426 bool isFontFamilyValid() const;
427 /** Get the current text font family for the whole shape.
428
429 If there is no unique font family, the font family of
430 the first text of the shape is returned.
431 */
432 OUString getFontFamily() const;
433 /** Set the text font family name globally for the whole shape
434 */
435 void setFontFamily( const OUString& rName );
436
437 /** Query whether the italic mode attribute is valid
438 */
439 bool isCharPostureValid() const;
440 /** Get the current text italic style for the whole shape.
441
442 @returns the italic style. The value returned is one
443 of the css::awt::FontSlant enums
444 */
445 sal_Int16 getCharPosture() const;
446 /** Set the italic style globally for the whole shape.
447
448 The value must be one of the
449 css::awt::FontSlant enums.
450 */
451 void setCharPosture( const sal_Int16& rStyle );
452
453 /** Query whether the char scaling attribute is valid
454 */
455 bool isCharScaleValid() const;
456 /** Query the current char scaling attribute globally for
457 the shape.
458
459 The char scaling changes the scale of the whole shape
460 text (uniformely, i.e. both in x and in y direction).
461 */
462 double getCharScale() const;
463 /** Set the new char scale globally for the shape
464
465 @param rNewScale
466 New char scale
467 */
468 void setCharScale( const double& rNewScale );
469
470 // State change query methods
471
472
473 State::StateId getTransformationState() const;
474 State::StateId getClipState() const;
475 State::StateId getAlphaState() const;
476 State::StateId getPositionState() const;
477 State::StateId getContentState() const;
478 State::StateId getVisibilityState() const;
479
480 private:
481 // default copy/assignment operator is okay
482 // ShapeAttributeLayer(const ShapeAttributeLayer&);
483 // ShapeAttributeLayer& operator=( const ShapeAttributeLayer& );
484
485 bool haveChild() const { return static_cast< bool >(mpChild); }
486 void updateStateIds();
487
488 template< typename T > T calcValue( const T& rCurrValue,
489 bool bThisInstanceValid,
490 bool (ShapeAttributeLayer::*pIsValid)() const,
491 T (ShapeAttributeLayer::*pGetValue)() const ) const;
492
493 ShapeAttributeLayerSharedPtr mpChild; // may be NULL
494
495 ::basegfx::B2DSize maSize;
496 ::basegfx::B2DPoint maPosition;
497 ::basegfx::B2DPolyPolygon maClip;
498
499 OUString maFontFamily;
500
501 double mnRotationAngle;
502 double mnShearXAngle;
503 double mnShearYAngle;
504 double mnAlpha;
505 double mnCharRotationAngle;
506 double mnCharScale;
507 double mnCharWeight;
508
509 css::drawing::FillStyle meFillStyle;
510 css::drawing::LineStyle meLineStyle;
511 css::awt::FontSlant meCharPosture;
512 sal_Int16 mnUnderlineMode;
513
514 RGBColor maDimColor;
515 RGBColor maFillColor;
516 RGBColor maLineColor;
517 RGBColor maCharColor;
518
519 State::StateId mnTransformationState;
520 State::StateId mnClipState;
521 State::StateId mnAlphaState;
522 State::StateId mnPositionState;
523 State::StateId mnContentState;
524 State::StateId mnVisibilityState;
525
526 sal_Int16 mnAdditiveMode;
527
528 bool mbVisibility : 1;
529
530 bool mbWidthValid : 1;
531 bool mbHeightValid : 1;
532 bool mbPosXValid : 1;
533 bool mbPosYValid : 1;
534 bool mbClipValid : 1;
535
536 bool mbFontFamilyValid : 1;
537
538 bool mbRotationAngleValid : 1;
539 bool mbShearXAngleValid : 1;
540 bool mbShearYAngleValid : 1;
541
542 bool mbAlphaValid : 1;
543
544 bool mbCharRotationAngleValid: 1;
545 bool mbCharScaleValid : 1;
546
547 bool mbDimColorValid : 1;
548 bool mbFillColorValid : 1;
549 bool mbLineColorValid : 1;
550 bool mbCharColorValid : 1;
551
552 bool mbFillStyleValid : 1;
553 bool mbLineStyleValid : 1;
554 bool mbCharWeightValid : 1;
555 bool mbUnderlineModeValid : 1;
556 bool mbCharPostureValid : 1;
557 bool mbVisibilityValid : 1;
558 };
559
560 }
561 }
562
563 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_SHAPEATTRIBUTELAYER_HXX
564
565 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
FREE OFFICE SUITE