cylindergeometry.cpp

Go to the documentation of this file.

// Copyright (C) 2024 The Qt Company Ltd.
// Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
 
#include "cylindergeometry_p.h"
#include <limits>
 
 
#if QT_CONFIG(concurrent)
#include <QtConcurrentRun>
#endif
 
 
QT_BEGIN_NAMESPACE
 
namespace {
 
void createCylinderSidesVertices(float *&verticesPtr,
                                 int rings,
                                 int slices,
                                 double topRadius,
                                 double bottomRadius,
                                 double length)
{
    const float dY = length / static_cast<float>(rings - 1);
    const float dTheta = (M_PI * 2) / static_cast<float>(slices);
 
    for (int ring = 0; ring < rings; ++ring) {
        const float y = -length / 2.0f + static_cast<float>(ring) * dY;
 
        const float t = (y + length / 2) / length;
        const float radius = (bottomRadius * (1 - t)) + (t * topRadius);
 
        for (int slice = 0; slice <= slices; ++slice) {
            const float theta = static_cast<float>(slice) * dTheta;
            const float ta = std::tan((M_PI/2) - std::atan(length / (bottomRadius - topRadius)));
            const float ct = std::cos(theta);
            const float st = std::sin(theta);
 
            // Position
            *verticesPtr++ = radius * ct;
            *verticesPtr++ = y;
            *verticesPtr++ = radius * st;
 
            // UV Coordinates
            float v = 0.5f + (y + length / 2.0f) / length / 2.0f;
            *verticesPtr++ = static_cast<float>(slice) / static_cast<float>(slices);  // U-coordinate (theta / 2π)
            *verticesPtr++ = v;  // V-coordinate mapped between [0.5, 1]
 
            // Normal
            QVector3D n(ct, ta, st);
            n.normalize();
            *verticesPtr++ = n.x();
            *verticesPtr++ = n.y();
            *verticesPtr++ = n.z();
        }
    }
}
 
void createCylinderSidesIndices(quint16 *&indicesPtr, int rings, int slices)
{
    for (int ring = 0; ring < rings-1; ++ring) {
        const int ringIndexStart = ring * (slices + 1);
        const int nextRingIndexStart = (ring + 1) * (slices + 1);
 
        for (int slice = 0; slice <= slices; ++slice) {
            if (slice == slices)
                continue;
 
            const int nextSlice = slice + 1;
 
            *indicesPtr++ = (ringIndexStart + slice);
            *indicesPtr++ = (nextRingIndexStart + slice);
            *indicesPtr++ = (ringIndexStart + nextSlice);
            *indicesPtr++ = (ringIndexStart + nextSlice);
            *indicesPtr++ = (nextRingIndexStart + slice);
            *indicesPtr++ = (nextRingIndexStart + nextSlice);
        }
    }
}
 
void createCylinderDiscVertices(float *&verticesPtr,
                                int slices,
                                double topRadius,
                                double bottomRadius,
                                double length,
                                double yPosition)
{
    const float dTheta = (M_PI * 2) / static_cast<float>(slices);
    const double yNormal = (yPosition < 0.0f) ? -1.0f : 1.0f;
 
    *verticesPtr++ = 0.0f;
    *verticesPtr++ = yPosition;
    *verticesPtr++ = 0.0f;
 
    if (yPosition < 0.0f) {
        // Bottom Cap
        *verticesPtr++ = 0.75f;  // Center vertex UV (bottom cap)
        *verticesPtr++ = 0.25f;
    } else {
        // Top Cap
        *verticesPtr++ = 0.25f;  // Center vertex UV (top cap)
        *verticesPtr++ = 0.25f;
    }
 
 
    *verticesPtr++ = 0.0f;
    *verticesPtr++ = yNormal;
    *verticesPtr++ = 0.0f;
 
 
    for (int slice = 0; slice <= slices; ++slice)
    {
        const float theta = static_cast<float>(slice) * dTheta;
        const float ct = std::cos(theta);
        const float st = std::sin(theta);
 
        const float t = (yPosition + length / 2) / length;
        const float radius = (bottomRadius * (1 - t)) + (t * topRadius);
 
        // Position
        *verticesPtr++ = radius * ct;
        *verticesPtr++ = yPosition;
        *verticesPtr++ = radius * st;
 
        // UV Coordinates
        if (yPosition < 0.0f) {
            // Bottom cap UVs: Map to range (0, 0.5) to (1, 1)
            *verticesPtr++ = 0.75f + 0.25f * ct;
            *verticesPtr++ = 0.25f + 0.25f * st;
        } else {
            // Top cap UVs: Map to range (0, 0.5)
            *verticesPtr++ = 0.25f + 0.25f * ct;
            *verticesPtr++ = 0.25f + 0.25f * -st;
        }
 
        // Normal
        *verticesPtr++ = 0.0f;
        *verticesPtr++ = yNormal;
        *verticesPtr++ = 0.0f;
    }
}
 
void createCylinderDiscIndices(quint16 *&indicesPtr,
                               int discCenterIndex,
                               int slices,
                               bool isTopCap)
{
    if ( !isTopCap ) {
        for ( int i = slices - 1 ; i >= 0 ; --i )
        {
            if ( i != 0 ) {
                *indicesPtr++ = discCenterIndex;
                *indicesPtr++ = discCenterIndex + i + 1;
                *indicesPtr++ = discCenterIndex + i;
            } else {
                *indicesPtr++ = discCenterIndex;
                *indicesPtr++ = discCenterIndex + i + 1;
                *indicesPtr++ = discCenterIndex + slices;
            }
        }
    } else {
        for ( int i = 0 ; i < slices; ++i )
        {
            if ( i != slices - 1 ) {
                *indicesPtr++ = discCenterIndex;
                *indicesPtr++ = discCenterIndex + i + 1;
                *indicesPtr++ = discCenterIndex + i + 2;
            } else {
                *indicesPtr++ = discCenterIndex;
                *indicesPtr++ = discCenterIndex + i + 1;
                *indicesPtr++ = discCenterIndex + 1;
            }
        }
    }
}
 
} // namespace
 
