Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
PlaneGeometry Class Reference

#include <planegeometry_p.h>

Inheritance diagram for PlaneGeometry:
Collaboration diagram for PlaneGeometry:

Public Types

enum  Status { Null , Ready , Loading , Error }
enum  Plane { XY , XZ , ZY }
Public Types inherited from QQuick3DGeometry
enum class  PrimitiveType {
  Points , LineStrip , Lines , TriangleStrip ,
  TriangleFan , Triangles
}

Signals

void widthChanged ()
void heightChanged ()
void meshResolutionChanged ()
void planeChanged ()
void mirroredChanged ()
void asynchronousChanged ()
void statusChanged ()
void reversedChanged ()
Signals inherited from QQuick3DGeometry
void geometryNodeDirty ()
 Q_REVISION (6, 7) void geometryChanged()
Signals inherited from QQuick3DObject
void parentChanged ()
void childrenChanged ()
void stateChanged ()
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.

Public Member Functions

 PlaneGeometry (QQuick3DObject *parent=nullptr)
 \qmltype PlaneGeometry \inqmlmodule QtQuick3D.Helpers \inherits Geometry
 ~PlaneGeometry () override
float width () const
void setWidth (float newWidth)
float height () const
void setHeight (float newHeight)
QSize meshResolution () const
void setMeshResolution (const QSize &newMeshResolution)
Plane plane () const
void setPlane (Plane newPlane)
bool mirrored () const
void setMirrored (bool newMirrored)
bool asynchronous () const
void setAsynchronous (bool newAsynchronous)
Status status () const
bool reversed () const
void setReversed (bool newReversed)
Public Member Functions inherited from QQuick3DGeometry
 QQuick3DGeometry (QQuick3DObject *parent=nullptr)
 ~QQuick3DGeometry () override
QByteArray vertexData () const
 Returns the vertex buffer data set by setVertexData.
QByteArray indexData () const
 Returns the index buffer data.
int attributeCount () const
 Returns the number of attributes defined for this geometry.
Attribute attribute (int index) const
 Returns attribute definition number index.
PrimitiveType primitiveType () const
 Returns the primitive type used when rendering.
QVector3D boundsMin () const
QVector3D boundsMax () const
int stride () const
void setVertexData (const QByteArray &data)
 Sets the vertex buffer data.
void setVertexData (int offset, const QByteArray &data)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Updates a subset of the vertex buffer.
void setIndexData (const QByteArray &data)
 Sets the index buffer to data.
void setIndexData (int offset, const QByteArray &data)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Updates a subset of the index buffer.
void setStride (int stride)
 Sets the stride of the vertex buffer to stride, measured in bytes.
void setBounds (const QVector3D &min, const QVector3D &max)
 Sets the bounding volume of the geometry to the cube defined by the points min and max.
void setPrimitiveType (PrimitiveType type)
 Sets the primitive type used for rendering to type.
void addAttribute (Attribute::Semantic semantic, int offset, Attribute::ComponentType componentType)
 Adds vertex attribute description.
