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
CapsuleGeometry Class Reference

#include <capsulegeometry_p.h>

Inheritance diagram for CapsuleGeometry:
Collaboration diagram for CapsuleGeometry:

Public Types

enum  Status { Null , Ready , Loading , Error }
enum  UVProfile { Fixed , Aspect , Uniform }
Public Types inherited from QQuick3DGeometry
enum class  PrimitiveType {
  Points , LineStrip , Lines , TriangleStrip ,
  TriangleFan , Triangles
}

Signals

void enableNormalsChanged ()
void enableUVChanged ()
void longitudesChanged ()
void latitudesChanged ()
void ringsChanged ()
void heightChanged ()
void diameterChanged ()
void uvProfileChanged ()
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

 CapsuleGeometry (QQuick3DObject *parent=nullptr)
 \qmltype CapsuleGeometry \inqmlmodule QtQuick3D.Helpers \inherits Geometry
 ~CapsuleGeometry () override
bool enableNormals () const
void setEnableNormals (bool enable)
bool enableUV () const
void setEnableUV (bool enable)
int longitudes () const
void setLongitudes (int longitudes)
int latitudes () const
void setLatitudes (int latitudes)
int rings () const
void setRings (int rings)
float height () const
void setHeight (float height)
float diameter () const
void setDiameter (float diameter)
UVProfile uvProfile () const
void setUVProfile (UVProfile newUVProfile)
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< 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

bool enableNormals
bool enableUV
int longitudes
int latitudes
int rings
float height
float diameter
UVProfile uvProfile
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 capsulegeometry_p.h.

Member Enumeration Documentation

◆ Status

Enumerator
Null 
Ready 
Loading 
Error 

Definition at line 46 of file capsulegeometry_p.h.

◆ UVProfile

Enumerator
Fixed 
Aspect 
Uniform 

Definition at line 48 of file capsulegeometry_p.h.

Constructor & Destructor Documentation

◆ CapsuleGeometry()

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

\qmltype CapsuleGeometry \inqmlmodule QtQuick3D.Helpers \inherits Geometry

Since
6.10

Provides geometry for a capsule.

A geometry for generating a capsule model. The capsule is centered at {(0, 0, 0)} with the height of the capsule extending in the x direction and the diameter on the yz plane.

\qmlproperty bool CapsuleGeometry::enableNormals \default true

Generate mesh face normals.

\qmlproperty bool CapsuleGeometry::enableUV \default false

Generate mesh uv coordinates.

\qmlproperty int CapsuleGeometry::longitudes \default 32

Number of longitudes, or meridians, distributed by azimuth.

\qmlproperty int CapsuleGeometry::latitudes \default 16

Number of latitudes, distributed by inclination. Will always be snapped to an even number.

\qmlproperty int CapsuleGeometry::rings \default 1

Number of sections in cylinder between hemispheres.

\qmlproperty real CapsuleGeometry::height \default 100

Height of the middle cylinder on the x axis, excluding the hemispheres.

\qmlproperty real CapsuleGeometry::diameter \default 100

Diameter on the yz plane.

\qmlproperty UVProfile CapsuleGeometry::uvProfile \default CapsuleGeometry.Fixed

Manner in which UV coordinates are distributed along the length of the capsule.

\value CapsuleGeometry.Fixed The upper third of the UV texture is the North hemisphere, the middle third is the cylinder and the last third is the South hemisphere. \value CapsuleGeometry.Aspect UVs match the height to radius ratio. \value CapsuleGeometry.Uniform Uniform proportion for all UV cells, according to the ratio of latitudes to rings.

\qmlproperty bool CapsuleGeometry::asynchronous \default true

This property holds whether the geometry generation should be asynchronous.

\qmlproperty bool CapsuleGeometry::status \readonly

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

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

Definition at line 105 of file capsulegeometry.cpp.

◆ ~CapsuleGeometry()

CapsuleGeometry::~CapsuleGeometry ( )
overridedefault

Member Function Documentation

◆ asynchronous()

bool CapsuleGeometry::asynchronous ( ) const

Definition at line 199 of file capsulegeometry.cpp.

◆ asynchronousChanged

void CapsuleGeometry::asynchronousChanged ( )
signal

◆ diameter()

float CapsuleGeometry::diameter ( ) const
inline

Definition at line 72 of file capsulegeometry_p.h.

◆ diameterChanged

void CapsuleGeometry::diameterChanged ( )
signal

◆ enableNormals()

