RavEngine
Loading...
Searching...
No Matches
physx::PxSphereGeometry Class Reference

A class representing the geometry of a sphere. More...

#include <PxSphereGeometry.h>

Inheritance diagram for physx::PxSphereGeometry:
[legend]
Collaboration diagram for physx::PxSphereGeometry:
[legend]

Public Member Functions

PX_INLINE PxSphereGeometry (PxReal ir=0.0f)
 Constructor.
 
PX_INLINE PxSphereGeometry (const PxSphereGeometry &that)
 Copy constructor.
 
PX_INLINE void operator= (const PxSphereGeometry &that)
 Assignment operator.
 
PX_INLINE bool isValid () const
 Returns true if the geometry is valid.
 
- Public Member Functions inherited from physx::PxGeometry
PX_CUDA_CALLABLE PX_FORCE_INLINE PxGeometryType::Enum getType () const
 Returns the type of the geometry.
 
PX_INLINE void operator= (const PxGeometry &that)
 Assignment operator.
 

Public Attributes

PxReal radius
 The radius of the sphere.
 
- Public Attributes inherited from physx::PxGeometry
float mTypePadding
 

Additional Inherited Members

- Protected Member Functions inherited from physx::PxGeometry
PX_CUDA_CALLABLE PX_FORCE_INLINE PxGeometry (PxGeometryType::Enum type)
 
PX_CUDA_CALLABLE PX_FORCE_INLINE PxGeometry (const PxGeometry &that)
 
- Protected Attributes inherited from physx::PxGeometry
PxGeometryType::Enum mType
 

Detailed Description

A class representing the geometry of a sphere.

Spheres are defined by their radius.

Note
The scaling of the sphere is expected to be baked into this value, there is no additional scaling parameter.

Constructor & Destructor Documentation

◆ PxSphereGeometry()

PX_INLINE physx::PxSphereGeometry::PxSphereGeometry ( const PxSphereGeometry &  that)
inline

Copy constructor.

Parameters
[in]thatOther object

Member Function Documentation

◆ isValid()

PX_INLINE bool physx::PxSphereGeometry::isValid ( ) const

Returns true if the geometry is valid.

Returns
True if the current settings are valid
Note
A valid sphere has radius > 0.
It is illegal to call PxRigidActor::createShape and PxPhysics::createShape with a sphere that has zero radius.
See also
PxRigidActor::createShape, PxPhysics::createShape

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