void addAttribute (const Attribute &att)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Adds vertex attribute description.
 Q_REVISION (6, 3) int subsetCount() const
 Q_REVISION (6, 3) QVector3D subsetBoundsMin(int subset) const
 Q_REVISION (6, 3) QVector3D subsetBoundsMax(int subset) const
 Q_REVISION (6, 3) int subsetOffset(int subset) const
 Q_REVISION (6, 3) int subsetCount(int subset) const
 Q_REVISION (6, 3) QString subsetName(int subset) const
 Q_REVISION (6, 3) void addSubset(int offset
 Q_REVISION (6, 6) QByteArray targetData() const
 Q_REVISION (6, 6) void setTargetData(const QByteArray &data)
 Q_REVISION (6, 6) void setTargetData(int offset
 Q_REVISION (6, 6) TargetAttribute targetAttribute(int index) const
 Q_REVISION (6, 6) int targetAttributeCount() const
 Q_REVISION (6, 6) void addTargetAttribute(quint32 targetId
 Q_REVISION (6, 6) void addTargetAttribute(const TargetAttribute &att)
void clear ()
 Resets the geometry to its initial state, clearing previously set vertex and index data as well as attributes.
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QStringbindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThreadthread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectListchildren () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
virtual ~QQmlParserStatus ()

Properties

float width
float height
QSize meshResolution
Plane plane
bool reversed
bool mirrored
bool asynchronous
Status status
Properties inherited from QQuick3DObject
QQuick3DObjectparent
 \qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene.
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Slots inherited from QQuick3DObject
void update ()
void setParentItem (QQuick3DObject *parentItem)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Public Attributes inherited from QQuick3DGeometry
int count
int const QVector3DboundsMin
 Returns the minimum coordinate of the bounding volume.
int const QVector3D const QVector3DboundsMax
 Returns the maximum coordinate of the bounding volume.
int const QVector3D const QVector3D const QStringname = {})
const QByteArraydata
Attribute::Semantic semantic
Attribute::Semantic int offset
Attribute::Semantic int int stride = 0)
 Returns the byte stride of the vertex buffer.
Protected Member Functions inherited from QQuick3DGeometry
QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) override
void markAllDirty () override
Protected Member Functions inherited from QQuick3DObject
virtual void itemChange (ItemChange, const ItemChangeData &)
 QQuick3DObject (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
void classBegin () override
 Invoked after class creation, but before any properties have been set.
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
bool isComponentComplete () const
virtual void preSync ()
Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 30 of file planegeometry_p.h.

Member Enumeration Documentation

◆ Plane

Enumerator
XY 
XZ 
ZY 

Definition at line 47 of file planegeometry_p.h.

◆ Status

Enumerator
Null 
Ready 
Loading 
Error 

Definition at line 44 of file planegeometry_p.h.

Constructor & Destructor Documentation

◆ PlaneGeometry()

QT_BEGIN_NAMESPACE PlaneGeometry::PlaneGeometry ( QQuick3DObject * parent = nullptr)
explicit

\qmltype PlaneGeometry \inqmlmodule QtQuick3D.Helpers \inherits Geometry

Since
6.9

Provides geometry for a plane.

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.

\qmlproperty real PlaneGeometry::width The width of the plane. The default value is 100.0.

\qmlproperty real PlaneGeometry::height The height of the plane. The default value is 100.0.

\qmlproperty size PlaneGeometry::meshResolution The resolution of the plane. The default value is QSize(2, 2).

\qmlproperty PlaneGeometry::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.

\value PlaneGeometry.XY The plane is oriented along the XY plane. \value PlaneGeometry.XZ The plane is oriented along the XZ plane. \value PlaneGeometry.ZY The plane is oriented along the ZY plane.

\qmlproperty bool PlaneGeometry::reversed 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.

\qmlproperty bool PlaneGeometry::mirrored This property holds whether the UV coordinates of the plane are flipped vertically.

\qmlproperty bool PlaneGeometry::asynchronous

This property holds whether the geometry generation should be asynchronous.

\qmlproperty bool PlaneGeometry::status \readonly

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

\value PlaneGeometry.Null The geometry generation has not started \value PlaneGeometry.Ready The geometry generation is complete. \value PlaneGeometry.Loading The geometry generation is in progress. \value PlaneGeometry.Error The geometry generation failed.

Definition at line 85 of file planegeometry.cpp.

◆ ~PlaneGeometry()

PlaneGeometry::~PlaneGeometry ( )
override

Definition at line 94 of file planegeometry.cpp.

Member Function Documentation

◆ asynchronous()

bool PlaneGeometry::asynchronous ( ) const

Definition at line 183 of file planegeometry.cpp.

◆ asynchronousChanged

void PlaneGeometry::asynchronousChanged ( )
signal

◆ height()

float PlaneGeometry::height ( ) const

Definition at line 113 of file planegeometry.cpp.

◆ heightChanged

void PlaneGeometry::heightChanged ( )
signal

◆ meshResolution()

QSize PlaneGeometry::meshResolution ( ) const

Definition at line 127 of file planegeometry.cpp.

◆ meshResolutionChanged

void PlaneGeometry::meshResolutionChanged ( )
signal

◆ mirrored()

bool PlaneGeometry::mirrored ( ) const

Definition at line 169 of file planegeometry.cpp.

◆ mirroredChanged

void PlaneGeometry::mirroredChanged ( )
signal

◆ plane()

PlaneGeometry::Plane PlaneGeometry::plane ( ) const

Definition at line 141 of file planegeometry.cpp.

◆ planeChanged

void PlaneGeometry::planeChanged ( )
signal

◆ reversed()

bool PlaneGeometry::reversed ( ) const

Definition at line 155 of file planegeometry.cpp.

◆ reversedChanged

void PlaneGeometry::reversedChanged ( )
signal

◆ setAsynchronous()

void PlaneGeometry::setAsynchronous ( bool newAsynchronous)

Definition at line 188 of file planegeometry.cpp.

◆ setHeight()

void PlaneGeometry::setHeight ( float newHeight)

Definition at line 118 of file planegeometry.cpp.

◆ setMeshResolution()

void PlaneGeometry::setMeshResolution ( const QSize & newMeshResolution)

Definition at line 132 of file planegeometry.cpp.

◆ setMirrored()

void PlaneGeometry::setMirrored ( bool newMirrored)

Definition at line 174 of file planegeometry.cpp.

◆ setPlane()

void PlaneGeometry::setPlane ( Plane newPlane)

Definition at line 146 of file planegeometry.cpp.

◆ setReversed()

void PlaneGeometry::setReversed ( bool newReversed)

Definition at line 160 of file planegeometry.cpp.

◆ setWidth()

void PlaneGeometry::setWidth ( float newWidth)

Definition at line 104 of file planegeometry.cpp.

◆ status()

PlaneGeometry::Status PlaneGeometry::status ( ) const

Definition at line 196 of file planegeometry.cpp.

◆ statusChanged

void PlaneGeometry::statusChanged ( )
signal

◆ width()

float PlaneGeometry::width ( ) const

Definition at line 99 of file planegeometry.cpp.

◆ widthChanged

void PlaneGeometry::widthChanged ( )
signal

Property Documentation

◆ asynchronous

bool PlaneGeometry::asynchronous
readwrite

Definition at line 39 of file planegeometry_p.h.

◆ height

float PlaneGeometry::height
readwrite

Definition at line 34 of file planegeometry_p.h.

◆ meshResolution

QSize PlaneGeometry::meshResolution
readwrite

Definition at line 35 of file planegeometry_p.h.

◆ mirrored

bool PlaneGeometry::mirrored
readwrite

Definition at line 38 of file planegeometry_p.h.

◆ plane

Plane PlaneGeometry::plane
readwrite

Definition at line 36 of file planegeometry_p.h.

◆ reversed

bool PlaneGeometry::reversed
readwrite

Definition at line 37 of file planegeometry_p.h.

◆ status

Status PlaneGeometry::status
read

Definition at line 40 of file planegeometry_p.h.

◆ width

float PlaneGeometry::width
readwrite

Definition at line 33 of file planegeometry_p.h.


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