The UserInterface class defines the methods and signals that a user interface needs to have. More...

#include <userinterface.h>

Inheritance diagram for cavapa_gui::UserInterface:

Protected Member Functions
virtual void	calculationCancelRequested ()=0
	Emitted when the user requests to cancel the calculation.

virtual void	calculationContinueRequested ()=0
	Emitted when the user requests to continue the calculation.

virtual void	calculationPauseRequested ()=0
	Emitted when the user requests to pause the calculation.

virtual void	calculationStartRequested ()=0
	Emitted when the user requests to start the calculation.

virtual void	calculationStopRequested ()=0
	Emitted when the user requests to stop the calculation.

virtual void	calibrationPointsReady (const std::vector< CalibrationPoint > &points)=0
	Emitted when the user has set all the calibration points. More...

virtual void	exportRequested (const ExportOptions &options)=0
	Emitted when the user requests to export data from the graph. More...

virtual void	generalSettingsChanged (const GeneralSettings &settings)=0
	Emitted when the user changes a general setting. More...

virtual void	graphPositionSelected (FrameTime time)=0
	Emitted when the user selects a position in the activity graph. More...

virtual void	locationChanged (int x, int y)=0
	Emitted when the interface is moved. More...

virtual void	markersReady (const std::vector< GraphMarker > &markers)=0
	Emitted when the user has placed all the markers. More...

virtual void	metadataOpened (const std::string &path)=0
	Emitted when the user requests to open a metadata file. More...

virtual void	metadataReady (const Metadata &metadata)=0
	Emitted when the user has input all the metadata. More...

virtual void	newMeasurementRequested ()=0
	Emitted when the user wants to start a new measurement.

virtual void	openMeasurementRequested (const std::string &path)=0
	Emitted when the user wants to open an existing measurement. More...

virtual void	redoMeasurementRequested ()=0
	Emitted when the user wants to redo the measurement.

virtual void	refreshRequested ()=0
	Emitted when the user requests to refresh cameras.

virtual void	sizeChanged (int width, int height, bool fullscreen)=0
	Emitted when the size of the interface changes. More...

virtual void	sourceAddRequested (const std::string &path)=0
	Emitted when the user adds a new video source. More...

virtual void	sourcePauseRequested (SourceID source)=0
	Emitted when the user requests to pause a source. More...

virtual void	sourcePlayRequested (SourceID source)=0
	Emitted when the user requests to play a source. More...

virtual void	sourceSeekRequested (SourceID source, FrameTime position)=0
	Emitted when the user requests to seek a source to a certain position. More...

virtual void	sourceRemoveRequested (SourceID source)=0
	Emitted when the user removes a source. More...

virtual void	sourceSettingsChanged (SourceID source, const SourceSettings &settings)=0
	Emitted when the user changes a setting for a source. More...

virtual void	sourceStepBackward (SourceID source)=0
	Emitted when the user steps a video one frame back. More...

virtual void	sourceStepForward (SourceID source)=0
	Emitted when the user steps a video one frame forward. More...

virtual void	statisticsRequested (FrameTime start, FrameTime stop, int points)=0
	Emitted when the user wants the frame statistics to be retrieved. More...

virtual void	interfaceClosed ()=0
	Emitted when the user closes the interface.

Friends
class	Controller

Detailed Description

The UserInterface class defines the methods and signals that a user interface needs to have.

Author: Mika Lehtinen

Member Function Documentation

virtual void cavapa_gui::UserInterface::calibrationPointsReady ( const std::vector< CalibrationPoint > & points )

protectedpure virtual

Emitted when the user has set all the calibration points.

Parameters

points The set of calibration points.

virtual void cavapa_gui::UserInterface::exportRequested ( const ExportOptions & options )

protectedpure virtual

Emitted when the user requests to export data from the graph.

Parameters

options The parameters for the export.

virtual void cavapa_gui::UserInterface::generalSettingsChanged ( const GeneralSettings & settings )

protectedpure virtual

Emitted when the user changes a general setting.

Parameters

settings The new GeneralSettings object.

virtual void cavapa_gui::UserInterface::graphPositionSelected ( FrameTime time )

protectedpure virtual

Emitted when the user selects a position in the activity graph.

Parameters

time	The time of the position.

virtual void cavapa_gui::UserInterface::locationChanged	(	int	x,
		int	y
	)

protectedpure virtual

Emitted when the interface is moved.

Parameters

x	The x-coordinate of the interface.
y	The y-coordinate of the interface.

virtual void cavapa_gui::UserInterface::markersReady ( const std::vector< GraphMarker > & markers )

protectedpure virtual

Emitted when the user has placed all the markers.

Parameters

markers The vector containing the markers.

Remarks: At the moment, this signal is emitted when the calculation completes.

virtual void cavapa_gui::UserInterface::metadataOpened ( const std::string & path )

protectedpure virtual

Emitted when the user requests to open a metadata file.

Parameters

path	The path of the file that was selected.

virtual void cavapa_gui::UserInterface::metadataReady ( const Metadata & metadata )

protectedpure virtual

Emitted when the user has input all the metadata.

Parameters

metadata The Metadata object representing the user input.

virtual void cavapa_gui::UserInterface::openMeasurementRequested ( const std::string & path )

protectedpure virtual

Emitted when the user wants to open an existing measurement.

Parameters

path	The path to the measurement's XML file.

virtual void cavapa_gui::UserInterface::sizeChanged	(	int	width,
		int	height,
		bool	fullscreen
	)

protectedpure virtual

Emitted when the size of the interface changes.

Parameters

width	The new width of the interface.
height	The new height of the interface.
fullscreen	Whether the interface is in fullscreen mode or not.

virtual void cavapa_gui::UserInterface::sourceAddRequested ( const std::string & path )

protectedpure virtual

Emitted when the user adds a new video source.

Parameters

path	The path of the source.

virtual void cavapa_gui::UserInterface::sourcePauseRequested ( SourceID source )

protectedpure virtual

Emitted when the user requests to pause a source.

Parameters

source The id of the source to be paused.

virtual void cavapa_gui::UserInterface::sourcePlayRequested ( SourceID source )

protectedpure virtual

Emitted when the user requests to play a source.

Parameters

source The id of the source to play.

virtual void cavapa_gui::UserInterface::sourceRemoveRequested ( SourceID source )

protectedpure virtual

Emitted when the user removes a source.

Parameters

source The source ID to be removed.

virtual void cavapa_gui::UserInterface::sourceSeekRequested	(	SourceID	source,
		FrameTime	position
	)

protectedpure virtual

Emitted when the user requests to seek a source to a certain position.

Parameters

source	The id of the source to be sought.
position	The requested position.

virtual void cavapa_gui::UserInterface::sourceSettingsChanged	(	SourceID	source,
		const SourceSettings &	settings
	)

protectedpure virtual

Emitted when the user changes a setting for a source.

Parameters

source	The source ID for which a setting was changed.
settings	The new settings for the source.

virtual void cavapa_gui::UserInterface::sourceStepBackward ( SourceID source )

protectedpure virtual

Emitted when the user steps a video one frame back.

Parameters

source The source that was stepped.

virtual void cavapa_gui::UserInterface::sourceStepForward ( SourceID source )

protectedpure virtual

Emitted when the user steps a video one frame forward.

Parameters

source The source that was stepped.

virtual void cavapa_gui::UserInterface::statisticsRequested	(	FrameTime	start,
		FrameTime	stop,
		int	points
	)

protectedpure virtual

Emitted when the user wants the frame statistics to be retrieved.

Parameters

start	The starting point of the period.
stop	The end point of the period.
points	The number of points desired to be returned.

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

userinterface.h

Protected Member Functions

Friends

Detailed Description

Member Function Documentation