bool CapsuleGeometry::enableNormals ( ) const
inline

Definition at line 54 of file capsulegeometry_p.h.

◆ enableNormalsChanged

void CapsuleGeometry::enableNormalsChanged ( )
signal

◆ enableUV()

bool CapsuleGeometry::enableUV ( ) const
inline

Definition at line 57 of file capsulegeometry_p.h.

◆ enableUVChanged

void CapsuleGeometry::enableUVChanged ( )
signal

◆ height()

float CapsuleGeometry::height ( ) const
inline

Definition at line 69 of file capsulegeometry_p.h.

◆ heightChanged

void CapsuleGeometry::heightChanged ( )
signal

◆ latitudes()

int CapsuleGeometry::latitudes ( ) const
inline

Definition at line 63 of file capsulegeometry_p.h.

◆ latitudesChanged

void CapsuleGeometry::latitudesChanged ( )
signal

◆ longitudes()

int CapsuleGeometry::longitudes ( ) const
inline

Definition at line 60 of file capsulegeometry_p.h.

◆ longitudesChanged

void CapsuleGeometry::longitudesChanged ( )
signal

◆ rings()

int CapsuleGeometry::rings ( ) const
inline

Definition at line 66 of file capsulegeometry_p.h.

◆ ringsChanged

void CapsuleGeometry::ringsChanged ( )
signal

◆ setAsynchronous()

void CapsuleGeometry::setAsynchronous ( bool newAsynchronous)

Definition at line 204 of file capsulegeometry.cpp.

◆ setDiameter()

void CapsuleGeometry::setDiameter ( float diameter)

Definition at line 175 of file capsulegeometry.cpp.

◆ setEnableNormals()

void CapsuleGeometry::setEnableNormals ( bool enable)

Definition at line 115 of file capsulegeometry.cpp.

◆ setEnableUV()

void CapsuleGeometry::setEnableUV ( bool enable)

Definition at line 125 of file capsulegeometry.cpp.

◆ setHeight()

void CapsuleGeometry::setHeight ( float height)

Definition at line 165 of file capsulegeometry.cpp.

◆ setLatitudes()

void CapsuleGeometry::setLatitudes ( int latitudes)

Definition at line 145 of file capsulegeometry.cpp.

◆ setLongitudes()

void CapsuleGeometry::setLongitudes ( int longitudes)

Definition at line 135 of file capsulegeometry.cpp.

◆ setRings()

void CapsuleGeometry::setRings ( int rings)

Definition at line 155 of file capsulegeometry.cpp.

◆ setUVProfile()

void CapsuleGeometry::setUVProfile ( UVProfile newUVProfile)

Definition at line 190 of file capsulegeometry.cpp.

◆ status()

CapsuleGeometry::Status CapsuleGeometry::status ( ) const

Definition at line 212 of file capsulegeometry.cpp.

◆ statusChanged

void CapsuleGeometry::statusChanged ( )
signal

◆ uvProfile()

CapsuleGeometry::UVProfile CapsuleGeometry::uvProfile ( ) const

Definition at line 185 of file capsulegeometry.cpp.

◆ uvProfileChanged

void CapsuleGeometry::uvProfileChanged ( )
signal

Property Documentation

◆ asynchronous

bool CapsuleGeometry::asynchronous
readwrite

Definition at line 41 of file capsulegeometry_p.h.

◆ diameter

float CapsuleGeometry::diameter
readwrite

Definition at line 39 of file capsulegeometry_p.h.

◆ enableNormals

bool CapsuleGeometry::enableNormals
readwrite

Definition at line 33 of file capsulegeometry_p.h.

◆ enableUV

bool CapsuleGeometry::enableUV
readwrite

Definition at line 34 of file capsulegeometry_p.h.

◆ height

float CapsuleGeometry::height
readwrite

Definition at line 38 of file capsulegeometry_p.h.

◆ latitudes

int CapsuleGeometry::latitudes
readwrite

Definition at line 36 of file capsulegeometry_p.h.

◆ longitudes

int CapsuleGeometry::longitudes
readwrite

Definition at line 35 of file capsulegeometry_p.h.

◆ rings

int CapsuleGeometry::rings
readwrite

Definition at line 37 of file capsulegeometry_p.h.

◆ status

Status CapsuleGeometry::status
read

Definition at line 42 of file capsulegeometry_p.h.

◆ uvProfile

UVProfile CapsuleGeometry::uvProfile
readwrite

Definition at line 40 of file capsulegeometry_p.h.


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