WPSGraphicStyle.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 
3 /* libwps
4  * Version: MPL 2.0 / LGPLv2.1+
5  *
6  * This Source Code Form is subject to the terms of the Mozilla Public
7  * License, v. 2.0. If a copy of the MPL was not distributed with this
8  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9  *
10  * Major Contributor(s):
11  * Copyright (C) 2002, 2005 William Lachance (william.lachance@sympatico.ca)
12  * Copyright (C) 2002, 2004 Marc Maurer (uwog@uwog.net)
13  *
14  * For minor contributions see the git repository.
15  *
16  * Alternatively, the contents of this file may be used under the terms
17  * of the GNU Lesser General Public License Version 2.1 or later
18  * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
19  * applicable instead of those above.
20  *
21  * For further information visit http://libwps.sourceforge.net
22 */
23 #ifndef WPS_GRAPHIC_STYLE
24 # define WPS_GRAPHIC_STYLE
25 # include <ostream>
26 # include <string>
27 # include <vector>
28 
29 # include "librevenge/librevenge.h"
30 # include "libwps_internal.h"
31 
38 {
39 public:
46 
48  struct GradientStop
49  {
51  GradientStop(float offset=0.0, WPSColor const &col=WPSColor::black(), float opacity=1.0)
52  : m_offset(offset)
53  , m_color(col)
54  , m_opacity(opacity)
55  {
56  }
58  int cmp(GradientStop const &a) const
59  {
60  if (m_offset < a.m_offset) return -1;
61  if (m_offset > a.m_offset) return 1;
62  if (m_color < a.m_color) return -1;
63  if (m_color > a.m_color) return 1;
64  if (m_opacity < a.m_opacity) return -1;
65  if (m_opacity > a.m_opacity) return 1;
66  return 0;
67  }
69  friend std::ostream &operator<<(std::ostream &o, GradientStop const &st)
70  {
71  o << "offset=" << st.m_offset << ",";
72  o << "color=" << st.m_color << ",";
73  if (st.m_opacity<1.0f)
74  o << "opacity=" << st.m_opacity*100.f << "%,";
75  return o;
76  }
78  float m_offset;
82  float m_opacity;
83  };
88  struct Pattern
89  {
92  : m_dim(0,0)
93  , m_data()
94  , m_picture()
95  , m_pictureMime("")
97  {
100  }
102  Pattern(Vec2i dim, librevenge::RVNGBinaryData const &picture, std::string const &mime, WPSColor const &avColor)
103  : m_dim(dim)
104  , m_data()
105  , m_picture(picture)
106  , m_pictureMime(mime)
107  , m_pictureAverageColor(avColor)
108  {
111  }
112  Pattern(Pattern const &)=default;
113  Pattern(Pattern &&)=default;
115  virtual ~Pattern();
117  bool empty() const
118  {
119  if (m_dim[0]==0 || m_dim[1]==0) return true;
120  if (m_picture.size()) return false;
121  if (m_dim[0]!=8 && m_dim[0]!=16 && m_dim[0]!=32) return true;
122  return m_data.size()!=size_t((m_dim[0]/8)*m_dim[1]);
123  }
125  bool getAverageColor(WPSColor &col) const;
127  bool getUniqueColor(WPSColor &col) const;
129  bool getBinary(librevenge::RVNGBinaryData &data, std::string &type) const;
130 
132  int cmp(Pattern const &a) const
133  {
134  int diff = m_dim.cmp(a.m_dim);
135  if (diff) return diff;
136  if (m_data.size() < a.m_data.size()) return -1;
137  if (m_data.size() > a.m_data.size()) return 1;
138  for (size_t h=0; h < m_data.size(); ++h)
139  {
140  if (m_data[h]<a.m_data[h]) return 1;
141  if (m_data[h]>a.m_data[h]) return -1;
142  }
143  for (int i=0; i<2; ++i)
144  {
145  if (m_colors[i] < a.m_colors[i]) return 1;
146  if (m_colors[i] > a.m_colors[i]) return -1;
147  }
149  if (m_pictureAverageColor > a.m_pictureAverageColor) return -1;
150  if (m_pictureMime < a.m_pictureMime) return 1;
151  if (m_pictureMime > a.m_pictureMime) return -1;
152  if (m_picture.size() < a.m_picture.size()) return 1;
153  if (m_picture.size() > a.m_picture.size()) return -1;
154  const unsigned char *ptr=m_picture.getDataBuffer();
155  const unsigned char *aPtr=a.m_picture.getDataBuffer();
156  if (!ptr || !aPtr) return 0; // must only appear if the two buffers are empty
157  for (unsigned long h=0; h < m_picture.size(); ++h, ++ptr, ++aPtr)
158  {
159  if (*ptr < *aPtr) return 1;
160  if (*ptr > *aPtr) return -1;
161  }
162  return 0;
163  }
165  friend std::ostream &operator<<(std::ostream &o, Pattern const &pat)
166  {
167  o << "dim=" << pat.m_dim << ",";
168  if (pat.m_picture.size())
169  {
170  o << "type=" << pat.m_pictureMime << ",";
171  o << "col[average]=" << pat.m_pictureAverageColor << ",";
172  }
173  else
174  {
175  if (!pat.m_colors[0].isBlack()) o << "col0=" << pat.m_colors[0] << ",";
176  if (!pat.m_colors[1].isWhite()) o << "col1=" << pat.m_colors[1] << ",";
177  o << "[";
178  for (auto const &data : pat.m_data)
179  o << std::hex << int(data) << std::dec << ",";
180  o << "],";
181  }
182  return o;
183  }
185  Pattern &operator=(Pattern const &)=default;
188 
192  std::vector<unsigned char> m_data;
193  protected:
195  librevenge::RVNGBinaryData m_picture;
197  std::string m_pictureMime;
200  };
203  : m_lineWidth(1)
204  , m_lineDashWidth()
205  , m_lineCap(C_Butt)
207  , m_lineOpacity(1)
208  , m_lineColor(WPSColor::black())
209  , m_fillRuleEvenOdd(false)
210  , m_surfaceColor(WPSColor::white())
211  , m_surfaceOpacity(0)
212  , m_shadowColor(WPSColor::black())
213  , m_shadowOpacity(0)
214  , m_shadowOffset(1,1)
215  , m_pattern()
218  , m_gradientAngle(0)
219  , m_gradientBorder(0)
220  , m_gradientPercentCenter(0.5f,0.5f)
221  , m_gradientRadius(1)
222  , m_backgroundColor(WPSColor::white())
223  , m_backgroundOpacity(-1)
224  , m_bordersList()
225  , m_frameName("")
226  , m_frameNextName("")
227  , m_rotate(0)
228  , m_extra("")
229  {
230  m_arrows[0]=m_arrows[1]=false;
231  m_flip[0]=m_flip[1]=false;
234  }
235  WPSGraphicStyle(WPSGraphicStyle const &)=default;
236  WPSGraphicStyle(WPSGraphicStyle &&)=default;
238  WPSGraphicStyle &operator=(WPSGraphicStyle const &)=default;
241  {
242  WPSGraphicStyle res;
243  res.m_lineWidth=0;
244  return res;
245  }
247  virtual ~WPSGraphicStyle();
249  bool hasLine() const
250  {
251  return m_lineWidth>0 && m_lineOpacity>0;
252  }
254  void setSurfaceColor(WPSColor const &col, float opacity = 1)
255  {
256  m_surfaceColor = col;
257  m_surfaceOpacity = opacity;
258  }
260  bool hasSurfaceColor() const
261  {
262  return m_surfaceOpacity > 0;
263  }
265  void setPattern(Pattern const &pat)
266  {
267  m_pattern=pat;
268  }
270  bool hasPattern() const
271  {
272  return !m_pattern.empty();
273  }
275  bool hasGradient(bool complex=false) const
276  {
277  return m_gradientType != G_None && int(m_gradientStopList.size()) >= (complex ? 3 : 2);
278  }
280  bool hasSurface() const
281  {
282  return hasSurfaceColor() || hasPattern() || hasGradient();
283  }
285  void setBackgroundColor(WPSColor const &col, float opacity = 1)
286  {
287  m_backgroundColor = col;
288  m_backgroundOpacity = opacity;
289  }
291  bool hasBackgroundColor() const
292  {
293  return m_backgroundOpacity > 0;
294  }
296  void setShadowColor(WPSColor const &col, float opacity = 1)
297  {
298  m_shadowColor = col;
299  m_shadowOpacity = opacity;
300  }
302  bool hasShadow() const
303  {
304  return m_shadowOpacity > 0;
305  }
307  bool hasBorders() const
308  {
309  return !m_bordersList.empty();
310  }
312  bool hasSameBorders() const
313  {
314  if (m_bordersList.empty()) return true;
315  if (m_bordersList.size()!=4) return false;
316  for (size_t i=1; i<m_bordersList.size(); ++i)
317  {
318  if (m_bordersList[i]!=m_bordersList[0])
319  return false;
320  }
321  return true;
322  }
324  std::vector<WPSBorder> const &borders() const
325  {
326  return m_bordersList;
327  }
330  {
331  m_bordersList.resize(0);
332  }
334  void setBorders(int wh, WPSBorder const &border);
336  friend std::ostream &operator<<(std::ostream &o, WPSGraphicStyle const &st);
338  void addTo(librevenge::RVNGPropertyList &pList, bool only1d=false) const;
340  void addFrameTo(librevenge::RVNGPropertyList &pList) const;
342  int cmp(WPSGraphicStyle const &a) const;
343 
345  float m_lineWidth;
347  std::vector<float> m_lineDashWidth;
362 
369 
372 
376  std::vector<GradientStop> m_gradientStopList;
385 
387  bool m_arrows[2];
388 
389  //
390  // related to the frame
391  //
392 
398  std::vector<WPSBorder> m_bordersList;
400  librevenge::RVNGString m_frameName;
402  librevenge::RVNGString m_frameNextName;
403 
404  //
405  // some transformation: must probably be somewhere else
406  //
407 
409  float m_rotate;
411  bool m_flip[2];
412 
414  std::string m_extra;
415 };
416 #endif
417 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
bool m_flip[2]
two bool to indicated we need to flip the shape or not
Definition: WPSGraphicStyle.h:411
a structure used to define the gradient limit
Definition: WPSGraphicStyle.h:48
std::string m_pictureMime
the picture type
Definition: WPSGraphicStyle.h:197
bool hasGradient(bool complex=false) const
returns true if the gradient is defined
Definition: WPSGraphicStyle.h:275
bool hasSurface() const
returns true if the interior surface is defined
Definition: WPSGraphicStyle.h:280
bool getBinary(librevenge::RVNGBinaryData &data, std::string &type) const
tries to convert the picture in a binary data ( ppm)
Definition: WPSGraphicStyle.cpp:92
Vec2f m_shadowOffset
the shadow offset
Definition: WPSGraphicStyle.h:368
a border list
Definition: libwps_internal.h:394
float m_surfaceOpacity
true if the surface has some color
Definition: WPSGraphicStyle.h:361
librevenge::RVNGString m_frameName
the frame name
Definition: WPSGraphicStyle.h:400
Definition: WPSGraphicStyle.h:45
Pattern & operator=(Pattern const &)=default
operator=
LineJoin m_lineJoin
the line join
Definition: WPSGraphicStyle.h:351
bool hasBackgroundColor() const
returns true if the background is defined
Definition: WPSGraphicStyle.h:291
float m_shadowOpacity
true if the shadow has some color
Definition: WPSGraphicStyle.h:366
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: WPSGraphicStyle.h:192
bool empty() const
return true if we does not have a pattern
Definition: WPSGraphicStyle.h:117
float m_rotate
the rotation
Definition: WPSGraphicStyle.h:409
LineCap m_lineCap
the line cap
Definition: WPSGraphicStyle.h:349
Definition: WPSGraphicStyle.h:43
Definition: WPSGraphicStyle.h:45
Definition: WPSGraphicStyle.h:45
bool hasBorders() const
return true if the frame has some border
Definition: WPSGraphicStyle.h:307
WPSColor m_pictureAverageColor
the picture average color
Definition: WPSGraphicStyle.h:199
static WPSColor black()
return the back color
Definition: libwps_internal.h:306
void setBorders(int wh, WPSBorder const &border)
sets the cell border: wh=libwps::LeftBit|...
Definition: WPSGraphicStyle.cpp:144
std::vector< WPSBorder > m_bordersList
the borders WPSBorder::Pos (for a frame)
Definition: WPSGraphicStyle.h:398
static WPSColor white()
return the white color
Definition: libwps_internal.h:311
virtual ~WPSGraphicStyle()
virtual destructor
Definition: WPSGraphicStyle.cpp:140
bool getUniqueColor(WPSColor &col) const
check if the pattern has only one color; if so returns true...
Definition: WPSGraphicStyle.cpp:45
WPSGraphicStyle & operator=(WPSGraphicStyle &&)=default
Definition: WPSGraphicStyle.h:45
std::vector< float > m_lineDashWidth
the dash array: a sequence of (fullsize, emptysize)
Definition: WPSGraphicStyle.h:347
float m_opacity
the opacity
Definition: WPSGraphicStyle.h:82
bool isBlack() const
return true if the color is black
Definition: libwps_internal.h:345
Definition: WPSGraphicStyle.h:43
bool hasSameBorders() const
return true if the frame has some border
Definition: WPSGraphicStyle.h:312
void setSurfaceColor(WPSColor const &col, float opacity=1)
set the surface color
Definition: WPSGraphicStyle.h:254
float m_gradientAngle
the gradient angle
Definition: WPSGraphicStyle.h:378
virtual ~Pattern()
virtual destructor
Definition: WPSGraphicStyle.cpp:41
Vec2i m_dim
the dimension width x height
Definition: WPSGraphicStyle.h:187
float m_gradientRadius
the gradient radius
Definition: WPSGraphicStyle.h:384
Pattern(Vec2i dim, librevenge::RVNGBinaryData const &picture, std::string const &mime, WPSColor const &avColor)
constructor from a binary data
Definition: WPSGraphicStyle.h:102
a structure used to define a picture style
Definition: WPSGraphicStyle.h:37
std::vector< WPSBorder > const & borders() const
return the frame border: libwps::Left | ...
Definition: WPSGraphicStyle.h:324
int cmp(Pattern const &a) const
compare two patterns
Definition: WPSGraphicStyle.h:132
Vec2f m_gradientPercentCenter
the gradient center
Definition: WPSGraphicStyle.h:382
static WPSGraphicStyle emptyStyle()
returns an empty style.
Definition: WPSGraphicStyle.h:240
int cmp(WPSGraphicStyle const &a) const
compare two styles
Definition: WPSGraphicStyle.cpp:421
librevenge::RVNGBinaryData m_picture
a picture
Definition: WPSGraphicStyle.h:195
LineJoin
an enum used to define the basic line join
Definition: WPSGraphicStyle.h:43
void setPattern(Pattern const &pat)
set the pattern
Definition: WPSGraphicStyle.h:265
Pattern m_pattern
the pattern if it exists
Definition: WPSGraphicStyle.h:371
bool isWhite() const
return true if the color is white
Definition: libwps_internal.h:350
WPSColor m_shadowColor
the shadow color
Definition: WPSGraphicStyle.h:364
bool hasPattern() const
returns true if the pattern is defined
Definition: WPSGraphicStyle.h:270
bool hasLine() const
returns true if the border is defined
Definition: WPSGraphicStyle.h:249
void addFrameTo(librevenge::RVNGPropertyList &pList) const
add all the frame parameters to propList: the background and the borders
Definition: WPSGraphicStyle.cpp:369
int cmp(GradientStop const &a) const
compare two gradient
Definition: WPSGraphicStyle.h:58
float m_lineOpacity
the line opacity: 0=transparent
Definition: WPSGraphicStyle.h:353
float m_offset
the offset
Definition: WPSGraphicStyle.h:78
WPSColor m_colors[2]
the two indexed colors
Definition: WPSGraphicStyle.h:190
std::string m_extra
extra data
Definition: WPSGraphicStyle.h:414
Definition: WPSGraphicStyle.h:45
std::vector< GradientStop > m_gradientStopList
the list of gradient limits
Definition: WPSGraphicStyle.h:376
bool m_fillRuleEvenOdd
true if the fill rule is evenod
Definition: WPSGraphicStyle.h:357
WPSColor m_backgroundColor
the background color
Definition: WPSGraphicStyle.h:394
WPSColor m_color
the color
Definition: WPSGraphicStyle.h:80
bool hasShadow() const
returns true if the shadow is defined
Definition: WPSGraphicStyle.h:302
the class to store a color
Definition: libwps_internal.h:280
WPSColor m_surfaceColor
the surface color
Definition: WPSGraphicStyle.h:359
Pattern()
constructor
Definition: WPSGraphicStyle.h:91
Definition: WPSGraphicStyle.h:43
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: WPSGraphicStyle.cpp:165
Definition: WPSGraphicStyle.h:41
bool m_arrows[2]
two bool to indicated if extremity has arrow or not
Definition: WPSGraphicStyle.h:387
WPSColor m_lineColor
the line color
Definition: WPSGraphicStyle.h:355
float m_backgroundOpacity
true if the background has some color
Definition: WPSGraphicStyle.h:396
float m_gradientBorder
the gradient border opacity
Definition: WPSGraphicStyle.h:380
friend std::ostream & operator<<(std::ostream &o, Pattern const &pat)
a print operator
Definition: WPSGraphicStyle.h:165
Definition: WPSGraphicStyle.h:41
GradientStop(float offset=0.0, WPSColor const &col=WPSColor::black(), float opacity=1.0)
constructor
Definition: WPSGraphicStyle.h:51
LineCap
an enum used to define the basic line cap
Definition: WPSGraphicStyle.h:41
bool getAverageColor(WPSColor &col) const
return the average color
Definition: WPSGraphicStyle.cpp:61
bool hasSurfaceColor() const
returns true if the surface is defined
Definition: WPSGraphicStyle.h:260
WPSGraphicStyle()
constructor
Definition: WPSGraphicStyle.h:202
void setBackgroundColor(WPSColor const &col, float opacity=1)
set the background color
Definition: WPSGraphicStyle.h:285
float m_lineWidth
the linewidth
Definition: WPSGraphicStyle.h:345
Definition: WPSGraphicStyle.h:41
friend std::ostream & operator<<(std::ostream &o, WPSGraphicStyle const &st)
a print operator
Definition: WPSGraphicStyle.cpp:509
void setShadowColor(WPSColor const &col, float opacity=1)
set the shadow color
Definition: WPSGraphicStyle.h:296
int cmp(Vec2< T > const &p) const
a comparison function: which first compares x then y
Definition: libwps_internal.h:647
a basic pattern used in a WPSGraphicStyle:
Definition: WPSGraphicStyle.h:88
void resetBorders()
reset the border
Definition: WPSGraphicStyle.h:329
Definition: WPSGraphicStyle.h:45
GradientType m_gradientType
the gradient type
Definition: WPSGraphicStyle.h:374
GradientType
an enum used to define the gradient type
Definition: WPSGraphicStyle.h:45
Definition: WPSGraphicStyle.h:45
friend std::ostream & operator<<(std::ostream &o, GradientStop const &st)
a print operator
Definition: WPSGraphicStyle.h:69
librevenge::RVNGString m_frameNextName
the frame next name (if there is a link)
Definition: WPSGraphicStyle.h:402

Generated on Sun Oct 18 2020 20:49:30 for libwps by doxygen 1.8.9.1