#include <extrudedtextgeometry_p.h>

Inheritance diagram for ExtrudedTextGeometry:

Collaboration diagram for ExtrudedTextGeometry:

Public Types
enum	Status { Null , Ready , Loading , Error }
using	IndexType = quint32
Public Types inherited from QQuick3DGeometry
enum class	PrimitiveType { Points , LineStrip , Lines , TriangleStrip , TriangleFan , Triangles }

Signals
void	textChanged ()
void	fontChanged ()
void	depthChanged ()
void	scaleChanged ()
void	asynchronousChanged ()
void	statusChanged ()
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
	ExtrudedTextGeometry (QQuick3DObject *parent=nullptr)
	\qmltype ExtrudedTextGeometry \inqmlmodule QtQuick3D.Helpers \inherits Geometry
	~ExtrudedTextGeometry () override
QString	text () const
void	setText (const QString &newText)
QFont	font () const
void	setFont (const QFont &newFont)
float	depth () const
void	setDepth (float newDepth)
float	scale () const
void	setScale (float newScale)
bool	asynchronous () const
void	setAsynchronous (bool newAsynchronous)
Status	status () const
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	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).
QThread *	thread () 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>
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>
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 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 ()

Properties
QString	text
QFont	font
float	depth
float	scale
bool	asynchronous
Status	status
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 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 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 31 of file extrudedtextgeometry_p.h.

Member Typedef Documentation

◆ IndexType

using ExtrudedTextGeometry::IndexType = quint32

Definition at line 66 of file extrudedtextgeometry_p.h.

Member Enumeration Documentation

◆ Status

enum ExtrudedTextGeometry::Status

Enumerator
Null
Ready
Loading
Error

Definition at line 43 of file extrudedtextgeometry_p.h.

Constructor & Destructor Documentation

◆ ExtrudedTextGeometry()

ExtrudedTextGeometry::ExtrudedTextGeometry ( QQuick3DObject * parent = nullptr )

explicit

\qmltype ExtrudedTextGeometry \inqmlmodule QtQuick3D.Helpers \inherits Geometry

Since: 6.9

Provides geometry for extruded text.

ExtrudedTextGeometry provides geometry for extruded text. The text is extruded along the z-axis. The text and font can be set, and the depth of the extrusion can be controlled. The size of the generated geometry is controlled by the scale and depth properties. The topology of the geometry is defined by the font.pointSize.

The origin of the mesh is the rear left end of the text's baseline.

\qmlproperty string ExtrudedTextGeometry::text

This property holds the text that will be extruded.

\qmlproperty font ExtrudedTextGeometry::font

This property holds the font that will be used to render the text.

Note: The mesh geometry is normalized by the font's pointSize, so a larger pointSize will result in smoother, rather than larger, text. pixelSize should not be used.

\qmlproperty real ExtrudedTextGeometry::depth

This property holds the depth of the extrusion.

\qmlproperty real ExtrudedTextGeometry::scale

This property holds a scalar value of how the geometry should be scaled. This property only affects the size of the text, not the depth of the extrusion.

\qmlproperty bool ExtrudedTextGeometry::asynchronous

This property holds whether the geometry generation should be asynchronous.

\qmlproperty bool ExtrudedTextGeometry::status \readonly

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

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

Definition at line 164 of file extrudedtextgeometry.cpp.

◆ ~ExtrudedTextGeometry()

ExtrudedTextGeometry::~ExtrudedTextGeometry ( )

override

Definition at line 173 of file extrudedtextgeometry.cpp.

Member Function Documentation

◆ asynchronous()

bool ExtrudedTextGeometry::asynchronous ( ) const

Definition at line 234 of file extrudedtextgeometry.cpp.

◆ asynchronousChanged

void ExtrudedTextGeometry::asynchronousChanged ( )

signal

◆ depth()

float ExtrudedTextGeometry::depth ( ) const

Definition at line 206 of file extrudedtextgeometry.cpp.

◆ depthChanged

void ExtrudedTextGeometry::depthChanged ( )

signal

◆ font()

QFont ExtrudedTextGeometry::font ( ) const

Definition at line 192 of file extrudedtextgeometry.cpp.

◆ fontChanged

void ExtrudedTextGeometry::fontChanged ( )

signal

◆ scale()

float ExtrudedTextGeometry::scale ( ) const

Definition at line 220 of file extrudedtextgeometry.cpp.

◆ scaleChanged

void ExtrudedTextGeometry::scaleChanged ( )

signal

◆ setAsynchronous()

void ExtrudedTextGeometry::setAsynchronous ( bool newAsynchronous )

Definition at line 239 of file extrudedtextgeometry.cpp.

◆ setDepth()

void ExtrudedTextGeometry::setDepth ( float newDepth )

Definition at line 211 of file extrudedtextgeometry.cpp.

◆ setFont()

void ExtrudedTextGeometry::setFont ( const QFont & newFont )

Definition at line 197 of file extrudedtextgeometry.cpp.

◆ setScale()

void ExtrudedTextGeometry::setScale ( float newScale )

Definition at line 225 of file extrudedtextgeometry.cpp.

◆ setText()

void ExtrudedTextGeometry::setText ( const QString & newText )

Definition at line 183 of file extrudedtextgeometry.cpp.

◆ status()

ExtrudedTextGeometry::Status ExtrudedTextGeometry::status ( ) const

Definition at line 247 of file extrudedtextgeometry.cpp.

◆ statusChanged

void ExtrudedTextGeometry::statusChanged ( )

signal

◆ text()

QString ExtrudedTextGeometry::text ( ) const

Definition at line 178 of file extrudedtextgeometry.cpp.

◆ textChanged

void ExtrudedTextGeometry::textChanged ( )

signal

Property Documentation

◆ asynchronous

bool ExtrudedTextGeometry::asynchronous

readwrite

Definition at line 38 of file extrudedtextgeometry_p.h.

◆ depth

float ExtrudedTextGeometry::depth

readwrite

Definition at line 36 of file extrudedtextgeometry_p.h.

◆ font

QFont ExtrudedTextGeometry::font

readwrite

Definition at line 35 of file extrudedtextgeometry_p.h.

◆ scale

float ExtrudedTextGeometry::scale

readwrite

Definition at line 37 of file extrudedtextgeometry_p.h.

◆ status

Status ExtrudedTextGeometry::status

read

Definition at line 39 of file extrudedtextgeometry_p.h.

◆ text

QString ExtrudedTextGeometry::text

readwrite

Definition at line 34 of file extrudedtextgeometry_p.h.

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

qtquick3d/src/helpers/extrudedtextgeometry_p.h (507242ade13da12d081a05c8d55f8a11b0b18cc8)
qtquick3d/src/helpers/extrudedtextgeometry.cpp (07031265838bd0f62206b6073ea5d5e8140b8205)

Public Types

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ IndexType

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ ExtrudedTextGeometry()

◆ ~ExtrudedTextGeometry()

Member Function Documentation

◆ asynchronous()

◆ asynchronousChanged

◆ depth()

◆ depthChanged

◆ font()

◆ fontChanged

◆ scale()

◆ scaleChanged

◆ setAsynchronous()

◆ setDepth()

◆ setFont()

◆ setScale()

◆ setText()

◆ status()

◆ statusChanged

◆ text()

◆ textChanged

Property Documentation

◆ asynchronous

◆ depth

◆ font

◆ scale

◆ status

◆ text