/*!
    \qmltype CylinderGeometry
    \inqmlmodule QtQuick3D.Helpers
    \inherits Geometry
    \since 6.9
    \brief Provides geometry for a cylinder.
 
    CylinderGeometry is a geometry type that generates a cylinder shape. The cylinder's
    shape is defined by it's radius and length properties.  The topology of the cylinder
    is defined by the number of segments and rings.
*/
 
/*!
    \qmlproperty real CylinderGeometry::radius
 
    This property holds the radius of the cylinder. This property must be greater than 0
    to generate a valid cylinder.
*/
 
/*!
    \qmlproperty real CylinderGeometry::length
 
    This property holds the length of the cylinder. This property must be greather than 0
    to generate a valid cylinder.
*/
 
/*!
    \qmlproperty int CylinderGeometry::segments
 
    This property holds the number of segments in the cylinder.  The segments are the
    radial divisions of the cylinder.  The minimum number of segments is 3.
*/
 
/*!
    \qmlproperty int CylinderGeometry::rings
 
    This property holds the number of rings in the cylinder.  The rings are the lengthwise
    divisions of the cylinder. The minimum number of rings is 0.
*/
 
/*!
    \qmlproperty bool CylinderGeometry::asynchronous
 
    This property holds whether the geometry generation should be asynchronous.
*/
 
/*!
    \qmlproperty bool CylinderGeometry::status
    \readonly
 
    This property holds the status of the geometry generation when asynchronous is true.
 
    \value CylinderGeometry.Null The geometry generation has not started
    \value CylinderGeometry.Ready The geometry generation is complete.
    \value CylinderGeometry.Loading The geometry generation is in progress.
    \value CylinderGeometry.Error The geometry generation failed.
*/
 
CylinderGeometry::CylinderGeometry(QQuick3DObject *parent)
    : QQuick3DGeometry(parent)
{
#if QT_CONFIG(concurrent)
    connect(&m_geometryDataWatcher, &QFutureWatcher<GeometryData>::finished, this, &CylinderGeometry::requestFinished);
#endif
    scheduleGeometryUpdate();
}
 
CylinderGeometry::~CylinderGeometry()
{
 
}
 
