VTK
Signals | Public Member Functions | List of all members
vtkQtChartSeriesSelectionModel Class Reference

The vtkQtChartSeriesSelectionModel class ties a series selection to a series model. More...

#include <vtkQtChartSeriesSelectionModel.h>

Public Slots

Model Modification Handlers
void beginModelReset ()
 Begins the model reset process.
void endModelReset ()
 Ends the model reset process.
void beginInsertSeries (int first, int last)
 Begins the series insertion process.
void endInsertSeries (int first, int last)
 Ends the series insertion process.
void beginRemoveSeries (int first, int last)
 Begins the series removal process.
void endRemoveSeries (int first, int last)
 Ends the series removal process.

Signals

void selectionChanged (const vtkQtChartSeriesSelection &list)
 Emitted when the selection changes.
void interactionFinished ()
 Emitted when an interactive selection change is finished.

Public Member Functions

 vtkQtChartSeriesSelectionModel (QObject *parent=0)
 Creates a series selection model.
virtual ~vtkQtChartSeriesSelectionModel ()
vtkQtChartSeriesModelgetModel () const
 Gets the series model associated with the selection model.
void setModel (vtkQtChartSeriesModel *model)
 Sets the series model associated with the selection model.
bool isInInteractiveChange () const
 Gets whether or not the selection model is in an interactive change.
void beginInteractiveChange ()
 Called to begin an interactive selection change.
void endInteractiveChange ()
 Called to end an interactive selection change.
bool isSelectionEmpty () const
 Gets whether or not the selection is empty.
const vtkQtChartSeriesSelectiongetSelection () const
 Gets the current selection.
void selectAllSeries ()
 Selects all the model series.
void selectAllPoints ()
 Selects all the model points.
void selectNone ()
 Clears the selection.
void selectInverse ()
 Inverts the selection.
void setSelection (const vtkQtChartSeriesSelection &selection)
 Sets the current selection.
void addSelection (const vtkQtChartSeriesSelection &selection)
 Adds to the current selection.
void subtractSelection (const vtkQtChartSeriesSelection &selection)
 Subtracts from the current selection.
void xorSelection (const vtkQtChartSeriesSelection &selection)
 Performs an exclusive or between the specified selection and the current selection.

Detailed Description

The vtkQtChartSeriesSelectionModel class ties a series selection to a series model.

Definition at line 38 of file vtkQtChartSeriesSelectionModel.h.

Constructor & Destructor Documentation

vtkQtChartSeriesSelectionModel::vtkQtChartSeriesSelectionModel ( QObject *  parent = 0)

Creates a series selection model.

Parameters
parentThe parent object.
virtual vtkQtChartSeriesSelectionModel::~vtkQtChartSeriesSelectionModel ( )
virtual

Member Function Documentation

vtkQtChartSeriesModel* vtkQtChartSeriesSelectionModel::getModel ( ) const
inline

Gets the series model associated with the selection model.

Returns
The series model associated with the selection model.

Definition at line 53 of file vtkQtChartSeriesSelectionModel.h.

void vtkQtChartSeriesSelectionModel::setModel ( vtkQtChartSeriesModel model)

Sets the series model associated with the selection model.

Parameters
modelThe new series model.
bool vtkQtChartSeriesSelectionModel::isInInteractiveChange ( ) const
inline

Gets whether or not the selection model is in an interactive change.

Returns
Trure if the selection model is in an interactive change.
See Also
vtkQtChartSeriesSelectionModel::beginInteractiveChange()

Definition at line 66 of file vtkQtChartSeriesSelectionModel.h.

void vtkQtChartSeriesSelectionModel::beginInteractiveChange ( )

Called to begin an interactive selection change.

Interactive selection changes such as a selection box can send a lot of change signals as the user drags the mouse around. The chart needs to update the selection based on those signals in order for the user to see the changes. If an expensive process is attached to the selection change signal, this can cause a visible slow-down in the application. This method allows the selection to keep the chart painter up to date while allowing the expensive process to delay execution.

