- Qt 6.9
- Qt Quick 3D
- QML Types
- QtQuick3D.Helpers
- PlaneGeometry
- Qt Quick 3D | Commercial or GPLv3

# PlaneGeometry QML Type

Provides geometry for a plane. More...

Import Statement: | `import QtQuick3D.Helpers`
Since: | Qt 6.9
Inherits: | Geometry

- List of all members, including inherited members

## Properties

- asynchronous : bool
- height : real
- meshResolution : size
- mirrored : bool
- plane : PlaneGeometry::Plane
- reversed : bool
- status : bool
- width : real

## Detailed Description

PlaneGeometry is a geometry type that represents a plane. The plane's size is defined by its height and width properties. The topology of the plane is defined by the meshResolution property. The orientation of the plane is defined by the plane property.

## Property Documentation

asynchronous : bool

This property holds whether the geometry generation should be asynchronous.

height : real

The height of the plane. The default value is 100.0.

meshResolution : size

The resolution of the plane. The default value is QSize(2, 2).

mirrored : bool

This property holds whether the UV coordinates of the plane are flipped vertically.

plane : PlaneGeometry::Plane

The orientation of the plane. The default value is PlaneGeometry.XY. All geometry will be created along the selected plane, and the front face and normal will point towards the remaining positive axis, unless reversed is true.

Constant | Description
--- | ---
`PlaneGeometry.XY` | The plane is oriented along the XY plane.
`PlaneGeometry.XZ` | The plane is oriented along the XZ plane.
`PlaneGeometry.ZY` | The plane is oriented along the ZY plane.

reversed : bool

This property holds whether the plane is flipped. This changes both the normal as well as the winding order of the plane. The default value is false, which means that when a Plane is created with the XY orientation, the normal will point in the positive Z direction and the winding order will be counter-clockwise. When reversed is true, the normal will point in the negative Z direction and the winding order will be clockwise.

status : bool `[read-only]`

This property holds the status of the geometry generation when asynchronous is true.

Constant | Description
--- | ---
`PlaneGeometry.Null` | The geometry generation has not started
`PlaneGeometry.Ready` | The geometry generation is complete.
`PlaneGeometry.Loading` | The geometry generation is in progress.
`PlaneGeometry.Error` | The geometry generation failed.

width : real

The width of the plane. The default value is 100.0.