109 lines
3.5 KiB
C++
109 lines
3.5 KiB
C++
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions
|
|
// are met:
|
|
// * Redistributions of source code must retain the above copyright
|
|
// notice, this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
// * Neither the name of NVIDIA CORPORATION nor the names of its
|
|
// contributors may be used to endorse or promote products derived
|
|
// from this software without specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
|
|
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
|
|
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
|
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
//
|
|
// Copyright (c) 2008-2019 NVIDIA Corporation. All rights reserved.
|
|
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
|
|
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
|
|
|
|
|
|
#ifndef PX_PHYSICS_NX_PLANE_GEOMETRY
|
|
#define PX_PHYSICS_NX_PLANE_GEOMETRY
|
|
/** \addtogroup geomutils
|
|
@{
|
|
*/
|
|
#include "foundation/PxPlane.h"
|
|
#include "foundation/PxTransform.h"
|
|
#include "geometry/PxGeometry.h"
|
|
#include "foundation/PxFoundationConfig.h"
|
|
|
|
#if !PX_DOXYGEN
|
|
namespace physx
|
|
{
|
|
#endif
|
|
|
|
/**
|
|
\brief Class describing a plane geometry.
|
|
|
|
The plane geometry specifies the half-space volume x<=0. As with other geometry types,
|
|
when used in a PxShape the collision volume is obtained by transforming the halfspace
|
|
by the shape local pose and the actor global pose.
|
|
|
|
To generate a PxPlane from a PxTransform, transform PxPlane(1,0,0,0).
|
|
|
|
To generate a PxTransform from a PxPlane, use PxTransformFromPlaneEquation.
|
|
|
|
@see PxShape.setGeometry() PxShape.getPlaneGeometry() PxTransformFromPlaneEquation
|
|
*/
|
|
class PxPlaneGeometry : public PxGeometry
|
|
{
|
|
public:
|
|
PX_INLINE PxPlaneGeometry() : PxGeometry(PxGeometryType::ePLANE) {}
|
|
|
|
/**
|
|
\brief Returns true if the geometry is valid.
|
|
|
|
\return True if the current settings are valid
|
|
*/
|
|
PX_INLINE bool isValid() const;
|
|
};
|
|
|
|
|
|
PX_INLINE bool PxPlaneGeometry::isValid() const
|
|
{
|
|
if (mType != PxGeometryType::ePLANE)
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/** \brief creates a transform from a plane equation, suitable for an actor transform for a PxPlaneGeometry
|
|
|
|
\param[in] plane the desired plane equation
|
|
\return a PxTransform which will transform the plane PxPlane(1,0,0,0) to the specified plane
|
|
*/
|
|
|
|
PX_FOUNDATION_API PxTransform PxTransformFromPlaneEquation(const PxPlane& plane);
|
|
|
|
/** \brief creates a plane equation from a transform, such as the actor transform for a PxPlaneGeometry
|
|
|
|
\param[in] transform the transform
|
|
\return the plane
|
|
*/
|
|
|
|
|
|
PX_INLINE PxPlane PxPlaneEquationFromTransform(const PxTransform& transform)
|
|
{
|
|
return transform.transform(PxPlane(1.f,0.f,0.f,0.f));
|
|
}
|
|
|
|
|
|
#if !PX_DOXYGEN
|
|
} // namespace physx
|
|
#endif
|
|
|
|
/** @} */
|
|
#endif
|