The interactive controller should call this method before starting a change such as with a selection box. It should call the endInteractiveChange method when the interaction is done. The expensive process should listen to the selectionChanged and interactionFinished signals. The interactionFinished is emitted at the end of the interactive change. In order to keep track of non-interactive changes, the selectionChanged signal must be monitored. This signal will be emitted for every selection change. Therefore, the listening code should check to see if the model is in an interactive change before executing an expensive process.

void vtkQtChartSeriesSelectionModel::endInteractiveChange ( )

Called to end an interactive selection change.

See Also
vtkQtChartSeriesSelectionModel::beginInteractiveChange()
bool vtkQtChartSeriesSelectionModel::isSelectionEmpty ( ) const

Gets whether or not the selection is empty.

Returns
True if the selection is empty.
const vtkQtChartSeriesSelection& vtkQtChartSeriesSelectionModel::getSelection ( ) const

Gets the current selection.

Returns
A reference to the current selection.
void vtkQtChartSeriesSelectionModel::selectAllSeries ( )

Selects all the model series.

void vtkQtChartSeriesSelectionModel::selectAllPoints ( )

Selects all the model points.

void vtkQtChartSeriesSelectionModel::selectNone ( )

Clears the selection.

void vtkQtChartSeriesSelectionModel::selectInverse ( )

Inverts the selection.

void vtkQtChartSeriesSelectionModel::setSelection ( const vtkQtChartSeriesSelection selection)

Sets the current selection.

Parameters
selectionThe new selection.
void vtkQtChartSeriesSelectionModel::addSelection ( const vtkQtChartSeriesSelection selection)

Adds to the current selection.

Parameters
selectionThe selection to add.
void vtkQtChartSeriesSelectionModel::subtractSelection ( const vtkQtChartSeriesSelection selection)

Subtracts from the current selection.

Parameters
selectionThe selection to subtract.
void vtkQtChartSeriesSelectionModel::xorSelection ( const vtkQtChartSeriesSelection selection)

Performs an exclusive or between the specified selection and the current selection.

Parameters
selectionThe selection to modify the current selection.
void vtkQtChartSeriesSelectionModel::selectionChanged ( const vtkQtChartSeriesSelection list)
signal

Emitted when the selection changes.

Parameters
listThe list of selected series/points.
void vtkQtChartSeriesSelectionModel::interactionFinished ( )
signal

Emitted when an interactive selection change is finished.

This signal can be used to delay expensive processes until after the selection change is complete.

See Also
vtkQtChartSeriesSelectionModel::beginInteractiveChange()
void vtkQtChartSeriesSelectionModel::beginModelReset ( )
slot

Begins the model reset process.

The selection model is cleared. The selection changed signal is emitted when the model finishes resetting.

void vtkQtChartSeriesSelectionModel::endModelReset ( )
slot

Ends the model reset process.

void vtkQtChartSeriesSelectionModel::beginInsertSeries ( int  first,
int  last 
)
slot

Begins the series insertion process.

The indexes for the series in the selection model are updated to reflect the changes. The selection changed signal is emitted when the insertion is completed.

Parameters
firstThe first index of the insertion range.
lastThe last index of the insertion range.
void vtkQtChartSeriesSelectionModel::endInsertSeries ( int  first,
int  last 
)
slot

Ends the series insertion process.

Parameters
firstThe first index of the insertion range.
lastThe last index of the insertion range.
void vtkQtChartSeriesSelectionModel::beginRemoveSeries ( int  first,
int  last 
)
slot

Begins the series removal process.

Any reference to the removed range is deleted from the selection model. The selection indexes are updated to reflect the change. The selection changed signal is emitted when the removal is completed.

Parameters
firstThe first index of the removal range.
lastThe last index of the removal range.
void vtkQtChartSeriesSelectionModel::endRemoveSeries ( int  first,
int  last 
)
slot

Ends the series removal process.

Parameters
firstThe first index of the removal range.
lastThe last index of the removal range.

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