JugiMap Framework
Drawer Class Reference

The Drawer is the base drawer class. More...

#include <jmDrawing.h>

Inherited by DrawerAGK, DrawerCC, DrawerNC, and DrawerSFML.

Public Member Functions

virtual ~Drawer ()
 Destructor. More...
 
virtual void InitEngineDrawer ()
 Initialize engine objects related to this drawer. More...
 
virtual void UpdateEngineDrawer ()
 Update engine objects related to this drawer. More...
 
virtual void SetOutlineColor (ColorRGBA _outlineColor)
 Set outline color to the given *_outlineColor*. More...
 
virtual void Clear ()
 Clear this drawer (required by some engines). More...
 
virtual void Line (jugimap::Vec2f p1, jugimap::Vec2f p2)
 Draw a line from the given position p1 to p2. More...
 
virtual void RectangleOutline (const jugimap::Rectf &rect)
 Draw the outline of the given rectangle rect. More...
 
virtual void EllipseOutline (jugimap::Vec2f c, jugimap::Vec2f r)
 Draw the outline of an ellipse defined by the given center point c and radius r. More...
 
virtual void Dot (jugimap::Vec2f p)
 Draw a dot at the given position p. More...
 
void SetDrawingLayer (DrawingLayer *_drawingLayer)
 Set the drawing layer of this drawer. More...
 
DrawingLayerGetDrawingLayer ()
 Returns the drawing layer of this drawer. More...
 

Detailed Description

The Drawer is the base drawer class.

A Drawer object draws geometric primitives on a drawing layer.

Constructor & Destructor Documentation

◆ ~Drawer()

virtual ~Drawer ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ InitEngineDrawer()

virtual void InitEngineDrawer ( )
inlinevirtual

Initialize engine objects related to this drawer.

This function should usually not be used manually as it gets called in the DrawingLayer::InitEngineLayer() function.

Reimplemented in DrawerNC, and DrawerCC.

◆ UpdateEngineDrawer()

virtual void UpdateEngineDrawer ( )
inlinevirtual

Update engine objects related to this drawer.

This function should usually not be used manually as it gets called in the DrawingLayer::UpdateEngineLayer() function.

Reimplemented in DrawerAGK, DrawerNC, and DrawerCC.

◆ SetOutlineColor()

virtual void SetOutlineColor ( ColorRGBA  _outlineColor)
inlinevirtual

Set outline color to the given *_outlineColor*.

Reimplemented in DrawerAGK, DrawerSFML, DrawerNC, and DrawerCC.

◆ Clear()

virtual void Clear ( )
inlinevirtual

Clear this drawer (required by some engines).

Reimplemented in DrawerNC, and DrawerCC.

◆ Line()

virtual void Line ( jugimap::Vec2f  p1,
jugimap::Vec2f  p2 
)
inlinevirtual

Draw a line from the given position p1 to p2.

Reimplemented in DrawerNC, DrawerCC, DrawerAGK, and DrawerSFML.

◆ RectangleOutline()

virtual void RectangleOutline ( const jugimap::Rectf rect)
inlinevirtual

Draw the outline of the given rectangle rect.

Reimplemented in DrawerNC, DrawerCC, DrawerAGK, and DrawerSFML.

◆ EllipseOutline()

virtual void EllipseOutline ( jugimap::Vec2f  c,
jugimap::Vec2f  r 
)
inlinevirtual

Draw the outline of an ellipse defined by the given center point c and radius r.

Reimplemented in DrawerNC, DrawerCC, DrawerAGK, and DrawerSFML.

◆ Dot()

virtual void Dot ( jugimap::Vec2f  p)
inlinevirtual

Draw a dot at the given position p.

Reimplemented in DrawerNC, DrawerCC, DrawerAGK, and DrawerSFML.

◆ SetDrawingLayer()

void SetDrawingLayer ( DrawingLayer _drawingLayer)
inline

Set the drawing layer of this drawer.

◆ GetDrawingLayer()

DrawingLayer* GetDrawingLayer ( )
inline

Returns the drawing layer of this drawer.


The documentation for this class was generated from the following file: