Fawkes API  Fawkes Development Version
SkillGuiGraphViewport Class Reference

Skill FSM Graph Viewport. More...

#include "graph_viewport.h"

Inheritance diagram for SkillGuiGraphViewport:

Public Member Functions

 SkillGuiGraphViewport ()
 Constructor. More...
 
 ~SkillGuiGraphViewport ()
 Destructor. More...
 
void set_gvjob (GVJ_t *job)
 Set current Graphviz job. More...
 
void set_graph_fsm (std::string fsm_name)
 Set graph's FSM name. More...
 
void set_graph (std::string graph)
 Set graph. More...
 
bool get_update_graph ()
 Check if graph is being updated. More...
 
void set_update_graph (bool update)
 Set if the graph should be updated on new data. More...
 
void save ()
 Render current graph. More...
 
void render ()
 Render current graph. More...
 
void zoom_in ()
 Zoom in. More...
 
void zoom_out ()
 Zoom out. More...
 
void zoom_fit ()
 Zoom to fit. More...
 
void zoom_reset ()
 Zoom reset. More...
 
Papyrus::AffineController::pointer get_affine ()
 Get scaler. More...
 
void add_drawable (Papyrus::Drawable::pointer d)
 Add a drawable. More...
 
virtual void clear ()
 Clear all drawables. More...
 
void set_bb (double bbw, double bbh)
 Set bounding box. More...
 
void set_pad (double pad_x, double pad_y)
 Set padding. More...
 
void set_translation (double tx, double ty)
 Set translation. More...
 
void set_scale (double scale)
 Set scale. More...
 
bool scale_override ()
 Check if scale override is enabled. More...
 

Protected Member Functions

void on_expose (GdkEventExpose *event)
 Called on explose. More...
 

Detailed Description

Skill FSM Graph Viewport.

Author
Tim Niemueller

Definition at line 34 of file graph_viewport.h.

Constructor & Destructor Documentation

◆ SkillGuiGraphViewport()

SkillGuiGraphViewport::SkillGuiGraphViewport ( )

Constructor.

Definition at line 34 of file graph_viewport.cpp.

References on_expose(), and render().

◆ ~SkillGuiGraphViewport()

SkillGuiGraphViewport::~SkillGuiGraphViewport ( )

Destructor.

Definition at line 95 of file graph_viewport.cpp.

Member Function Documentation

◆ add_drawable()

void SkillGuiGraphViewport::add_drawable ( Papyrus::Drawable::pointer  d)

Add a drawable.

To be called only by the Graphviz plugin.

Parameters
ddrawable to add

Definition at line 140 of file graph_viewport.cpp.

◆ clear()

void SkillGuiGraphViewport::clear ( void  )
virtual

Clear all drawables.

To be called only by the Graphviz plugin.

Definition at line 151 of file graph_viewport.cpp.

Referenced by render().

◆ get_affine()

Papyrus::AffineController::pointer SkillGuiGraphViewport::get_affine ( )

Get scaler.

Returns
scaler controller

Definition at line 308 of file graph_viewport.cpp.

◆ get_update_graph()

bool SkillGuiGraphViewport::get_update_graph ( )

Check if graph is being updated.

Returns
true if the graph will be update if new data is received, false otherwise

Definition at line 211 of file graph_viewport.cpp.

◆ on_expose()

void SkillGuiGraphViewport::on_expose ( GdkEventExpose *  event)
protected

Called on explose.

Parameters
eventGdk event structure

Definition at line 398 of file graph_viewport.cpp.

Referenced by SkillGuiGraphViewport().

◆ render()

void SkillGuiGraphViewport::render ( )

Render current graph.

Definition at line 371 of file graph_viewport.cpp.

References clear().

Referenced by SkillGuiGraphViewport().

◆ save()

void SkillGuiGraphViewport::save ( )

Render current graph.

Definition at line 315 of file graph_viewport.cpp.

Referenced by SkillGuiGtkWindow::SkillGuiGtkWindow().

◆ scale_override()

bool SkillGuiGraphViewport::scale_override ( )

Check if scale override is enabled.

Returns
true if scale override is enabled, false otherwise

Definition at line 298 of file graph_viewport.cpp.

◆ set_bb()

void SkillGuiGraphViewport::set_bb ( double  bbw,
double  bbh 
)

Set bounding box.

To be called only by the Graphviz plugin.

Parameters
bbwbounding box width
bbhbounding box height

Definition at line 164 of file graph_viewport.cpp.

◆ set_graph()

void SkillGuiGraphViewport::set_graph ( std::string  graph)

Set graph.

Parameters
graphstring representation of the current graph in the dot language.

Definition at line 129 of file graph_viewport.cpp.

◆ set_graph_fsm()

void SkillGuiGraphViewport::set_graph_fsm ( std::string  fsm_name)

Set graph's FSM name.

Parameters
fsm_namename of FSM the graph belongs to

Definition at line 116 of file graph_viewport.cpp.

◆ set_gvjob()

void SkillGuiGraphViewport::set_gvjob ( GVJ_t *  job)

Set current Graphviz job.

Parameters
jobcurrent Graphviz job

Definition at line 106 of file graph_viewport.cpp.

◆ set_pad()

void SkillGuiGraphViewport::set_pad ( double  pad_x,
double  pad_y 
)

Set padding.

To be called only by the Graphviz plugin.

Parameters
pad_xpadding in x
pad_ypadding in y

Definition at line 177 of file graph_viewport.cpp.

◆ set_scale()

void SkillGuiGraphViewport::set_scale ( double  scale)

Set scale.

To be called only by the Graphviz plugin.

Parameters
scalescale value

Definition at line 202 of file graph_viewport.cpp.

◆ set_translation()

void SkillGuiGraphViewport::set_translation ( double  tx,
double  ty 
)

Set translation.

To be called only by the Graphviz plugin.

Parameters
txtranslation in x
tytranslation in y

Definition at line 190 of file graph_viewport.cpp.

◆ set_update_graph()

void SkillGuiGraphViewport::set_update_graph ( bool  update)

Set if the graph should be updated on new data.

Parameters
updatetrue to update on new data, false to disable update

Definition at line 221 of file graph_viewport.cpp.

◆ zoom_fit()

void SkillGuiGraphViewport::zoom_fit ( )

Zoom to fit.

Disables scale override and draws with values suggested by Graphviz plugin.

Definition at line 269 of file graph_viewport.cpp.

Referenced by SkillGuiGtkWindow::SkillGuiGtkWindow().

◆ zoom_in()

void SkillGuiGraphViewport::zoom_in ( )

Zoom in.

Sets scale override and increases the scale by 0.1.

Definition at line 231 of file graph_viewport.cpp.

Referenced by SkillGuiGtkWindow::SkillGuiGtkWindow().

◆ zoom_out()

void SkillGuiGraphViewport::zoom_out ( )

Zoom out.

Sets scale override and decreases the scale by 0.1.

Definition at line 250 of file graph_viewport.cpp.

Referenced by SkillGuiGtkWindow::SkillGuiGtkWindow().

◆ zoom_reset()

void SkillGuiGraphViewport::zoom_reset ( )

Zoom reset.

Reset zoom to 1. Enables scale override.

Definition at line 282 of file graph_viewport.cpp.

Referenced by SkillGuiGtkWindow::SkillGuiGtkWindow().


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