1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/* -*- 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 .
*/
#ifndef INCLUDED_SVX_SDR_OVERLAY_OVERLAYOBJECT_HXX
#define INCLUDED_SVX_SDR_OVERLAY_OVERLAYOBJECT_HXX
#include <basegfx/point/b2dpoint.hxx>
#include <basegfx/range/b2drange.hxx>
#include <tools/color.hxx>
#include <svx/sdr/animation/scheduler.hxx>
#include <svx/svxdllapi.h>
#include <drawinglayer/primitive2d/Primitive2DContainer.hxx>
#include <vector>
class OutputDevice;
namespace sdr::overlay
{
class OverlayManager;
}
namespace basegfx
{
class B2DPolygon;
class B2DPolyPolygon;
class B2DRange;
}
namespace sdr::overlay
{
class SVXCORE_DLLPUBLIC OverlayObject : public sdr::animation::Event
{
private:
OverlayObject(const OverlayObject&) = delete;
OverlayObject& operator=(const OverlayObject&) = delete;
// Manager is allowed access to private Member mpOverlayManager
friend class OverlayManager;
// pointer to OverlayManager, if object is added. Changed by
// OverlayManager, do not change Yourself.
OverlayManager* mpOverlayManager;
// Primitive2DContainer of the OverlayObject
drawinglayer::primitive2d::Primitive2DContainer maPrimitive2DSequence;
// Possible Offset added to the geometry (automatically in
// createOverlayObjectPrimitive2DSequence()). Usually zero, may
// be used e.g. from calc when GridOffset is needed
basegfx::B2DVector maOffset;
protected:
// access methods to maPrimitive2DSequence. The usage of this methods may allow
// later thread-safe stuff to be added if needed. Only to be used by getPrimitive2DSequence()
// implementations for buffering the last decomposition.
// Resetting is allowed e.g. in ::getOverlayObjectPrimitive2DSequence() implementations
// if the conditions have changed to force a re-creation in calling the base implementation.
// The only allowed setter of maPrimitive2DSequence is
// OverlayObject::getOverlayObjectPrimitive2DSequence() which should be called by calling
// the base implementation in derived functions. That one will use the result of
// createOverlayObjectPrimitive2DSequence() to provide the geometry.
const drawinglayer::primitive2d::Primitive2DContainer& getPrimitive2DSequence() const { return maPrimitive2DSequence; }
void resetPrimitive2DSequence() { maPrimitive2DSequence.clear(); }
// the creation method for Primitive2DContainer. Called when getPrimitive2DSequence()
// sees that maPrimitive2DSequence is empty. Needs to be supported by all
// OverlayObject implementations. Default implementation will assert
// a missing implementation
virtual drawinglayer::primitive2d::Primitive2DContainer createOverlayObjectPrimitive2DSequence();
// #i53216# check blink time value range (currently 25 < mnBlinkTime < 10000)
static sal_uInt32 impCheckBlinkTimeValueRange(sal_uInt64 nBlinkTime);
// region in logical coordinates
basegfx::B2DRange maBaseRange;
// base color of this OverlayObject
Color maBaseColor;
// Flag for visibility
bool mbIsVisible : 1;
// Flag to control hittability
bool mbIsHittable : 1;
// Flag to hold info if this objects supports animation. Default is
// false. If true, the Trigger() method should be overridden
// to implement the animation effect and to re-initiate the event.
bool mbAllowsAnimation : 1;
// Flag to control if this OverlayObject allows AntiAliased visualisation.
// Default is true, but e.g. for selection visualisation in SC and SW,
// it is switched to false
bool mbAllowsAntiAliase : 1;
// In High Contrast mode all fg and bg are forced to a pair of normal
// high contrast colors. If this flag is set, then in High Contrast mode
// the colors are instead forced to the high contrast selection fg/bg pair.
// Default is false.
bool mbHighContrastSelection : 1;
// set changed flag. Call after change, since the old range is invalidated
// and then the new one is calculated and invalidated, too. This will only
// work after the change.
void objectChange();
// write access to AntiAliase flag. This is protected since
// only implementations are allowed to change this, preferably in their
// constructor
void allowAntiAliase(bool bNew);
public:
explicit OverlayObject(Color aBaseColor);
virtual ~OverlayObject() override;
// get OverlayManager
OverlayManager* getOverlayManager() const { return mpOverlayManager; }
// the access method for Primitive2DContainer. Will use createPrimitive2DSequence and
// setPrimitive2DSequence if needed. Overriding may be used to allow disposal of last
// created primitives to react on changed circumstances and to re-create primitives
virtual drawinglayer::primitive2d::Primitive2DContainer getOverlayObjectPrimitive2DSequence() const;
// access to visibility state
bool isVisible() const { return mbIsVisible; }
void setVisible(bool bNew);
// access to hittable flag
bool isHittable() const { return mbIsHittable; }
void setHittable(bool bNew);
// read access to AntiAliase flag
bool allowsAntiAliase() const { return mbAllowsAntiAliase; }
// read access to DrawModeSettings flag
bool isHighContrastSelection() const { return mbHighContrastSelection; }
// read access to baseRange. This may trigger createBaseRange() if
// object is changed.
const basegfx::B2DRange& getBaseRange() const;
// access to baseColor
const Color& getBaseColor() const { return maBaseColor; }
void setBaseColor(Color aNew);
// access to Offset
const basegfx::B2DVector& getOffset() const { return maOffset; }
void setOffset(const basegfx::B2DVector& rOffset);
// execute event from base class sdr::animation::Event. Default
// implementation does nothing and does not create a new event.
virtual void Trigger(sal_uInt32 nTime) override;
// access to AllowsAnimation flag
bool allowsAnimation() const { return mbAllowsAnimation; }
// stripe definition has changed. The OverlayManager does have
// support data to draw graphics in two colors striped. This
// method notifies the OverlayObject if that change takes place.
// Default implementation does nothing.
virtual void stripeDefinitionHasChanged();
};
// typedefs for a vector of OverlayObjects
typedef ::std::vector< OverlayObject* > OverlayObjectVector;
} // end of namespace sdr::overlay
namespace sdr::overlay
{
class SVXCORE_DLLPUBLIC OverlayObjectWithBasePosition : public OverlayObject
{
protected:
// base position in logical coordinates
basegfx::B2DPoint maBasePosition;
public:
OverlayObjectWithBasePosition(const basegfx::B2DPoint& rBasePos, Color aBaseColor);
virtual ~OverlayObjectWithBasePosition() override;
// access to basePosition
const basegfx::B2DPoint& getBasePosition() const { return maBasePosition; }
void setBasePosition(const basegfx::B2DPoint& rNew);
};
} // end of namespace sdr::overlay
#endif // INCLUDED_SVX_SDR_OVERLAY_OVERLAYOBJECT_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
