MWAWGraphicStyle.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2
3/* libmwaw
4* Version: MPL 2.0 / LGPLv2+
5*
6* The contents of this file are subject to the Mozilla Public License Version
7* 2.0 (the "License"); you may not use this file except in compliance with
8* the License or as specified alternatively below. You may obtain a copy of
9* the License at http://www.mozilla.org/MPL/
10*
11* Software distributed under the License is distributed on an "AS IS" basis,
12* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13* for the specific language governing rights and limitations under the
14* License.
15*
16* Major Contributor(s):
17* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20* Copyright (C) 2006, 2007 Andrew Ziem
21* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22*
23*
24* All Rights Reserved.
25*
26* For minor contributions see the git repository.
27*
28* Alternatively, the contents of this file may be used under the terms of
29* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30* in which case the provisions of the LGPLv2+ are applicable
31* instead of those above.
32*/
33#ifndef MWAW_GRAPHIC_STYLE
34# define MWAW_GRAPHIC_STYLE
35# include <ostream>
36# include <string>
37# include <vector>
38
39# include "librevenge/librevenge.h"
40# include "libmwaw_internal.hxx"
41
48{
49public:
56
58 struct Arrow {
60 Arrow() : m_viewBox(), m_path(""), m_width(0), m_isCentered(false)
61 {
62 }
64 Arrow(float w, MWAWBox2i const &box, std::string path, bool centered=false) :
65 m_viewBox(box), m_path(path), m_width(w), m_isCentered(centered)
66 {
67 }
69 static Arrow plain()
70 {
71 return Arrow(5, MWAWBox2i(MWAWVec2i(0,0),MWAWVec2i(20,30)), "m10 0-10 30h20z", false);
72 }
74 friend std::ostream &operator<<(std::ostream &o, Arrow const &arrow)
75 {
76 if (arrow.isEmpty()) return o;
77 o << "w=" << arrow.m_width << ",";
78 o << "viewbox=" << arrow.m_viewBox << ",";
79 o << "path=" << arrow.m_path << ",";
80 if (arrow.m_isCentered) o << "centered,";
81 return o;
82 }
84 bool operator==(Arrow const &arrow) const
85 {
86 return m_width>=arrow.m_width && m_width<=arrow.m_width &&
87 m_viewBox==arrow.m_viewBox && m_path==arrow.m_path && m_isCentered==arrow.m_isCentered;
88 }
90 bool operator!=(Arrow const &arrow) const
91 {
92 return !(*this==arrow);
93 }
95 bool operator<(Arrow const &arrow) const
96 {
97 if (m_isCentered<arrow.m_isCentered) return m_isCentered ? true : false;
98 return m_width<arrow.m_width && m_viewBox<arrow.m_viewBox && m_path < arrow.m_path;
99 }
101 bool operator<=(Arrow const &arrow) const
102 {
103 return *this<arrow || *this==arrow;
104 }
106 bool operator>(Arrow const &arrow) const
107 {
108 return !(*this<=arrow);
109 }
111 bool operator>=(Arrow const &arrow) const
112 {
113 return !(*this<arrow);
114 }
116 bool isEmpty() const
117 {
118 return m_width<=0 || m_path.empty();
119 }
121 void addTo(librevenge::RVNGPropertyList &propList, std::string const &type) const;
122
126 std::string m_path;
128 float m_width;
131 };
132
136 GradientStop(float offset=0.0, MWAWColor const &col=MWAWColor::black(), float opacity=1.0) :
137 m_offset(offset), m_color(col), m_opacity(opacity)
138 {
139 }
141 int cmp(GradientStop const &a) const
142 {
143 if (m_offset < a.m_offset) return -1;
144 if (m_offset > a.m_offset) return 1;
145 if (m_color < a.m_color) return -1;
146 if (m_color > a.m_color) return 1;
147 if (m_opacity < a.m_opacity) return -1;
148 if (m_opacity > a.m_opacity) return 1;
149 return 0;
150 }
152 friend std::ostream &operator<<(std::ostream &o, GradientStop const &st)
153 {
154 o << "offset=" << st.m_offset << ",";
155 o << "color=" << st.m_color << ",";
156 if (st.m_opacity<1)
157 o << "opacity=" << st.m_opacity*100.f << "%,";
158 return o;
159 }
161 float m_offset;
166 };
171 struct Pattern {
174 {
177 }
179 Pattern(MWAWVec2i dim, MWAWEmbeddedObject const &picture, MWAWColor const &avColor) :
180 m_dim(dim), m_data(), m_picture(picture), m_pictureAverageColor(avColor)
181 {
184 }
186 virtual ~Pattern();
188 bool empty() const
189 {
190 if (m_dim[0]==0 || m_dim[1]==0) return true;
191 if (!m_picture.m_dataList.empty()) return false;
192 if (m_dim[0]!=8 && m_dim[0]!=16 && m_dim[0]!=32) return true;
193 return m_data.size()!=size_t((m_dim[0]/8)*m_dim[1]);
194 }
196 bool getAverageColor(MWAWColor &col) const;
198 bool getUniqueColor(MWAWColor &col) const;
200 bool getBinary(MWAWEmbeddedObject &picture) const;
201
203 int cmp(Pattern const &a) const
204 {
205 int diff = m_dim.cmp(a.m_dim);
206 if (diff) return diff;
207 if (m_data.size() < a.m_data.size()) return -1;
208 if (m_data.size() > a.m_data.size()) return 1;
209 for (size_t h=0; h < m_data.size(); ++h) {
210 if (m_data[h]<a.m_data[h]) return 1;
211 if (m_data[h]>a.m_data[h]) return -1;
212 }
213 for (int i=0; i<2; ++i) {
214 if (m_colors[i] < a.m_colors[i]) return 1;
215 if (m_colors[i] > a.m_colors[i]) return -1;
216 }
219 diff=m_picture.cmp(a.m_picture);
220 if (diff) return diff;
221 return 0;
222 }
224 friend std::ostream &operator<<(std::ostream &o, Pattern const &pat)
225 {
226 o << "dim=" << pat.m_dim << ",";
227 if (!pat.m_picture.isEmpty()) {
228 o << "pict=" << pat.m_picture << ",";
229 o << "col[average]=" << pat.m_pictureAverageColor << ",";
230 }
231 else {
232 if (!pat.m_colors[0].isBlack()) o << "col0=" << pat.m_colors[0] << ",";
233 if (!pat.m_colors[1].isWhite()) o << "col1=" << pat.m_colors[1] << ",";
234 o << "[";
235 for (size_t h=0; h < pat.m_data.size(); ++h)
236 o << std::hex << static_cast<int>(pat.m_data[h]) << std::dec << ",";
237 o << "],";
238 }
239 return o;
240 }
243
247 std::vector<unsigned char> m_data;
248 protected:
253 };
261 {
262 m_arrows[0]=m_arrows[1]=Arrow();
263 m_flip[0]=m_flip[1]=false;
266 }
269 {
271 res.m_lineWidth=0;
272 return res;
273 }
275 virtual ~MWAWGraphicStyle();
277 bool hasLine() const
278 {
279 return m_lineWidth>0 && m_lineOpacity>0;
280 }
282 void setSurfaceColor(MWAWColor const &col, float opacity = 1)
283 {
284 m_surfaceColor = col;
285 m_surfaceOpacity = opacity;
286 }
288 bool hasSurfaceColor() const
289 {
290 return m_surfaceOpacity > 0;
291 }
293 void setPattern(Pattern const &pat, float opacity = 1)
294 {
295 m_pattern=pat;
296 m_surfaceOpacity = opacity;
297 }
299 bool hasPattern() const
300 {
301 return !m_pattern.empty() && m_surfaceOpacity > 0;
302 }
304 bool hasGradient(bool complex=false) const
305 {
306 return m_gradientType != G_None && static_cast<int>(m_gradientStopList.size()) >= (complex ? 3 : 2);
307 }
309 bool hasSurface() const
310 {
311 return hasSurfaceColor() || hasPattern() || hasGradient();
312 }
314 void setBackgroundColor(MWAWColor const &col, float opacity = 1)
315 {
316 m_backgroundColor = col;
317 m_backgroundOpacity = opacity;
318 }
321 {
322 return m_backgroundOpacity > 0;
323 }
325 void setShadowColor(MWAWColor const &col, float opacity = 1)
326 {
327 m_shadowColor = col;
328 m_shadowOpacity = opacity;
329 }
331 bool hasShadow() const
332 {
333 return m_shadowOpacity > 0;
334 }
336 bool hasBorders() const
337 {
338 return !m_bordersList.empty();
339 }
341 bool hasSameBorders() const
342 {
343 if (m_bordersList.empty()) return true;
344 if (m_bordersList.size()!=4) return false;
345 for (size_t i=1; i<m_bordersList.size(); ++i) {
346 if (m_bordersList[i]!=m_bordersList[0])
347 return false;
348 }
349 return true;
350 }
352 std::vector<MWAWBorder> const &borders() const
353 {
354 return m_bordersList;
355 }
358 {
359 m_bordersList.resize(0);
360 }
362 void setBorders(int wh, MWAWBorder const &border);
364 friend std::ostream &operator<<(std::ostream &o, MWAWGraphicStyle const &st);
366 void addTo(librevenge::RVNGPropertyList &pList, bool only1d=false) const;
368 void addFrameTo(librevenge::RVNGPropertyList &pList) const;
370 int cmp(MWAWGraphicStyle const &a) const;
371
373 std::vector<float> m_lineDashWidth;
388
397
400
402 std::vector<GradientStop> m_gradientStopList;
411
412 //
413 // related to the frame
414 //
415
421 float m_rotate;
423 std::vector<MWAWBorder> m_bordersList;
425 std::string m_frameName;
427 std::string m_frameNextName;
428
431
432 //
433 // some transformation: must probably be somewhere else
434 //
435
437 bool m_flip[2];
438
442 std::string m_extra;
443};
444#endif
445// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
a structure used to define a picture style
Definition: MWAWGraphicStyle.hxx:48
void setShadowColor(MWAWColor const &col, float opacity=1)
set the shadow color
Definition: MWAWGraphicStyle.hxx:325
float m_gradientAngle
the gradient angle
Definition: MWAWGraphicStyle.hxx:404
std::vector< MWAWBorder > m_bordersList
the borders MWAWBorder::Pos (for a frame)
Definition: MWAWGraphicStyle.hxx:423
MWAWVec2f m_shadowOffset
the shadow offset
Definition: MWAWGraphicStyle.hxx:394
friend std::ostream & operator<<(std::ostream &o, MWAWGraphicStyle const &st)
a print operator
Definition: MWAWGraphicStyle.cxx:502
bool m_fillRuleEvenOdd
true if the fill rule is evenod
Definition: MWAWGraphicStyle.hxx:440
float m_rotate
the rotation
Definition: MWAWGraphicStyle.hxx:421
bool hasBackgroundColor() const
returns true if the background is defined
Definition: MWAWGraphicStyle.hxx:320
bool hasSurfaceColor() const
returns true if the surface is defined
Definition: MWAWGraphicStyle.hxx:288
std::string m_frameNextName
the frame next name (if there is a link)
Definition: MWAWGraphicStyle.hxx:427
void addFrameTo(librevenge::RVNGPropertyList &pList) const
add all the frame parameters to propList: the background and the borders
Definition: MWAWGraphicStyle.cxx:370
int cmp(MWAWGraphicStyle const &a) const
compare two styles
Definition: MWAWGraphicStyle.cxx:418
MWAWColor m_surfaceColor
the surface color
Definition: MWAWGraphicStyle.hxx:385
float m_shadowOpacity
true if the shadow has some color
Definition: MWAWGraphicStyle.hxx:392
float m_lineWidth
the linewidth
Definition: MWAWGraphicStyle.hxx:375
bool hasSurface() const
returns true if the interior surface is defined
Definition: MWAWGraphicStyle.hxx:309
GradientType
an enum used to define the gradient type
Definition: MWAWGraphicStyle.hxx:55
@ G_Square
Definition: MWAWGraphicStyle.hxx:55
@ G_Linear
Definition: MWAWGraphicStyle.hxx:55
@ G_Ellipsoid
Definition: MWAWGraphicStyle.hxx:55
@ G_Axial
Definition: MWAWGraphicStyle.hxx:55
@ G_Radial
Definition: MWAWGraphicStyle.hxx:55
@ G_Rectangular
Definition: MWAWGraphicStyle.hxx:55
@ G_None
Definition: MWAWGraphicStyle.hxx:55
MWAWVec2f m_gradientPercentCenter
the gradient center
Definition: MWAWGraphicStyle.hxx:408
MWAWColor m_backgroundColor
the background color
Definition: MWAWGraphicStyle.hxx:417
void setBorders(int wh, MWAWBorder const &border)
sets the cell border: wh=libmwaw::LeftBit|...
Definition: MWAWGraphicStyle.cxx:172
std::string m_frameName
the frame name
Definition: MWAWGraphicStyle.hxx:425
MWAWColor m_shadowColor
the shadow color
Definition: MWAWGraphicStyle.hxx:390
std::string m_extra
extra data
Definition: MWAWGraphicStyle.hxx:442
bool hasShadow() const
returns true if the shadow is defined
Definition: MWAWGraphicStyle.hxx:331
std::vector< GradientStop > m_gradientStopList
the list of gradient limits
Definition: MWAWGraphicStyle.hxx:402
static MWAWGraphicStyle emptyStyle()
returns an empty style.
Definition: MWAWGraphicStyle.hxx:268
MWAWGraphicStyle()
constructor
Definition: MWAWGraphicStyle.hxx:255
float m_lineOpacity
the line opacity: 0=transparent
Definition: MWAWGraphicStyle.hxx:381
bool hasGradient(bool complex=false) const
returns true if the gradient is defined
Definition: MWAWGraphicStyle.hxx:304
void setBackgroundColor(MWAWColor const &col, float opacity=1)
set the background color
Definition: MWAWGraphicStyle.hxx:314
float m_gradientBorder
the gradient border opacity
Definition: MWAWGraphicStyle.hxx:406
bool hasLine() const
returns true if the border is defined
Definition: MWAWGraphicStyle.hxx:277
float m_surfaceOpacity
true if the surface has some color
Definition: MWAWGraphicStyle.hxx:387
GradientType m_gradientType
the gradient type
Definition: MWAWGraphicStyle.hxx:396
float m_backgroundOpacity
true if the background has some color
Definition: MWAWGraphicStyle.hxx:419
bool m_flip[2]
two bool to indicated we need to flip the shape or not
Definition: MWAWGraphicStyle.hxx:437
LineCap
an enum used to define the basic line cap
Definition: MWAWGraphicStyle.hxx:51
@ C_Round
Definition: MWAWGraphicStyle.hxx:51
@ C_Butt
Definition: MWAWGraphicStyle.hxx:51
@ C_Square
Definition: MWAWGraphicStyle.hxx:51
std::vector< float > m_lineDashWidth
the dash array: a sequence of (fullsize, emptysize)
Definition: MWAWGraphicStyle.hxx:373
Pattern m_pattern
the pattern if it exists
Definition: MWAWGraphicStyle.hxx:399
MWAWColor m_lineColor
the line color
Definition: MWAWGraphicStyle.hxx:383
bool hasBorders() const
return true if the frame has some border
Definition: MWAWGraphicStyle.hxx:336
void setSurfaceColor(MWAWColor const &col, float opacity=1)
set the surface color
Definition: MWAWGraphicStyle.hxx:282
float m_gradientRadius
the gradient radius
Definition: MWAWGraphicStyle.hxx:410
virtual ~MWAWGraphicStyle()
virtual destructor
Definition: MWAWGraphicStyle.cxx:168
bool hasPattern() const
returns true if the pattern is defined
Definition: MWAWGraphicStyle.hxx:299
std::vector< MWAWBorder > const & borders() const
return the frame border: libmwaw::Left | ...
Definition: MWAWGraphicStyle.hxx:352
void resetBorders()
reset the border
Definition: MWAWGraphicStyle.hxx:357
bool hasSameBorders() const
return true if the frame has some border
Definition: MWAWGraphicStyle.hxx:341
Arrow m_arrows[2]
the two arrows corresponding to start and end extremity
Definition: MWAWGraphicStyle.hxx:430
LineJoin
an enum used to define the basic line join
Definition: MWAWGraphicStyle.hxx:53
@ J_Bevel
Definition: MWAWGraphicStyle.hxx:53
@ J_Miter
Definition: MWAWGraphicStyle.hxx:53
@ J_Round
Definition: MWAWGraphicStyle.hxx:53
void addTo(librevenge::RVNGPropertyList &pList, bool only1d=false) const
add all the parameters to the propList excepted the frame parameter: the background and the borders
Definition: MWAWGraphicStyle.cxx:191
LineCap m_lineCap
the line cap
Definition: MWAWGraphicStyle.hxx:377
LineJoin m_lineJoin
the line join
Definition: MWAWGraphicStyle.hxx:379
void setPattern(Pattern const &pat, float opacity=1)
set the pattern
Definition: MWAWGraphicStyle.hxx:293
int cmp(MWAWVec2< T > const &p) const
a comparison function: which first compares x then y
Definition: libmwaw_internal.hxx:720
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition: libmwaw_internal.hxx:781
MWAWBox2< int > MWAWBox2i
MWAWBox2 of int.
Definition: libmwaw_internal.hxx:1132
a border
Definition: libmwaw_internal.hxx:314
the class to store a color
Definition: libmwaw_internal.hxx:182
static MWAWColor black()
return the back color
Definition: libmwaw_internal.hxx:226
bool isWhite() const
return true if the color is white
Definition: libmwaw_internal.hxx:270
static MWAWColor white()
return the white color
Definition: libmwaw_internal.hxx:231
bool isBlack() const
return true if the color is black
Definition: libmwaw_internal.hxx:265
small class use to define a embedded object
Definition: libmwaw_internal.hxx:425
int cmp(MWAWEmbeddedObject const &pict) const
a comparison function
Definition: libmwaw_internal.cxx:595
bool isEmpty() const
return true if the picture contains no data
Definition: libmwaw_internal.hxx:439
std::vector< librevenge::RVNGBinaryData > m_dataList
the picture content: one data by representation
Definition: libmwaw_internal.hxx:465
a structure used to define an arrow
Definition: MWAWGraphicStyle.hxx:58
Arrow(float w, MWAWBox2i const &box, std::string path, bool centered=false)
constructor
Definition: MWAWGraphicStyle.hxx:64
void addTo(librevenge::RVNGPropertyList &propList, std::string const &type) const
add a arrow to the propList knowing the type (start, end)
Definition: MWAWGraphicStyle.cxx:56
std::string m_path
the arrow path
Definition: MWAWGraphicStyle.hxx:126
bool m_isCentered
flag to know if the arrow is centered
Definition: MWAWGraphicStyle.hxx:130
static Arrow plain()
returns a basic plain arrow
Definition: MWAWGraphicStyle.hxx:69
bool operator>(Arrow const &arrow) const
operator>
Definition: MWAWGraphicStyle.hxx:106
float m_width
the arrow width in point
Definition: MWAWGraphicStyle.hxx:128
bool operator!=(Arrow const &arrow) const
operator!=
Definition: MWAWGraphicStyle.hxx:90
bool operator>=(Arrow const &arrow) const
operator>=
Definition: MWAWGraphicStyle.hxx:111
bool operator<=(Arrow const &arrow) const
operator<=
Definition: MWAWGraphicStyle.hxx:101
friend std::ostream & operator<<(std::ostream &o, Arrow const &arrow)
operator<<
Definition: MWAWGraphicStyle.hxx:74
bool isEmpty() const
returns true if there is no arrow
Definition: MWAWGraphicStyle.hxx:116
bool operator<(Arrow const &arrow) const
operator<
Definition: MWAWGraphicStyle.hxx:95
bool operator==(Arrow const &arrow) const
operator==
Definition: MWAWGraphicStyle.hxx:84
MWAWBox2i m_viewBox
the arrow viewbox
Definition: MWAWGraphicStyle.hxx:124
Arrow()
constructor ( no arrow)
Definition: MWAWGraphicStyle.hxx:60
a structure used to define the gradient limit in MWAWGraphicStyle
Definition: MWAWGraphicStyle.hxx:134
int cmp(GradientStop const &a) const
compare two gradient
Definition: MWAWGraphicStyle.hxx:141
friend std::ostream & operator<<(std::ostream &o, GradientStop const &st)
a print operator
Definition: MWAWGraphicStyle.hxx:152
float m_offset
the offset
Definition: MWAWGraphicStyle.hxx:161
float m_opacity
the opacity
Definition: MWAWGraphicStyle.hxx:165
GradientStop(float offset=0.0, MWAWColor const &col=MWAWColor::black(), float opacity=1.0)
constructor
Definition: MWAWGraphicStyle.hxx:136
MWAWColor m_color
the color
Definition: MWAWGraphicStyle.hxx:163
a basic pattern used in a MWAWGraphicStyle:
Definition: MWAWGraphicStyle.hxx:171
MWAWColor m_colors[2]
the two indexed colors
Definition: MWAWGraphicStyle.hxx:245
Pattern()
constructor
Definition: MWAWGraphicStyle.hxx:173
MWAWVec2i m_dim
the dimension width x height
Definition: MWAWGraphicStyle.hxx:242
friend std::ostream & operator<<(std::ostream &o, Pattern const &pat)
a print operator
Definition: MWAWGraphicStyle.hxx:224
bool getAverageColor(MWAWColor &col) const
return the average color
Definition: MWAWGraphicStyle.cxx:101
Pattern(MWAWVec2i dim, MWAWEmbeddedObject const &picture, MWAWColor const &avColor)
constructor from a binary data
Definition: MWAWGraphicStyle.hxx:179
std::vector< unsigned char > m_data
the pattern data: a sequence of data: p[0..7,0],p[8..15,0]...p[0..7,1],p[8..15,1],...
Definition: MWAWGraphicStyle.hxx:247
MWAWColor m_pictureAverageColor
the picture average color
Definition: MWAWGraphicStyle.hxx:252
bool getUniqueColor(MWAWColor &col) const
check if the pattern has only one color; if so returns true...
Definition: MWAWGraphicStyle.cxx:86
int cmp(Pattern const &a) const
compare two patterns
Definition: MWAWGraphicStyle.hxx:203
bool getBinary(MWAWEmbeddedObject &picture) const
tries to convert the picture in a binary data ( ppm)
Definition: MWAWGraphicStyle.cxx:128
virtual ~Pattern()
virtual destructor
Definition: MWAWGraphicStyle.cxx:82
MWAWEmbeddedObject m_picture
a picture
Definition: MWAWGraphicStyle.hxx:250
bool empty() const
return true if we does not have a pattern
Definition: MWAWGraphicStyle.hxx:188

Generated on Wed Jan 19 2022 22:23:16 for libmwaw by doxygen 1.9.3