vtkQtChartSeriesLayer Class Reference

#include <vtkQtChartSeriesLayer.h>

Inheritance diagram for vtkQtChartSeriesLayer:

Inheritance graph
[legend]
Collaboration diagram for vtkQtChartSeriesLayer:

Collaboration graph
[legend]

List of all members.


Detailed Description

The vtkQtChartSeriesLayer class is the base class for chart layers that use the chart series model.

It stores the pointer to the chart series model and the list of options for the series. The series options are created using the createOptions method. Subclasses should overload this method to create the appropriate type of options object.

Definition at line 49 of file vtkQtChartSeriesLayer.h.


Public Types

enum  { Type = vtkQtChart_SeriesLayerType }

Public Slots

void setXOffset (float offset)
 Sets the contents x-axis offset.
void setYOffset (float offset)
 Sets the contents y-axis offset.
void resetSeriesOptions ()
 Resets the series options for the model.

Signals

void modelChanged (vtkQtChartSeriesModel *previous, vtkQtChartSeriesModel *current)
 Emitted when the series model is changed.
void modelSeriesChanged (int first, int last)
 Emitted when the name or icon changes for a set of series.
void modelSeriesVisibilityChanged (int series, bool visible)
 Emitted when the visibility for a series has changed.

Public Member Functions

 vtkQtChartSeriesLayer (bool useContents=true)
virtual ~vtkQtChartSeriesLayer ()
virtual void setChartArea (vtkQtChartArea *area)
 Sets the chart area for the chart layer.
vtkQtChartSeriesModelgetModel () const
 Gets the chart series model.
virtual void setModel (vtkQtChartSeriesModel *model)
 Sets the chart series model.
vtkQtChartSeriesOptionsgetSeriesOptions (int series) const
 Gets the drawing options for the given series.
int getSeriesOptionsIndex (vtkQtChartSeriesOptions *options) const
 Gets the index for the given series options.
virtual QPixmap getSeriesIcon (int series) const
 Gets the icon for a given series.
vtkQtChartSeriesSelectionModelgetSelectionModel () const
 Gets the chart series selection model.
virtual void getSeriesAt (const QPointF &point, vtkQtChartSeriesSelection &selection) const
 Gets the list of series at a given position.
virtual void getPointsAt (const QPointF &point, vtkQtChartSeriesSelection &selection) const
 Gets the list of points at a given position.
virtual void getSeriesIn (const QRectF &area, vtkQtChartSeriesSelection &selection) const
 Gets the list of series in a given area.
virtual void getPointsIn (const QRectF &area, vtkQtChartSeriesSelection &selection) const
 Gets the list of points in a given area.

Protected Member Functions

virtual vtkQtChartSeriesOptionscreateOptions (QObject *parent)=0
 Creates an options object for a series.
virtual void setupOptions (vtkQtChartSeriesOptions *options)=0
 Sets up the options object.

Protected Attributes

vtkQtChartSeriesSelectionModelSelection
 Stores the series/point selection.
vtkQtChartSeriesModelModel
 Stores the series model.
vtkQtChartContentsAreaContents
 Used for panning.

Member Enumeration Documentation

anonymous enum

Enumerator:
Type 

Definition at line 54 of file vtkQtChartSeriesLayer.h.


Constructor & Destructor Documentation

vtkQtChartSeriesLayer::vtkQtChartSeriesLayer ( bool  useContents = true  ) 

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

Definition at line 58 of file vtkQtChartSeriesLayer.h.


Member Function Documentation

virtual void vtkQtChartSeriesLayer::setChartArea ( vtkQtChartArea area  )  [virtual]

Sets the chart area for the chart layer.

If the model is set before the chart layer is added to a chart area, series options will not be available. Setting the chart area will create the series options for the model in this case. Subclasses can extend this method to handle the new options.

Parameters:
area The new chart area.

Reimplemented from vtkQtChartLayer.

Reimplemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

vtkQtChartSeriesModel* vtkQtChartSeriesLayer::getModel (  )  const [inline]

Gets the chart series model.

Returns:
A pointer to the chart series model.

Definition at line 75 of file vtkQtChartSeriesLayer.h.

virtual void vtkQtChartSeriesLayer::setModel ( vtkQtChartSeriesModel model  )  [virtual]

Sets the chart series model.

Parameters:
model The new chart series model.

Reimplemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