float CylinderGeometry::radius() const
{
    return m_radius;
}
 
void CylinderGeometry::setRadius(float newRadius)
{
    if (qFuzzyCompare(m_radius, newRadius))
        return;
    m_radius = newRadius;
    emit radiusChanged();
    scheduleGeometryUpdate();
}
 
float CylinderGeometry::length() const
{
    return m_length;
}
 
void CylinderGeometry::setLength(float newLength)
{
    if (qFuzzyCompare(m_length, newLength))
        return;
    m_length = newLength;
    emit lengthChanged();
    scheduleGeometryUpdate();
}
 
int CylinderGeometry::rings() const
{
    return m_rings;
}
 
void CylinderGeometry::setRings(int newRings)
{
    if (m_rings == newRings)
        return;
    m_rings = newRings;
    emit ringsChanged();
    scheduleGeometryUpdate();
}
 
int CylinderGeometry::segments() const
{
    return m_segments;
}
 
void CylinderGeometry::setSegments(int newSegments)
{
    if (m_segments == newSegments)
        return;
    m_segments = newSegments;
    emit segmentsChanged();
    scheduleGeometryUpdate();
}
 
bool CylinderGeometry::asynchronous() const
{
    return m_asynchronous;
}
 
void CylinderGeometry::setAsynchronous(bool newAsynchronous)
{
    if (m_asynchronous == newAsynchronous)
        return;
    m_asynchronous = newAsynchronous;
    emit asynchronousChanged();
}
 
CylinderGeometry::Status CylinderGeometry::status() const
{
    return m_status;
}
 
