Qt 5.7 | Qt Data Visualization | C++ Classes | QAbstract3DSeries

Qt 5.7.1 Reference Documentation

# QAbstract3DSeries Class

Base class for all QtDataVisualization series. More...

Header: | #include <QAbstract3DSeries>
Since: | QtDataVisualization 1.0
Instantiated By: | Abstract3DSeries
Inherited By: | QBar3DSeries, QScatter3DSeries, and QSurface3DSeries

- List of all members, including inherited members

## Public Types

enum | Mesh { MeshUserDefined, MeshBar, MeshCube, MeshPyramid, ..., MeshPoint }
enum | SeriesType { SeriesTypeNone, SeriesTypeBar, SeriesTypeScatter, SeriesTypeSurface }

## Properties

- baseColor : QColor
- baseGradient : QLinearGradient
- colorStyle : QtDataVisualization::Q3DTheme::ColorStyle
- itemLabel : const QString
- itemLabelFormat : QString
- itemLabelVisible : bool
- mesh : Mesh
- meshRotation : QQuaternion
- meshSmooth : bool

- multiHighlightColor : QColor
- multiHighlightGradient : QLinearGradient
- name : QString
- singleHighlightColor : QColor
- singleHighlightGradient : QLinearGradient
- type : const SeriesType
- userDefinedMesh : QString
- visible : bool

## Public Functions

virtual | ~QAbstract3DSeries()
QColor | baseColor() const
QLinearGradient | baseGradient() const
Q3DTheme::ColorStyle | colorStyle() const
bool | isItemLabelVisible() const
bool | isMeshSmooth() const
bool | isVisible() const
QString | itemLabel() const
QString | itemLabelFormat() const
Mesh | mesh() const
QQuaternion | meshRotation() const
QColor | multiHighlightColor() const
QLinearGradient | multiHighlightGradient() const
QString | name() const
void | setBaseColor(const QColor &color)
void | setBaseGradient(const QLinearGradient &gradient)
void | setColorStyle(Q3DTheme::ColorStyle style)
void | setItemLabelFormat(const QString &format)
void | setItemLabelVisible(bool visible)
void | setMesh(Mesh mesh)
void | setMeshAxisAndAngle(const QVector3D &axis, float angle)
void | setMeshRotation(const QQuaternion &rotation)
void | setMeshSmooth(bool enable)
void | setMultiHighlightColor(const QColor &color)
void | setMultiHighlightGradient(const QLinearGradient &gradient)
void | setName(const QString &name)
void | setSingleHighlightColor(const QColor &color)
void | setSingleHighlightGradient(const QLinearGradient &gradient)
void | setUserDefinedMesh(const QString &fileName)
void | setVisible(bool visible)
QColor | singleHighlightColor() const
QLinearGradient | singleHighlightGradient() const
SeriesType | type() const
QString | userDefinedMesh() const

## Signals

void | baseColorChanged(const QColor &color)
void | baseGradientChanged(const QLinearGradient &gradient)
void | colorStyleChanged(Q3DTheme::ColorStyle style)
void | itemLabelChanged(const QString &label)
void | itemLabelFormatChanged(const QString &format)
void | itemLabelVisibilityChanged(bool visible)
void | meshChanged(QAbstract3DSeries::Mesh mesh)
void | meshRotationChanged(const QQuaternion &rotation)
void | meshSmoothChanged(bool enabled)
void | multiHighlightColorChanged(const QColor &color)
void | multiHighlightGradientChanged(const QLinearGradient &gradient)
void | nameChanged(const QString &name)
void | singleHighlightColorChanged(const QColor &color)
void | singleHighlightGradientChanged(const QLinearGradient &gradient)
void | userDefinedMeshChanged(const QString &fileName)
void | visibilityChanged(bool visible)

## Detailed Description

Base class for all QtDataVisualization series.

You use the visualization type specific inherited classes instead of the base class.

See also QBar3DSeries, QScatter3DSeries, QSurface3DSeries, and Qt Data Visualization Data Handling.

## Member Type Documentation

### enum QAbstract3DSeries::Mesh

Predefined mesh types. All styles are not usable with all visualization types.

