/usr/include/crystalspace-2.0/cstool/pen.h is in libcrystalspace-dev 2.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 | /*
Copyright (C) 2005 by Christopher Nelson
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __CS_CSTOOL_PEN_H__
#define __CS_CSTOOL_PEN_H__
/**\file
* Vector shape drawing.
*/
#include "csgeom/poly3d.h"
#include "csgeom/polyidx.h"
#include "csgeom/vector4.h"
#include "csgeom/vector2.h"
#include "csutil/cscolor.h"
#include "csutil/dirtyaccessarray.h"
#include "csutil/ref.h"
#include "csutil/refarr.h"
#include "csutil/memfile.h"
#include "ivideo/graph2d.h"
#include "ivideo/graph3d.h"
#include "ivideo/texture.h"
struct iFont;
enum CS_PEN_TEXT_ALIGN
{
CS_PEN_TA_TOP,
CS_PEN_TA_BOT,
CS_PEN_TA_LEFT,
CS_PEN_TA_RIGHT,
CS_PEN_TA_CENTER
};
enum CS_PEN_FLAGS
{
CS_PEN_FILL = 1,
CS_PEN_SWAPCOLORS= 2,
CS_PEN_TEXTURE_ONLY=4,
CS_PEN_TEXTURE = 5 /* fill | 4 */
};
/**
* A pen is used to draw vector shapes.
*/
struct iPen
{
protected:
virtual ~iPen() {}
public:
/**
* Sets the given flag.
* @param flag The flag to set.
*/
virtual void SetFlag(uint flag) = 0;
/**
* Clears the given flag.
* @param flag The flag to clear.
*/
virtual void ClearFlag(uint flag) = 0;
/** Sets the given mix (blending) mode.
* @param mode The mixmode to set.
*/
virtual void SetMixMode(uint mode) = 0;
/**
* Sets the current color.
* @param r The red component.
* @param g The green component.
* @param b The blue component.
* @param a The alpha component.
*/
virtual void SetColor (float r, float g, float b, float a) = 0;
/**
* Sets the current color.
*/
virtual void SetColor(const csColor4 &color) = 0;
/**
* Sets the texture handle.
* @param tex A reference to the texture to use.
*/
virtual void SetTexture(csRef<iTextureHandle> tex) = 0;
/**
* Swaps the current color and the alternate color.
*/
virtual void SwapColors() = 0;
/**
* Sets the width of the pen for line drawing.
*/
virtual void SetPenWidth(float width)=0;
/**
* Clears the current transform, resets to identity.
*/
virtual void ClearTransform() = 0;
/**
* Pushes the current transform onto the stack. *
*/
virtual void PushTransform() = 0;
/**
* Pops the transform stack. The top of the stack becomes the current
* transform.
*/
virtual void PopTransform() = 0;
/**
* Sets the origin of the coordinate system.
*/
virtual void SetOrigin(const csVector3 &o) = 0;
/**
* Translates by the given vector
*/
virtual void Translate(const csVector3 &t) = 0;
/**
* Rotates by the given angle.
*/
virtual void Rotate(const float &a) = 0;
/**
* Draws a single line.
*/
virtual void DrawLine (uint x1, uint y1, uint x2, uint y2) = 0;
/**
* Draws a single point.
*/
virtual void DrawPoint (uint x1, uint y2) = 0;
/**
* Draws a rectangle.
*/
virtual void DrawRect (uint x1, uint y1, uint x2, uint y2) = 0;
/**
* Draws a mitered rectangle. The miter value should be between 0.0 and 1.0,
* and determines how much of the corner is mitered off and beveled.
*/
virtual void DrawMiteredRect (uint x1, uint y1, uint x2, uint y2,
uint miter) = 0;
/**
* Draws a rounded rectangle. The roundness value should be between
* 0.0 and 1.0, and determines how much of the corner is rounded off.
*/
virtual void DrawRoundedRect (uint x1, uint y1, uint x2, uint y2,
uint roundness) = 0;
/**
* Draws an elliptical arc from start angle to end angle. Angle must be
* specified in radians. The arc will be made to fit in the given box.
* If you want a circular arc, make sure the box is a square. If you want
* a full circle or ellipse, specify 0 as the start angle and 2*PI as the end
* angle.
*/
virtual void DrawArc(uint x1, uint y1, uint x2, uint y2, float start_angle,
float end_angle) = 0;
/**
* Draws a triangle around the given vertices.
*/
virtual void DrawTriangle(uint x1, uint y1, uint x2, uint y2, uint x3, uint y3) = 0;
/**
* Writes text in the given font at the given location.
*/
virtual void Write(iFont *font, uint x1, uint y1, const char *text) = 0;
/**
* Writes multiple lines of text in the given font at the given location.
*/
virtual void WriteLines(iFont *font, uint x1, uint y1, const csStringArray& lines) = 0;
/**
* Writes text in the given font, in the given box. The alignment
* specified in h_align and v_align determine how it should be aligned.
*/
virtual void WriteBoxed(iFont *font, uint x1, uint y1, uint x2, uint y2,
uint h_align, uint v_align, const char *text) = 0;
/**
* Writes multiple lines of text in the given font, in the given box.
* The alignment specified in h_align and v_align determine how it should
* be aligned.
*/
virtual void WriteLinesBoxed(iFont *font, uint x1, uint y1, uint x2, uint y2,
uint h_align, uint v_align, const csStringArray& lines) = 0;
};
/** A pen specialized for CS. */
class CS_CRYSTALSPACE_EXPORT csPen : public iPen
{
/** The 3d context for drawing. */
csRef<iGraphics3D> g3d;
/** The 2d context for drawing. */
csRef<iGraphics2D> g2d;
/** The mesh that we reuse in developing the shapes we're making. */
csSimpleRenderMesh mesh;
/** The polygon index that we're generating. */
csPolyIndexed poly_idx;
/** The polygon that we're generating. */
csPoly3D poly;
/** The color we use. */
csVector4 color;
/** The alternate color we might use. */
csVector4 alt_color;
/** The texture handle that we might use. */
csRef<iTextureHandle> tex;
/** The translation we keep for text. */
csVector3 tt;
/** The color array generated for verts as we render. */
csDirtyAccessArray<csVector4> colors;
/** The texture coordinates are generated as we render too. */
csDirtyAccessArray<csVector2> texcoords;
/** The array that stores the transformation stack. */
csArray<csReversibleTransform> transforms;
/** The array that stores the translation stack for text. */
csArray<csVector3> translations;
/** The width of the pen for non-filled shapes. */
float pen_width;
/** The flags currently set. */
uint flags;
/** The type of a point. */
struct point
{
float x,y;
};
/** Used to keep track of points when drawing thick lines. */
csArray<point> line_points;
/** The last two calculated points. */
point last[2];
/** For most shapes, we can set the width and height, and enable
* automatic texture coordinate generation. */
float sh_w, sh_h;
/** When this is set, automatic texture coordinate generation will occur
* in add vertex. */
bool gen_tex_coords;
protected:
/**
* Initializes our working objects.
*/
void Start();
/**
* Adds a vertex.
* @param x X coord
* @param y Y coord
* @param force_add Forces the coordinate to be added as a vertex, instead
* of trying to be smart and make it a thick vertex.
*/
void AddVertex(float x, float y, bool force_add=false);
/** Adds a texture coordinate.
* @param x The texture's x coord.
* @param y The texture's y coord.
*/
inline void AddTexCoord(float x, float y);
/**
* Worker, sets up the mesh with the vertices, color, and other information.
*/
void SetupMesh();
/**
* Worker, draws the mesh.
*/
void DrawMesh(csRenderMeshType mesh_type);
/**
* Worker, sets up the pen to do auto texturing.
*/
void SetAutoTexture(float w, float h);
/**
* Worker, adds thick line points. A thick point is created when the
* pen width is greater than 1. It uses polygons to simulate thick
* lines.
*/
void AddThickPoints(float x1, float y1, float x2, float y2);
public:
csPen(iGraphics2D *_g2d, iGraphics3D *_g3d);
virtual ~csPen();
virtual void SetFlag(uint flag);
virtual void ClearFlag(uint flag);
virtual void SetMixMode(uint mode);
virtual void SetColor (float r, float g, float b, float a);
virtual void SetColor(const csColor4 &color);
virtual void SetTexture(csRef<iTextureHandle> tex);
virtual void SwapColors();
virtual void SetPenWidth(float width);
virtual void ClearTransform();
virtual void PushTransform();
virtual void PopTransform();
virtual void SetOrigin(const csVector3 &o);
virtual void Translate(const csVector3 &t);
virtual void Rotate(const float &a);
virtual void DrawLine (uint x1, uint y1, uint x2, uint y2);
void DrawThickLine(uint x1, uint y1, uint x2, uint y2);
virtual void DrawPoint (uint x1, uint y2);
virtual void DrawRect (uint x1, uint y1, uint x2, uint y2);
virtual void DrawMiteredRect (uint x1, uint y1, uint x2, uint y2,
uint miter);
virtual void DrawRoundedRect (uint x1, uint y1, uint x2, uint y2,
uint roundness);
virtual void DrawArc(uint x1, uint y1, uint x2, uint y2,
float start_angle=0, float end_angle=6.2831853);
virtual void DrawTriangle(uint x1, uint y1, uint x2, uint y2, uint x3, uint y3);
virtual void Write(iFont *font, uint x1, uint y1, const char *text);
virtual void WriteLines(iFont *font, uint x1, uint y1, const csStringArray& lines);
virtual void WriteBoxed(iFont *font, uint x1, uint y1, uint x2, uint y2,
uint h_align, uint v_align, const char *text);
virtual void WriteLinesBoxed(iFont *font, uint x1, uint y1, uint x2, uint y2,
uint h_align, uint v_align, const csStringArray& lines);
};
#endif
|