QPlaneGeometry Class | Qt 3D 5.12.10

- Qt 5.12
- Qt 3D
- C++ Classes
- QPlaneGeometry
- Qt 5.12.10 Reference Documentation

# QPlaneGeometry Class

(Qt3DExtras::QPlaneGeometry)

The QPlaneGeometry class allows creation of a plane in 3D space. * * * * The QPlaneGeometry class is most commonly used internally by the QPlaneMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses. More...

Header: | #include <Qt3DExtras/QPlaneGeometry>
qmake: | QT += 3dextras
Since: | Qt 5.7
Instantiated By: | PlaneGeometry
Inherits: | Qt3DRender::QGeometry

- List of all members, including inherited members
- Obsolete members

## Properties

- height : float
- indexAttribute : Qt3DRender::QAttribute* const
- mirrored : bool
- normalAttribute : Qt3DRender::QAttribute* const
- positionAttribute : Qt3DRender::QAttribute* const

- resolution : QSize
- tangentAttribute : Qt3DRender::QAttribute* const
- texCoordAttribute : Qt3DRender::QAttribute* const
- width : float

- 1 property inherited from Qt3DRender::QGeometry
- 3 properties inherited from Qt3DCore::QNode
- 1 property inherited from QObject

## Public Functions

| QPlaneGeometry(Qt3DCore::QNode *parent = nullptr)
float | height() const
Qt3DRender::QAttribute * | indexAttribute() const
bool | mirrored() const
Qt3DRender::QAttribute * | normalAttribute() const
Qt3DRender::QAttribute * | positionAttribute() const
QSize | resolution() const
Qt3DRender::QAttribute * | tangentAttribute() const
Qt3DRender::QAttribute * | texCoordAttribute() const
void | updateIndices()
void | updateVertices()
float | width() const

- 4 public functions inherited from Qt3DRender::QGeometry
- 13 public functions inherited from Qt3DCore::QNode
- 31 public functions inherited from QObject

## Public Slots

void | setHeight(float height)
void | setMirrored(bool mirrored)
void | setResolution(const QSize &resolution)
void | setWidth(float width)

- 1 public slot inherited from Qt3DRender::QGeometry
- 3 public slots inherited from Qt3DCore::QNode
- 1 public slot inherited from QObject

## Signals

void | heightChanged(float height)
void | mirroredChanged(bool mirrored)
void | resolutionChanged(const QSize &resolution)
void | widthChanged(float width)

- 1 signal inherited from Qt3DRender::QGeometry
- 4 signals inherited from Qt3DCore::QNode
- 2 signals inherited from QObject

## Static Public Members

const QMetaObject | staticMetaObject

- 9 static public members inherited from QObject

### Additional Inherited Members

- 2 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject

## Detailed Description

* * * *

The QPlaneGeometry class allows creation of a plane in 3D space. * * * * The QPlaneGeometry class is most commonly used internally by the QPlaneMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses.

## Property Documentation

### height : float

Holds the plane height.

Access functions:

float | height() const
void | setHeight(float height)

Notifier signal:

void | heightChanged(float height)

### indexAttribute : Qt3DRender::QAttribute* const

Holds the geometry index attribute.

Access functions:

Qt3DRender::QAttribute * | indexAttribute() const

### mirrored : bool

Controls if the UV coordinates of the plane should be flipped vertically.

This property was introduced in Qt 5.9.

Access functions:

bool | mirrored() const
void | setMirrored(bool mirrored)

Notifier signal:

void | mirroredChanged(bool mirrored)

### normalAttribute : Qt3DRender::QAttribute* const

Holds the geometry normal attribute.

Access functions:

Qt3DRender::QAttribute * | normalAttribute() const

### positionAttribute : Qt3DRender::QAttribute* const

Holds the geometry position attribute.

Access functions:

Qt3DRender::QAttribute * | positionAttribute() const

### resolution : QSize

Holds the plane resolution.

Access functions:

QSize | resolution() const
void | setResolution(const QSize &resolution)

Notifier signal:

void | resolutionChanged(const QSize &resolution)

### tangentAttribute : Qt3DRender::QAttribute* const

Holds the geometry tangent attribute.

Access functions:

Qt3DRender::QAttribute * | tangentAttribute() const

### texCoordAttribute : Qt3DRender::QAttribute* const

Holds the geometry texture coordinate attribute.

Access functions:

Qt3DRender::QAttribute * | texCoordAttribute() const

### width : float

Holds the plane width.

Access functions:

float | width() const
void | setWidth(float width)

Notifier signal:

void | widthChanged(float width)

## Member Function Documentation

### QPlaneGeometry::QPlaneGeometry(Qt3DCore::QNode *parent = nullptr)

Constructs a new QPlaneGeometry with parent.

### void QPlaneGeometry::updateIndices()

Updates indices based on mesh resolution.

### void QPlaneGeometry::updateVertices()

Updates vertices based on mesh resolution, width, and height properties.