Constant | Value | Description
--- | --- | ---
`QAbstract3DSeries::MeshUserDefined` | `0` | User defined mesh, set via QAbstract3DSeries::userDefinedMesh property.
`QAbstract3DSeries::MeshBar` | `1` | Basic rectangular bar.
`QAbstract3DSeries::MeshCube` | `2` | Basic cube.
`QAbstract3DSeries::MeshPyramid` | `3` | Four-sided pyramid.
`QAbstract3DSeries::MeshCone` | `4` | Basic cone.
`QAbstract3DSeries::MeshCylinder` | `5` | Basic cylinder.
`QAbstract3DSeries::MeshBevelBar` | `6` | Slightly beveled (rounded) rectangular bar.
`QAbstract3DSeries::MeshBevelCube` | `7` | Slightly beveled (rounded) cube.
`QAbstract3DSeries::MeshSphere` | `8` | Sphere.
`QAbstract3DSeries::MeshMinimal` | `9` | The minimal 3D mesh: a triangular pyramid. Usable only with Q3DScatter.
`QAbstract3DSeries::MeshArrow` | `10` | Arrow pointing upwards.
`QAbstract3DSeries::MeshPoint` | `11` | 2D point. Usable only with Q3DScatter. Note: Shadows do not affect this style. Color style Q3DTheme::ColorStyleObjectGradient is not supported by this style.

### enum QAbstract3DSeries::SeriesType

Type of the series.

Constant | Value | Description
--- | --- | ---
`QAbstract3DSeries::SeriesTypeNone` | `0` | No series type.
`QAbstract3DSeries::SeriesTypeBar` | `1` | Series type for Q3DBars.
`QAbstract3DSeries::SeriesTypeScatter` | `2` | Series type for Q3DScatter.
`QAbstract3DSeries::SeriesTypeSurface` | `4` | Series type for Q3DSurface.

## Property Documentation

### baseColor : QColor

Sets the base color of the series. See Q3DTheme::baseColors documentation for more information.

Access functions:

QColor | baseColor() const
void | setBaseColor(const QColor &color)

Notifier signal:

void | baseColorChanged(const QColor &color)

See also colorStyle.

### baseGradient : QLinearGradient

Sets the base gradient of the series. See Q3DTheme::baseGradients documentation for more information.

Access functions:

QLinearGradient | baseGradient() const
void | setBaseGradient(const QLinearGradient &gradient)

Notifier signal:

void | baseGradientChanged(const QLinearGradient &gradient)

See also colorStyle.

### colorStyle : QtDataVisualization::Q3DTheme::ColorStyle

Sets the color style for the series. See Q3DTheme::ColorStyle documentation for more information.

Access functions:

Q3DTheme::ColorStyle | colorStyle() const
void | setColorStyle(Q3DTheme::ColorStyle style)

Notifier signal:

void | colorStyleChanged(Q3DTheme::ColorStyle style)

### itemLabel : const QString

Contains the formatted item label. If there is no selected item or the selected item is not visible, returns an empty string.

This property was introduced in QtDataVisualization 1.1.

Access functions:

QString | itemLabel() const

Notifier signal:

void | itemLabelChanged(const QString &label)

See also itemLabelFormat.

### itemLabelFormat : QString

Sets label format for data items in this series. This format is used for single item labels, for example, when an item is selected. How the format is interpreted depends on series type. See each series class documentation for more information.

Access functions:

QString | itemLabelFormat() const
void | setItemLabelFormat(const QString &format)

Notifier signal:

void | itemLabelFormatChanged(const QString &format)

See also QBar3DSeries, QScatter3DSeries, and QSurface3DSeries.

### itemLabelVisible : bool

If `true`, item labels are drawn as floating labels in the graph. Otherwise item labels are not drawn. If you prefer to show the item label in an external control, set this property to `false`. Defaults to `true`.

This property was introduced in QtDataVisualization 1.1.

Access functions:

bool | isItemLabelVisible() const
void | setItemLabelVisible(bool visible)

Notifier signal:

void | itemLabelVisibilityChanged(bool visible)

See also itemLabelFormat and itemLabel.

