#include <heightfieldgeometry_p.h>

Inheritance diagram for HeightFieldGeometry:

Collaboration diagram for HeightFieldGeometry:

Signals
void	sourceChanged ()

void	smoothShadingChanged ()

void	extentsChanged ()

Signals inherited from QQuick3DGeometry
void	geometryNodeDirty ()

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
	HeightFieldGeometry ()
	\qmltype HeightFieldGeometry \inqmlmodule QtQuick3D.Helpers \inherits Geometry

const QUrl &	source () const

void	setSource (const QUrl &newSource)

bool	smoothShading () const

void	setSmoothShading (bool smooth)

const QVector3D &	extents () const

void	setExtents (const QVector3D &newExtents)

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< QString >	bindableObjectName ()

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	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).

QThread *	thread () const
	Returns the thread in which the object lives.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () 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 ()

virtual void	classBegin ()=0
	Invoked after class creation, but before any properties have been set.

virtual void	componentComplete ()=0
	Invoked after the root component that caused this instantiation has completed construction.

Properties
QUrl	source

bool	smoothShading

QVector3D	extents

Properties inherited from QQuick3DObject
QQuick3DObject *	parent
	\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 Types inherited from QQuick3DGeometry
enum class	PrimitiveType { Points , LineStrip , Lines , TriangleStrip , TriangleFan , Triangles }

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 QVector3D &	boundsMin
	Returns the minimum coordinate of the bounding volume.

int const QVector3D const QVector3D &	boundsMax
	Returns the maximum coordinate of the bounding volume.

int const QVector3D const QVector3D const QString &	name = {})

const QByteArray &	data

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
QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node) override

void	markAllDirty () override

Protected Member Functions inherited from QQuick3DObject
virtual QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node)

virtual void	markAllDirty ()

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
QObject *	sender () 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< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 25 of file heightfieldgeometry_p.h.

Constructor & Destructor Documentation

◆ HeightFieldGeometry()

HeightFieldGeometry::HeightFieldGeometry ( )

\qmltype HeightFieldGeometry \inqmlmodule QtQuick3D.Helpers \inherits Geometry

Since: 6.4

A height field geometry.

This helper implements a height-field geometry. It defines a surface built from a grayscale image. The y-coordinate of the surface at a given point in the horizontal plane is determined by the pixel value at the corresponding point in the image. The image's x-axis and y-axis will go along the geometry's x-axis and z-axis respectively.

\qmlproperty vector3d HeightFieldGeometry::extents This property defines the extents of the height-field, that is the dimensions of a box large enough to always contain the geometry. The default value is (100, 100, 100) when the image is square.

\qmlproperty QUrl HeightFieldGeometry::heightMap \obsolete

This property defines the URL of the height map image.

Use \l HeightFieldGeometry::source instead.

\qmlproperty QUrl HeightFieldGeometry::source This property defines the URL of the height map image.

\qmlproperty bool HeightFieldGeometry::smoothShading This property defines whether the height map is shown with smooth shading or with hard angles between the squares of the map.

The default value is true, meaning smooth scaling is turned on.

Definition at line 49 of file heightfieldgeometry.cpp.

Member Function Documentation

◆ extents()

const QVector3D & HeightFieldGeometry::extents ( ) const

Definition at line 88 of file heightfieldgeometry.cpp.

◆ extentsChanged

void HeightFieldGeometry::extentsChanged ( )

signal

Referenced by setExtents().

Here is the caller graph for this function:

◆ setExtents()

void HeightFieldGeometry::setExtents ( const QVector3D & newExtents )

Definition at line 93 of file heightfieldgeometry.cpp.

References emit, extentsChanged(), and QQuick3DObject::update().

Here is the call graph for this function:

◆ setSmoothShading()

void HeightFieldGeometry::setSmoothShading ( bool smooth )

Definition at line 76 of file heightfieldgeometry.cpp.

References emit, smoothShadingChanged(), and QQuick3DObject::update().

Here is the call graph for this function:

◆ setSource()

void HeightFieldGeometry::setSource ( const QUrl & newSource )

Definition at line 59 of file heightfieldgeometry.cpp.

References emit, sourceChanged(), and QQuick3DObject::update().

Here is the call graph for this function:

◆ smoothShading()

bool HeightFieldGeometry::smoothShading ( ) const

Definition at line 71 of file heightfieldgeometry.cpp.

◆ smoothShadingChanged

void HeightFieldGeometry::smoothShadingChanged ( )

signal

Referenced by setSmoothShading().

Here is the caller graph for this function:

◆ source()

const QUrl & HeightFieldGeometry::source ( ) const

Definition at line 54 of file heightfieldgeometry.cpp.

◆ sourceChanged

void HeightFieldGeometry::sourceChanged ( )

signal

Referenced by setSource().

Here is the caller graph for this function:

Property Documentation

◆ extents

QVector3D HeightFieldGeometry::extents

readwrite

Definition at line 60 of file heightfieldgeometry_p.h.

◆ smoothShading

bool HeightFieldGeometry::smoothShading

readwrite

Definition at line 60 of file heightfieldgeometry_p.h.

◆ source

QUrl HeightFieldGeometry::source

readwrite

Definition at line 60 of file heightfieldgeometry_p.h.

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

qtquick3d/src/helpers/heightfieldgeometry_p.h
qtquick3d/src/helpers/heightfieldgeometry.cpp

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HeightFieldGeometry()

Member Function Documentation

◆ extents()

◆ extentsChanged

◆ setExtents()

◆ setSmoothShading()

◆ setSource()

◆ smoothShading()

◆ smoothShadingChanged

◆ source()

◆ sourceChanged

Property Documentation

◆ extents

◆ smoothShading

◆ source