void CylinderGeometry::doUpdateGeometry()
{
    // reset the flag since we are processing the update
    m_geometryUpdateRequested = false;
 
#if QT_CONFIG(concurrent)
    if (m_geometryDataFuture.isRunning()) {
        m_pendingAsyncUpdate = true;
        return;
    }
#endif
 
    // Check validity of the geometry parameters
    if (m_radius <= 0 || m_length <= 0 || m_rings < 0 || m_segments < 3) {
        clear();
        update();
        return;
    }
 
#if QT_CONFIG(concurrent)
    // without threads, QtConcurrent::run() would never run the task
    if (m_asynchronous && QT_CONFIG(thread)) {
        m_geometryDataFuture = QtConcurrent::run(generateCylinderGeometryAsync,
                                                 m_radius,
                                                 m_length,
                                                 m_rings,
                                                 m_segments);
        m_geometryDataWatcher.setFuture(m_geometryDataFuture);
        m_status = Status::Loading;
        Q_EMIT statusChanged();
    } else {
#else
    {
 
#endif // QT_CONFIG(concurrent)
        updateGeometry(generateCylinderGeometry(m_radius, m_length, m_rings, m_segments));
    }
}
 
void CylinderGeometry::requestFinished()
{
#if QT_CONFIG(concurrent)
    const auto output = m_geometryDataFuture.takeResult();
    updateGeometry(output);
#endif
}
 
void CylinderGeometry::scheduleGeometryUpdate()
{
    if (!m_geometryUpdateRequested) {
        QMetaObject::invokeMethod(this, "doUpdateGeometry", Qt::QueuedConnection);
        m_geometryUpdateRequested = true;
    }
}
 
void CylinderGeometry::updateGeometry(const GeometryData &geometryData)
{
    clear();
    setStride(sizeof(float) * 8); // 3 for position, 2 for uv0, 3 for normal
    setPrimitiveType(QQuick3DGeometry::PrimitiveType::Triangles);
    addAttribute(QQuick3DGeometry::Attribute::PositionSemantic,
                 0,
                 QQuick3DGeometry::Attribute::F32Type);
    addAttribute(QQuick3DGeometry::Attribute::TexCoord0Semantic,
                 3 * sizeof(float),
                 QQuick3DGeometry::Attribute::F32Type);
    addAttribute(QQuick3DGeometry::Attribute::NormalSemantic,
                 5 * sizeof(float),
                 QQuick3DGeometry::Attribute::F32Type);
    addAttribute(QQuick3DGeometry::Attribute::IndexSemantic,
                 0,
                 QQuick3DGeometry::Attribute::U16Type);
 
    setBounds(geometryData.boundsMin, geometryData.boundsMax);
    setVertexData(geometryData.vertexData);
    setIndexData(geometryData.indexData);
 
    // If the geometry update was requested while the geometry was being generated asynchronously,
    // we need to schedule another geometry update now that the geometry is ready.
    if (m_pendingAsyncUpdate) {
        m_pendingAsyncUpdate = false;
        scheduleGeometryUpdate();
    } else {
        m_status = Status::Ready;
        Q_EMIT statusChanged();
    }
    update();
    emit geometryChanged();
}
 
CylinderGeometry::GeometryData CylinderGeometry::generateCylinderGeometry(float radius, float length, int rings, int slices)
{
    GeometryData geomData;
 
    rings += 2; // Add two extra rings for the top and bottom caps
 
    // Cap count: if top and/or bottom radius is greater than zero
    int capCount = 2;
 
    // Compute total number of vertices and indices
    int totalFaces = (slices * 2) * (rings - 1) + slices * capCount;
    int totalVertices = (slices + 1) * rings + capCount * (slices + 2);
    int totalIndices = totalFaces * 3;
 
    // Resize QByteArray to hold vertex and index data
    geomData.vertexData.resize(totalVertices * 8 * sizeof(float));  // Each vertex has 8 attributes (3 position, 2 UV, 3 normal)
    geomData.indexData.resize(totalIndices * sizeof(quint16));      // Each index is a 16-bit unsigned integer
 
    // Get pointers to raw data in QByteArray
    float* verticesPtr = reinterpret_cast<float*>(geomData.vertexData.data());
    quint16* indicesPtr = reinterpret_cast<quint16*>(geomData.indexData.data());
 
    // Cylinder vertices and indices
 
    createCylinderSidesVertices(verticesPtr, rings, slices, radius, radius, length);
    createCylinderSidesIndices(indicesPtr, rings, slices);
    int bottomCenterIndex = rings * (slices + 1);
    createCylinderDiscVertices(verticesPtr, slices, radius, radius, length, -length / 2);
    createCylinderDiscIndices(indicesPtr, bottomCenterIndex, slices, true);
    int topCenterIndex = radius > 0 ? rings * (slices + 1) + (slices + 2) : rings * (slices + 1);
    createCylinderDiscVertices(verticesPtr, slices, radius, radius, length, length / 2);
    createCylinderDiscIndices(indicesPtr, topCenterIndex, slices, false);
 
 
    // Calculate bounding box (min and max)
    float* vertexData = reinterpret_cast<float*>(geomData.vertexData.data());
    QVector3D boundsMin(std::numeric_limits<float>::max(),
                        std::numeric_limits<float>::max(),
                        std::numeric_limits<float>::max());
    QVector3D boundsMax(std::numeric_limits<float>::lowest(),
                        std::numeric_limits<float>::lowest(),
                        std::numeric_limits<float>::lowest());
    for (int i = 0; i < totalVertices; ++i) {
        QVector3D pos(vertexData[i * 8], vertexData[i * 8 + 1], vertexData[i * 8 + 2]);
        boundsMin.setX(qMin(boundsMin.x(), pos.x()));
        boundsMin.setY(qMin(boundsMin.y(), pos.y()));
        boundsMin.setZ(qMin(boundsMin.z(), pos.z()));
 
        boundsMax.setX(qMax(boundsMax.x(), pos.x()));
        boundsMax.setY(qMax(boundsMax.y(), pos.y()));
        boundsMax.setZ(qMax(boundsMax.z(), pos.z()));
    }
    geomData.boundsMin = boundsMin;
    geomData.boundsMax = boundsMax;
 
    return geomData;
}
 
#if QT_CONFIG(concurrent)
void CylinderGeometry::generateCylinderGeometryAsync(QPromise<CylinderGeometry::GeometryData> &promise,
                                                     float radius,
                                                     float length,
                                                     int rings,
                                                     int segments)
{
    auto output = generateCylinderGeometry(radius, length, rings, segments);
    promise.addResult(output);
}
#endif
 
QT_END_NAMESPACE