### mesh : Mesh

Sets the mesh of the items in the series, or the selection pointer in case of QSurface3DSeries. If the mesh is MeshUserDefined, then the userDefinedMesh property must also be set for items to render properly. The default value depends on the graph type.

Access functions:

Mesh | mesh() const
void | setMesh(Mesh mesh)

Notifier signal:

void | meshChanged(QAbstract3DSeries::Mesh mesh)

### meshRotation : QQuaternion

Sets the mesh rotation that is applied to all items of the series. The rotation should be a normalized QQuaternion. For those series types that support item specific rotation, the rotations are multiplied together. QBar3DSeries ignores any rotation that is not around Y-axis. QSurface3DSeries applies the rotation only to the selection pointer. Defaults to no rotation.

Access functions:

QQuaternion | meshRotation() const
void | setMeshRotation(const QQuaternion &rotation)

Notifier signal:

void | meshRotationChanged(const QQuaternion &rotation)

### meshSmooth : bool

If enable is `true`, smooth versions of predefined meshes set via mesh property are used. This property doesn't affect custom meshes used when mesh is MeshUserDefined. Defaults to `false`.

Access functions:

bool | isMeshSmooth() const
void | setMeshSmooth(bool enable)

Notifier signal:

void | meshSmoothChanged(bool enabled)

### multiHighlightColor : QColor

Sets the multiple item highlight color of the series. See Q3DTheme::multiHighlightColor documentation for more information.

Access functions:

QColor | multiHighlightColor() const
void | setMultiHighlightColor(const QColor &color)

Notifier signal:

void | multiHighlightColorChanged(const QColor &color)

See also colorStyle.

### multiHighlightGradient : QLinearGradient

Sets the multiple item highlight gradient of the series. See Q3DTheme::multiHighlightGradient documentation for more information.

Access functions:

QLinearGradient | multiHighlightGradient() const
void | setMultiHighlightGradient(const QLinearGradient &gradient)

Notifier signal:

void | multiHighlightGradientChanged(const QLinearGradient &gradient)

See also colorStyle.

### name : QString

Sets the series name. Series name can be used in item label format with tag `@seriesName`.

Access functions:

QString | name() const
void | setName(const QString &name)

Notifier signal:

void | nameChanged(const QString &name)

See also itemLabelFormat.

### singleHighlightColor : QColor

Sets the single item highlight color of the series. See Q3DTheme::singleHighlightColor documentation for more information.

Access functions:

QColor | singleHighlightColor() const
void | setSingleHighlightColor(const QColor &color)

Notifier signal:

void | singleHighlightColorChanged(const QColor &color)

See also colorStyle.

### singleHighlightGradient : QLinearGradient

Sets the single item highlight gradient of the series. See Q3DTheme::singleHighlightGradient documentation for more information.

Access functions:

QLinearGradient | singleHighlightGradient() const
void | setSingleHighlightGradient(const QLinearGradient &gradient)

Notifier signal:

void | singleHighlightGradientChanged(const QLinearGradient &gradient)

See also colorStyle.

### type : const SeriesType

The type of the series.

Access functions:

SeriesType | type() const

### userDefinedMesh : QString

Sets the fileName for user defined custom mesh for objects that is used when mesh is MeshUserDefined.

Note: The file specified by fileName needs to be in Wavefront obj format and include vertices, normals and UVs. It also needs to be in triangles.

Access functions:

QString | userDefinedMesh() const
void | setUserDefinedMesh(const QString &fileName)

Notifier signal:

void | userDefinedMeshChanged(const QString &fileName)

### visible : bool

Sets the visibility of the series. If visible is false, the series is not rendered. Defaults to `true`.

Access functions:

bool | isVisible() const
void | setVisible(bool visible)

Notifier signal:

void | visibilityChanged(bool visible)

## Member Function Documentation

### `[virtual]` QAbstract3DSeries::~QAbstract3DSeries()

Destroys QAbstract3DSeries.

### void QAbstract3DSeries::setMeshAxisAndAngle(const QVector3D &axis, float angle)

A convenience function to construct mesh rotation quaternion from axis and angle.

See also meshRotation.