PlaneGeometry QML Type

Provides geometry for a plane. More...

Import Statement: import QtQuick3D.Helpers
Since: Qt 6.9
Inherits:

Geometry

Properties

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.

ConstantDescription
PlaneGeometry.XYThe plane is oriented along the XY plane.
PlaneGeometry.XZThe plane is oriented along the XZ plane.
PlaneGeometry.ZYThe 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.

ConstantDescription
PlaneGeometry.NullThe geometry generation has not started
PlaneGeometry.ReadyThe geometry generation is complete.
PlaneGeometry.LoadingThe geometry generation is in progress.
PlaneGeometry.ErrorThe geometry generation failed.

width : real

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


© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.