Fawkes API  Fawkes Development Version
SkillGuiCairoRenderInstructor Class Referenceabstract

Graphviz Cairo render plugin instructor. More...

Inheritance diagram for SkillGuiCairoRenderInstructor:

Public Member Functions

virtual ~SkillGuiCairoRenderInstructor ()
 Empty virtual destructor. More...
 
virtual Cairo::RefPtr< Cairo::Context > get_cairo ()=0
 Get Cairo context. More...
 
virtual bool scale_override ()=0
 Check if scale override is enabled. More...
 
virtual void get_dimensions (double &width, double &height)=0
 Get available space dimensions. More...
 
virtual double get_scale ()=0
 Get scale factor. More...
 
virtual void set_scale (double scale)=0
 Set scale. More...
 
virtual void get_translation (double &tx, double &ty)=0
 Get translation values. More...
 
virtual void set_translation (double tx, double ty)=0
 Set translation. More...
 
virtual void set_bb (double bbw, double bbh)=0
 Set the bounding box. More...
 
virtual void set_pad (double pad_x, double pad_y)=0
 Set padding. More...
 
virtual void get_pad (double &pad_x, double &pad_y)=0
 Get padding. More...
 

Detailed Description

Graphviz Cairo render plugin instructor.

Author
Tim Niemueller

Definition at line 29 of file gvplugin_skillgui_cairo.h.

Constructor & Destructor Documentation

◆ ~SkillGuiCairoRenderInstructor()

virtual SkillGuiCairoRenderInstructor::~SkillGuiCairoRenderInstructor ( )
inlinevirtual

Member Function Documentation

◆ get_cairo()

Cairo::RefPtr< Cairo::Context > SkillGuiCairoRenderInstructor::get_cairo ( )
pure virtual

Get Cairo context.

Returns
cairo context to use for drawing

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().

◆ get_dimensions()

void SkillGuiCairoRenderInstructor::get_dimensions ( double &  width,
double &  height 
)
pure virtual

Get available space dimensions.

Parameters
widthupon return contains the available width
heightupon return contains the available height

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().

◆ get_pad()

void SkillGuiCairoRenderInstructor::get_pad ( double &  pad_x,
double &  pad_y 
)
pure virtual

Get padding.

If scale_override() returns true, shall return the requested padding values.

Parameters
pad_xupon return contains padding in x
pad_yupon return contains padding in y

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().

◆ get_scale()

double SkillGuiCairoRenderInstructor::get_scale ( )
pure virtual

Get scale factor.

If scale_override() returns true, shall return the requested scale value.

Returns
scale factor

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().

◆ get_translation()

void SkillGuiCairoRenderInstructor::get_translation ( double &  tx,
double &  ty 
)
pure virtual

Get translation values.

If scale_override() returns true, shall return the requested translation values.

Parameters
txupon return contains translation in x
tyupon return contains translation in y

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().

◆ scale_override()

bool SkillGuiCairoRenderInstructor::scale_override ( )
pure virtual

Check if scale override is enabled.

Returns
true if the instructor determines the scaling, false to have the plugin do this.

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().

◆ set_bb()

void SkillGuiCairoRenderInstructor::set_bb ( double  bbw,
double  bbh 
)
pure virtual

Set the bounding box.

Set by the plugin before calling any other function.

Parameters
bbwbounding box width
bbhbounding box height

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().

◆ set_pad()

void SkillGuiCairoRenderInstructor::set_pad ( double  pad_x,
double  pad_y 
)
pure virtual

Set padding.

Set by the plugin immediately after set_bb() is called.

Parameters
pad_xpadding in x
pad_ypadding in y

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().

◆ set_scale()

void SkillGuiCairoRenderInstructor::set_scale ( double  scale)
pure virtual

Set scale.

Set the scale value that the plugin determined.

Parameters
scalescale determined by plugin

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().

◆ set_translation()

void SkillGuiCairoRenderInstructor::set_translation ( double  tx,
double  ty 
)
pure virtual

Set translation.

Set the translation values the plugin determined.

Parameters
txtranslation in x
tytranslation in y

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

Referenced by ~SkillGuiCairoRenderInstructor().


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