Public API Reference

cstool/pen.h

Go to the documentation of this file.

/*
  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__

#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/graph3d.h"
#include "ivideo/texture.h"

struct iFont;
struct iGraphics2D;
struct iGraphics3D;

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 */       
};


struct iPen
{
protected:
  virtual ~iPen() {}
public:
  virtual void SetFlag(uint flag) = 0;  
  
  virtual void ClearFlag(uint flag) = 0;                
  
  virtual void SetMixMode(uint mode) = 0;
        
  virtual void SetColor (float r, float g, float b, float a) = 0;

  virtual void SetColor(const csColor4 &color) = 0;
  
  virtual void SetTexture(csRef<iTextureHandle> tex) = 0;

  virtual void SwapColors() = 0;
  
  virtual void SetPenWidth(float width)=0;

  virtual void ClearTransform() = 0;

  virtual void PushTransform() = 0;

  virtual void PopTransform() = 0;

  virtual void SetOrigin(const csVector3 &o) = 0;

  virtual void Translate(const csVector3 &t) = 0;

  virtual void Rotate(const float &a) = 0;

  virtual void DrawLine (uint x1, uint y1, uint x2, uint y2) = 0;

  virtual void DrawPoint (uint x1, uint y2) = 0;

  virtual void DrawRect (uint x1, uint y1, uint x2, uint y2) = 0;
  
  virtual void DrawMiteredRect (uint x1, uint y1, uint x2, uint y2, 
    uint miter) = 0;

  virtual void DrawRoundedRect (uint x1, uint y1, uint x2, uint y2, 
    uint roundness) = 0; 

  virtual void DrawArc(uint x1, uint y1, uint x2, uint y2, float start_angle,
        float end_angle) = 0;

  virtual void DrawTriangle(uint x1, uint y1, uint x2, uint y2, uint x3, uint y3) = 0;

  virtual void Write(iFont *font, uint x1, uint y1, char *text) = 0;

  virtual void WriteBoxed(iFont *font, uint x1, uint y1, uint x2, uint y2, 
    uint h_align, uint v_align, char *text) = 0;
};

class CS_CRYSTALSPACE_EXPORT csPen : public iPen
{
  csRef<iGraphics3D> g3d;

  csRef<iGraphics2D> g2d;

  csSimpleRenderMesh mesh;
  
  csPolyIndexed poly_idx;
  
  csPoly3D poly;

  csVector4 color;

  csVector4 alt_color;
  
  csRef<iTextureHandle> tex;

  csVector3 tt;

  csDirtyAccessArray<csVector4> colors;
  
  csDirtyAccessArray<csVector2> texcoords;

  csArray<csReversibleTransform> transforms;
  
  csArray<csVector3> translations;
  
  float pen_width;
    
  uint flags;
    
  struct point
  {
          float x,y;
  };
  
  csArray<point> line_points; 
  
  point last[2];
  
  float sh_w, sh_h; 
  
  bool gen_tex_coords;

protected:
  void Start();

  void AddVertex(float x, float y, bool force_add=false);
  
  inline void AddTexCoord(float x, float y);

  void SetupMesh();
  
  void DrawMesh(csRenderMeshType mesh_type);
  
  void SetAutoTexture(float w, float h);
  
  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, char *text);

  virtual void WriteBoxed(iFont *font, uint x1, uint y1, uint x2, uint y2, 
    uint h_align, uint v_align, char *text);
};



class CS_CRYSTALSPACE_EXPORT csMemoryPen : public iPen
{           
        csMemFile *buf;      
        
        csRefArray<iTextureHandle> textures;
     
public:
         csMemoryPen():buf(0) { Clear(); }
         virtual ~csMemoryPen() {}
                 
                 
         
          virtual void Clear();
         
          void Draw(iPen *_pen_);
          
  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);

  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,
        float end_angle);

  virtual void DrawTriangle(uint x1, uint y1, uint x2, uint y2, uint x3, uint y3);

  virtual void Write(iFont *font, uint x1, uint y1, char *text);

  virtual void WriteBoxed(iFont *font, uint x1, uint y1, uint x2, uint y2, 
    uint h_align, uint v_align, char *text);
               
};  



#endif

---