SkillGuiCairoRenderInstructor Class Reference

Graphviz Cairo render plugin instructor. More...

Inheritance diagram for SkillGuiCairoRenderInstructor:

Inheritance graph
[legend]

List of all members.


Public Member Functions

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

Detailed Description

Graphviz Cairo render plugin instructor.

Author:
Tim Niemueller

Definition at line 29 of file gvplugin_skillgui_cairo.h.

Constructor & Destructor Documentation

virtual SkillGuiCairoRenderInstructor::~SkillGuiCairoRenderInstructor (  )  [inline, virtual]

Empty virtual destructor.

Definition at line 33 of file gvplugin_skillgui_cairo.h.

Member Function Documentation

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

Get Cairo context.

Returns:
cairo context to use for drawing

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

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

Get available space dimensions.

Parameters:
width upon return contains the available width
height upon return contains the available height

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

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_x upon return contains padding in x
pad_y upon return contains padding in y

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

double SkillGuiCairoRenderInstructor::get_scale (  )  [pure virtual]

Get scale factor.

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

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

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:
tx upon return contains translation in x
ty upon return contains translation in y

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

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.

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

Set the bounding box.

Set by the plugin before calling any other function.

Parameters:
bbw bounding box width
bbh bounding box height

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

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_x padding in x
pad_y padding in y

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

void SkillGuiCairoRenderInstructor::set_scale ( double  scale  )  [pure virtual]

Set scale.

Set the scale value that the plugin determined.

Parameters:
scale scale determined by plugin

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

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

Set translation.

Set the translation values the plugin determined.

Parameters:
tx translation in x
ty translation in y

Implemented in SkillGuiBatchRenderer, and SkillGuiGraphDrawingArea.

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