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), m_color(col), m_opacity(opacity)
53  {
54  }
56  int cmp(GradientStop const &a) const
57  {
58  if (m_offset < a.m_offset) return -1;
59  if (m_offset > a.m_offset) return 1;
60  if (m_color < a.m_color) return -1;
61  if (m_color > a.m_color) return 1;
62  if (m_opacity < a.m_opacity) return -1;
63  if (m_opacity > a.m_opacity) return 1;
64  return 0;
65  }
67  friend std::ostream &operator<<(std::ostream &o, GradientStop const &st)
68  {
69  o << "offset=" << st.m_offset << ",";
70  o << "color=" << st.m_color << ",";
71  if (st.m_opacity<1.0)
72  o << "opacity=" << st.m_opacity*100.f << "%,";
73  return o;
74  }
76  float m_offset;
80  float m_opacity;
81  };
86  struct Pattern
87  {
90  {
93  }
95  Pattern(Vec2i dim, librevenge::RVNGBinaryData const &picture, std::string const &mime, WPSColor const &avColor) :
96  m_dim(dim), m_data(), m_picture(picture), m_pictureMime(mime), m_pictureAverageColor(avColor)
97  {
100  }
102  virtual ~Pattern() {}
104  bool empty() const
105  {
106  if (m_dim[0]==0 || m_dim[1]==0) return true;
107  if (m_picture.size()) return false;
108  if (m_dim[0]!=8 && m_dim[0]!=16 && m_dim[0]!=32) return true;
109  return m_data.size()!=size_t((m_dim[0]/8)*m_dim[1]);
110  }
112  bool getAverageColor(WPSColor &col) const;
114  bool getUniqueColor(WPSColor &col) const;
116  bool getBinary(librevenge::RVNGBinaryData &data, std::string &type) const;
117 
119  int cmp(Pattern const &a) const
120  {
121  int diff = m_dim.cmp(a.m_dim);
122  if (diff) return diff;
123  if (m_data.size() < a.m_data.size()) return -1;
124  if (m_data.size() > a.m_data.size()) return 1;
125  for (size_t h=0; h < m_data.size(); ++h)
126  {
127  if (m_data[h]<a.m_data[h]) return 1;
128  if (m_data[h]>a.m_data[h]) return -1;
129  }
130  for (int i=0; i<2; ++i)
131  {
132  if (m_colors[i] < a.m_colors[i]) return 1;
133  if (m_colors[i] > a.m_colors[i]) return -1;
134  }
136  if (m_pictureAverageColor > a.m_pictureAverageColor) return -1;
137  if (m_pictureMime < a.m_pictureMime) return 1;
138  if (m_pictureMime > a.m_pictureMime) return -1;
139  if (m_picture.size() < a.m_picture.size()) return 1;
140  if (m_picture.size() > a.m_picture.size()) return -1;
141  const unsigned char *ptr=m_picture.getDataBuffer();
142  const unsigned char *aPtr=a.m_picture.getDataBuffer();
143  if (!ptr || !aPtr) return 0; // must only appear if the two buffers are empty
144  for (unsigned long h=0; h < m_picture.size(); ++h, ++ptr, ++aPtr)
145  {
146  if (*ptr < *aPtr) return 1;
147  if (*ptr > *aPtr) return -1;
148  }
149  return 0;
150  }
152  friend std::ostream &operator<<(std::ostream &o, Pattern const &pat)
153  {
154  o << "dim=" << pat.m_dim << ",";
155  if (pat.m_picture.size())
156  {
157  o << "type=" << pat.m_pictureMime << ",";
158  o << "col[average]=" << pat.m_pictureAverageColor << ",";
159  }
160  else
161  {
162  if (!pat.m_colors[0].isBlack()) o << "col0=" << pat.m_colors[0] << ",";
163  if (!pat.m_colors[1].isWhite()) o << "col1=" << pat.m_colors[1] << ",";
164  o << "[";
165  for (size_t h=0; h < pat.m_data.size(); ++h)
166  o << std::hex << (int) pat.m_data[h] << std::dec << ",";
167  o << "],";
168  }
169  return o;
170  }
173 
177  std::vector<unsigned char> m_data;
178  protected:
180  librevenge::RVNGBinaryData m_picture;
182  std::string m_pictureMime;
185  };
190  m_pattern(),
193  m_rotate(0), m_extra("")
194  {
195  m_arrows[0]=m_arrows[1]=false;
196  m_flip[0]=m_flip[1]=false;
199  }
202  {
203  WPSGraphicStyle res;
204  res.m_lineWidth=0;
205  return res;
206  }
208  virtual ~WPSGraphicStyle() { }
210  bool hasLine() const
211  {
212  return m_lineWidth>0 && m_lineOpacity>0;
213  }
215  void setSurfaceColor(WPSColor const &col, float opacity = 1)
216  {
217  m_surfaceColor = col;
218  m_surfaceOpacity = opacity;
219  }
221  bool hasSurfaceColor() const
222  {
223  return m_surfaceOpacity > 0;
224  }
226  void setPattern(Pattern const &pat)
227  {
228  m_pattern=pat;
229  }
231  bool hasPattern() const
232  {
233  return !m_pattern.empty();
234  }
236  bool hasGradient(bool complex=false) const
237  {
238  return m_gradientType != G_None && (int) m_gradientStopList.size() >= (complex ? 3 : 2);
239  }
241  bool hasSurface() const
242  {
243  return hasSurfaceColor() || hasPattern() || hasGradient();
244  }
246  void setBackgroundColor(WPSColor const &col, float opacity = 1)
247  {
248  m_backgroundColor = col;
249  m_backgroundOpacity = opacity;
250  }
252  bool hasBackgroundColor() const
253  {
254  return m_backgroundOpacity > 0;
255  }
257  void setShadowColor(WPSColor const &col, float opacity = 1)
258  {
259  m_shadowColor = col;
260  m_shadowOpacity = opacity;
261  }
263  bool hasShadow() const
264  {
265  return m_shadowOpacity > 0;
266  }
268  bool hasBorders() const
269  {
270  return !m_bordersList.empty();
271  }
273  bool hasSameBorders() const
274  {
275  if (m_bordersList.empty()) return true;
276  if (m_bordersList.size()!=4) return false;
277  for (size_t i=1; i<m_bordersList.size(); ++i)
278  {
279  if (m_bordersList[i]!=m_bordersList[0])
280  return false;
281  }
282  return true;
283  }
285  std::vector<WPSBorder> const &borders() const
286  {
287  return m_bordersList;
288  }
291  {
292  m_bordersList.resize(0);
293  }
295  void setBorders(int wh, WPSBorder const &border);
297  friend std::ostream &operator<<(std::ostream &o, WPSGraphicStyle const &st);
299  void addTo(librevenge::RVNGPropertyList &pList, bool only1d=false) const;
301  void addFrameTo(librevenge::RVNGPropertyList &pList) const;
303  int cmp(WPSGraphicStyle const &a) const;
304 
306  float m_lineWidth;
308  std::vector<float> m_lineDashWidth;
323 
330 
333 
337  std::vector<GradientStop> m_gradientStopList;
346 
348  bool m_arrows[2];
349 
350  //
351  // related to the frame
352  //
353 
359  std::vector<WPSBorder> m_bordersList;
361  std::string m_frameName;
363  std::string m_frameNextName;
364 
365  //
366  // some transformation: must probably be somewhere else
367  //
368 
370  float m_rotate;
372  bool m_flip[2];
373 
375  std::string m_extra;
376 };
377 #endif
378 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
virtual ~WPSGraphicStyle()
virtual destructor
Definition: WPSGraphicStyle.h:208
bool m_flip[2]
two bool to indicated we need to flip the shape or not
Definition: WPSGraphicStyle.h:372
a structure used to define the gradient limit
Definition: WPSGraphicStyle.h:48
std::string m_pictureMime
the picture type
Definition: WPSGraphicStyle.h:182
bool hasGradient(bool complex=false) const
returns true if the gradient is defined
Definition: WPSGraphicStyle.h:236
bool hasSurface() const
returns true if the interior surface is defined
Definition: WPSGraphicStyle.h:241
bool getBinary(librevenge::RVNGBinaryData &data, std::string &type) const
tries to convert the picture in a binary data ( ppm)
Definition: WPSGraphicStyle.cpp:88
Vec2f m_shadowOffset
the shadow offset
Definition: WPSGraphicStyle.h:329
a border list
Definition: libwps_internal.h:393
float m_surfaceOpacity
true if the surface has some color
Definition: WPSGraphicStyle.h:322
Definition: WPSGraphicStyle.h:45
LineJoin m_lineJoin
the line join
Definition: WPSGraphicStyle.h:312
bool hasBackgroundColor() const
returns true if the background is defined
Definition: WPSGraphicStyle.h:252
float m_shadowOpacity
true if the shadow has some color
Definition: WPSGraphicStyle.h:327
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:177
bool empty() const
return true if we does not have a pattern
Definition: WPSGraphicStyle.h:104
float m_rotate
the rotation
Definition: WPSGraphicStyle.h:370
LineCap m_lineCap
the line cap
Definition: WPSGraphicStyle.h:310
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:268
WPSColor m_pictureAverageColor
the picture average color
Definition: WPSGraphicStyle.h:184
static WPSColor black()
return the back color
Definition: libwps_internal.h:305
void setBorders(int wh, WPSBorder const &border)
sets the cell border: wh=libwps::LeftBit|...
Definition: WPSGraphicStyle.cpp:136
std::vector< WPSBorder > m_bordersList
the borders WPSBorder::Pos (for a frame)
Definition: WPSGraphicStyle.h:359
static WPSColor white()
return the white color
Definition: libwps_internal.h:310
bool getUniqueColor(WPSColor &col) const
check if the pattern has only one color; if so returns true...
Definition: WPSGraphicStyle.cpp:41
Definition: WPSGraphicStyle.h:45
std::vector< float > m_lineDashWidth
the dash array: a sequence of (fullsize, emptysize)
Definition: WPSGraphicStyle.h:308
float m_opacity
the opacity
Definition: WPSGraphicStyle.h:80
virtual ~Pattern()
virtual destructor
Definition: WPSGraphicStyle.h:102
bool isBlack() const
return true if the color is black
Definition: libwps_internal.h:344
Definition: WPSGraphicStyle.h:43
bool hasSameBorders() const
return true if the frame has some border
Definition: WPSGraphicStyle.h:273
void setSurfaceColor(WPSColor const &col, float opacity=1)
set the surface color
Definition: WPSGraphicStyle.h:215
float m_gradientAngle
the gradient angle
Definition: WPSGraphicStyle.h:339
Vec2i m_dim
the dimension width x height
Definition: WPSGraphicStyle.h:172
float m_gradientRadius
the gradient radius
Definition: WPSGraphicStyle.h:345
Pattern(Vec2i dim, librevenge::RVNGBinaryData const &picture, std::string const &mime, WPSColor const &avColor)
constructor from a binary data
Definition: WPSGraphicStyle.h:95
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:285
int cmp(Pattern const &a) const
compare two patterns
Definition: WPSGraphicStyle.h:119
Vec2f m_gradientPercentCenter
the gradient center
Definition: WPSGraphicStyle.h:343
std::string m_frameName
the frame name
Definition: WPSGraphicStyle.h:361
static WPSGraphicStyle emptyStyle()
returns an empty style.
Definition: WPSGraphicStyle.h:201
int cmp(WPSGraphicStyle const &a) const
compare two styles
Definition: WPSGraphicStyle.cpp:413
librevenge::RVNGBinaryData m_picture
a picture
Definition: WPSGraphicStyle.h:180
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:226
Pattern m_pattern
the pattern if it exists
Definition: WPSGraphicStyle.h:332
bool isWhite() const
return true if the color is white
Definition: libwps_internal.h:349
WPSColor m_shadowColor
the shadow color
Definition: WPSGraphicStyle.h:325
bool hasPattern() const
returns true if the pattern is defined
Definition: WPSGraphicStyle.h:231
bool hasLine() const
returns true if the border is defined
Definition: WPSGraphicStyle.h:210
void addFrameTo(librevenge::RVNGPropertyList &pList) const
add all the frame parameters to propList: the background and the borders
Definition: WPSGraphicStyle.cpp:361
int cmp(GradientStop const &a) const
compare two gradient
Definition: WPSGraphicStyle.h:56
float m_lineOpacity
the line opacity: 0=transparent
Definition: WPSGraphicStyle.h:314
float m_offset
the offset
Definition: WPSGraphicStyle.h:76
WPSColor m_colors[2]
the two indexed colors
Definition: WPSGraphicStyle.h:175
std::string m_extra
extra data
Definition: WPSGraphicStyle.h:375
Definition: WPSGraphicStyle.h:45
std::vector< GradientStop > m_gradientStopList
the list of gradient limits
Definition: WPSGraphicStyle.h:337
bool m_fillRuleEvenOdd
true if the fill rule is evenod
Definition: WPSGraphicStyle.h:318
WPSColor m_backgroundColor
the background color
Definition: WPSGraphicStyle.h:355
WPSColor m_color
the color
Definition: WPSGraphicStyle.h:78
bool hasShadow() const
returns true if the shadow is defined
Definition: WPSGraphicStyle.h:263
the class to store a color
Definition: libwps_internal.h:287
WPSColor m_surfaceColor
the surface color
Definition: WPSGraphicStyle.h:320
Pattern()
constructor
Definition: WPSGraphicStyle.h:89
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:157
Definition: WPSGraphicStyle.h:41
bool m_arrows[2]
two bool to indicated if extremity has arrow or not
Definition: WPSGraphicStyle.h:348
WPSColor m_lineColor
the line color
Definition: WPSGraphicStyle.h:316
float m_backgroundOpacity
true if the background has some color
Definition: WPSGraphicStyle.h:357
float m_gradientBorder
the gradient border opacity
Definition: WPSGraphicStyle.h:341
friend std::ostream & operator<<(std::ostream &o, Pattern const &pat)
a print operator
Definition: WPSGraphicStyle.h:152
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:57
bool hasSurfaceColor() const
returns true if the surface is defined
Definition: WPSGraphicStyle.h:221
WPSGraphicStyle()
constructor
Definition: WPSGraphicStyle.h:187
void setBackgroundColor(WPSColor const &col, float opacity=1)
set the background color
Definition: WPSGraphicStyle.h:246
float m_lineWidth
the linewidth
Definition: WPSGraphicStyle.h:306
std::string m_frameNextName
the frame next name (if there is a link)
Definition: WPSGraphicStyle.h:363
Definition: WPSGraphicStyle.h:41
friend std::ostream & operator<<(std::ostream &o, WPSGraphicStyle const &st)
a print operator
Definition: WPSGraphicStyle.cpp:501
void setShadowColor(WPSColor const &col, float opacity=1)
set the shadow color
Definition: WPSGraphicStyle.h:257
int cmp(Vec2< T > const &p) const
a comparison function: which first compares x then y
Definition: libwps_internal.h:678
a basic pattern used in a WPSGraphicStyle:
Definition: WPSGraphicStyle.h:86
void resetBorders()
reset the border
Definition: WPSGraphicStyle.h:290
Definition: WPSGraphicStyle.h:45
GradientType m_gradientType
the gradient type
Definition: WPSGraphicStyle.h:335
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:67

Generated on Wed Apr 11 2018 00:19:12 for libwps by doxygen 1.8.5