Helios++
Helios software for LiDAR simulations
visualhelios::VHCanvas Class Reference

Visual Helios Canvas is a class which provides the base mechanisms to implement Helios visualizations. More...

#include <VHCanvas.h>

Inheritance diagram for visualhelios::VHCanvas:
Collaboration diagram for visualhelios::VHCanvas:

Public Member Functions

 VHCanvas ()
 Default constructor for the visual helios canvas.
 
 VHCanvas (string const title)
 Constructor for the visual helios canvas which allows for title specification. More...
 
virtual void show ()
 Make the visualization effective.
 
int getTimeBetweenUpdates () const
 Obtain milliseconds between canvas updates. More...
 
void setTimeBetweenUpdates (int const timeBetweenUpdates)
 Set the milliseconds between canvas updates. More...
 
bool isForceRedraw () const
 Check if force redraw is enabled or not. More...
 
void setForceRedraw (bool const forceRedraw)
 Enable or disable force redraw. More...
 
string const & getTitle () const
 Obtain the visual helios canvas title. More...
 

Protected Member Functions

virtual void configure ()
 Configure method where visualizer configuration must be implemented.
 
virtual void start ()
 Start method which initializes the visualization.
 
virtual void update ()
 Update method which handles graphics updating over time.
 
virtual void postUpdate ()
 Post-update method which handles the behavior of the canvas immediately after the update stage has been computed.
 
virtual void onStop ()
 Method to handle the behavior of the canvas after visualization has finished.
 

Protected Attributes

string const title
 The title of the visual Helios canvas.
 
PCLVisualizer::Ptr viewer
 The PCL visualizer which is used to render graphics.
 
int timeBetweenUpdates
 How many milliseconds must elapsed between canvas updates.
 
bool forceRedraw
 Force redraw even when it is not required if true. Try to avoid unnecessary redraws if false.
 

Detailed Description

Visual Helios Canvas is a class which provides the base mechanisms to implement Helios visualizations.

Author
Alberto M. Esmoris Pena
Version
1.0

The visual helios canvas is based on PCL and VTK libraries. Its workflow can be triggered by the user calling the show method and it is as follows: configure -> start -> update while non stopped -> onstop

Constructor & Destructor Documentation

◆ VHCanvas()

VHCanvas::VHCanvas ( string const  title)

Constructor for the visual helios canvas which allows for title specification.

Parameters
titleTitle for the visualizer

Member Function Documentation

◆ getTimeBetweenUpdates()

int visualhelios::VHCanvas::getTimeBetweenUpdates ( ) const
inline

Obtain milliseconds between canvas updates.

Returns
Milliseconds between canvas updates
See also
VHCanvas::timeBetweenUpdates

◆ getTitle()

string const& visualhelios::VHCanvas::getTitle ( ) const
inline

Obtain the visual helios canvas title.

Returns
Visual helios canvas title

◆ isForceRedraw()

bool visualhelios::VHCanvas::isForceRedraw ( ) const
inline

Check if force redraw is enabled or not.

Returns
True if force redraw is enabled, false otherwise
See also
VHCanvas::forceRedraw

◆ setForceRedraw()

void visualhelios::VHCanvas::setForceRedraw ( bool const  forceRedraw)
inline

Enable or disable force redraw.

Parameters
forceRedrawTrue to enable force redraw, false to disable it
See also
VHCanvas::forceRedraw

◆ setTimeBetweenUpdates()

void visualhelios::VHCanvas::setTimeBetweenUpdates ( int const  timeBetweenUpdates)
inline

Set the milliseconds between canvas updates.

Parameters
timeBetweenUpdatesHow many milliseconds must elapse between canvas updates
See also
VHCanvas::timeBetweenUpdates

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