vtkQtChartSeriesOptions* vtkQtChartSeriesLayer::getSeriesOptions ( int  series  )  const

Gets the drawing options for the given series.

Parameters:
series The index of the series.
Returns:
A pointer to the drawing options for the given series.

int vtkQtChartSeriesLayer::getSeriesOptionsIndex ( vtkQtChartSeriesOptions options  )  const

Gets the index for the given series options.

Parameters:
options The series options object.
Returns:
The index for the given series options.

virtual QPixmap vtkQtChartSeriesLayer::getSeriesIcon ( int  series  )  const [virtual]

Gets the icon for a given series.

The icon is used by the chart legend.

Parameters:
series The index of the series.
Returns:
A pixmap representation of the series.

Reimplemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

vtkQtChartSeriesSelectionModel* vtkQtChartSeriesLayer::getSelectionModel (  )  const

Gets the chart series selection model.

Returns:
A pointer to the chart series selection model.

virtual void vtkQtChartSeriesLayer::getSeriesAt ( const QPointF &  point,
vtkQtChartSeriesSelection selection 
) const [virtual]

Gets the list of series at a given position.

Parameters:
point The position in scene coordinates.
selection Used to return the list of series.

Reimplemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

virtual void vtkQtChartSeriesLayer::getPointsAt ( const QPointF &  point,
vtkQtChartSeriesSelection selection 
) const [virtual]

Gets the list of points at a given position.

Parameters:
point The position in scene coordinates.
selection Used to return the list of points.

Reimplemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

virtual void vtkQtChartSeriesLayer::getSeriesIn ( const QRectF &  area,
vtkQtChartSeriesSelection selection 
) const [virtual]

Gets the list of series in a given area.

Parameters:
area The rectangle in scene coordinates.
selection Used to return the list of series.

Reimplemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

virtual void vtkQtChartSeriesLayer::getPointsIn ( const QRectF &  area,
vtkQtChartSeriesSelection selection 
) const [virtual]

Gets the list of points in a given area.

Parameters:
area The rectangle in scene coordinates.
selection Used to return the list of points.

Reimplemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

void vtkQtChartSeriesLayer::setXOffset ( float  offset  )  [slot]

Sets the contents x-axis offset.

Parameters:
offset The new x-axis offset.

void vtkQtChartSeriesLayer::setYOffset ( float  offset  )  [slot]

Sets the contents y-axis offset.

Parameters:
offset The new y-axis offset.

void vtkQtChartSeriesLayer::resetSeriesOptions (  )  [slot]

Resets the series options for the model.

void vtkQtChartSeriesLayer::modelChanged ( vtkQtChartSeriesModel previous,
vtkQtChartSeriesModel current 
) [signal]

Emitted when the series model is changed.

Parameters:
previous The previous series model.
current The current series model.

void vtkQtChartSeriesLayer::modelSeriesChanged ( int  first,
int  last 
) [signal]

Emitted when the name or icon changes for a set of series.

Parameters:
first The first series index of the range.
last The last series index of the range.

void vtkQtChartSeriesLayer::modelSeriesVisibilityChanged ( int  series,
bool  visible 
) [signal]

Emitted when the visibility for a series has changed.

Parameters:
series The index of the series.
visible True if the series is visible.

virtual vtkQtChartSeriesOptions* vtkQtChartSeriesLayer::createOptions ( QObject *  parent  )  [protected, pure virtual]

Creates an options object for a series.

Note:
Subclasses should only create the options in this method. Use the setupOptions to set up connections.
Parameters:
parent The parent of the options object.
Returns:
A pointer to a new options object.
See also:
vtkQtChaerSeriesLayer::setupOptions(vtkQtChartSeriesOptions *)

Implemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

virtual void vtkQtChartSeriesLayer::setupOptions ( vtkQtChartSeriesOptions options  )  [protected, pure virtual]

Sets up the options object.

The style has been reserved and set before this method is called. Signal connections should be set up here in order to avoid slot calls during setup.

Parameters:
options The newly created series options.

Implemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.


Member Data Documentation

Stores the series/point selection.

Definition at line 216 of file vtkQtChartSeriesLayer.h.

Stores the series model.

Definition at line 217 of file vtkQtChartSeriesLayer.h.

Used for panning.

Definition at line 218 of file vtkQtChartSeriesLayer.h.


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

Generated on Wed Jun 3 19:28:33 2009 for VTK by  doxygen 1.5.6