qplaneshape.cpp

Go to the documentation of this file.

// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#include "qplaneshape_p.h"
 
#include <QtQuick3D/QQuick3DGeometry>
#include <extensions/PxExtensionsAPI.h>
 
//########################################################################################
// NOTE:
// Triangle mesh, heightfield or plane geometry shapes configured as eSIMULATION_SHAPE are
// not supported for non-kinematic PxRigidDynamic instances.
//########################################################################################
 
QT_BEGIN_NAMESPACE
 
/*!
    \qmltype PlaneShape
    \inqmlmodule QtQuick3D.Physics
    \inherits CollisionShape
    \since 6.4
    \brief A collision shape that defines an infinite plane.
 
    The PlaneShape type defines an infinite plane. The plane divides space into "above" and "below"
    it. Everything "below" the plane will collide with it and be pushed above it. The orientation of
    the plane is vertical: The Plane lies on the XY plane with "above" pointing sideways towards positive Z.
 
    PlaneShape can only be used with \l StaticRigidBody and \l {DynamicRigidBody::isKinematic}{kinematic bodies}.
*/
 
QPlaneShape::QPlaneShape() = default;
 
QPlaneShape::~QPlaneShape()
{
    delete m_planeGeometry;
}
 
physx::PxGeometry *QPlaneShape::getPhysXGeometry()
{
    if (!m_planeGeometry) {
        updatePhysXGeometry();
    }
    return m_planeGeometry;
}
 
void QPlaneShape::updatePhysXGeometry()
{
    delete m_planeGeometry;
    // TODO: we need only one plane geometry, and it should live in the backend
    m_planeGeometry = new physx::PxPlaneGeometry();
}
 
QT_END_NAMESPACE