PxBoxGeometry Class Reference

Class representing the geometry of a box. More...

#include <PxBoxGeometry.h>

Inheritance diagram for PxBoxGeometry:
Collaboration diagram for PxBoxGeometry:

Public Member Functions

PX_INLINE PxBoxGeometry ()
 Default constructor, initializes to a box with zero dimensions. More...
 
PX_INLINE PxBoxGeometry (PxReal hx, PxReal hy, PxReal hz)
 Constructor to initialize half extents from scalar parameters. More...
 
PX_INLINE PxBoxGeometry (PxVec3 halfExtents_)
 Constructor to initialize half extents from vector parameter. More...
 
PX_INLINE bool isValid () const
 Returns true if the geometry is valid. More...
 
- Public Member Functions inherited from PxGeometry
PX_CUDA_CALLABLE PX_FORCE_INLINE PxGeometryType::Enum getType () const
 Returns the type of the geometry. More...
 

Public Attributes

PxVec3 halfExtents
 Half of the width, height, and depth of the box. More...
 

Additional Inherited Members

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

Detailed Description

Class representing the geometry of a box.

The geometry of a box can be fully specified by its half extents. This is the half of its width, height, and depth.

Note
The scaling of the box is expected to be baked into these values, there is no additional scaling parameter.

Constructor & Destructor Documentation

◆ PxBoxGeometry() [1/3]

PX_INLINE PxBoxGeometry::PxBoxGeometry ( )
inline

Default constructor, initializes to a box with zero dimensions.

◆ PxBoxGeometry() [2/3]

PX_INLINE PxBoxGeometry::PxBoxGeometry ( PxReal  hx,
PxReal  hy,
PxReal  hz 
)
inline

Constructor to initialize half extents from scalar parameters.

Parameters
hxInitial half extents' x component.
hyInitial half extents' y component.
hzInitial half extents' z component.

◆ PxBoxGeometry() [3/3]

PX_INLINE PxBoxGeometry::PxBoxGeometry ( PxVec3  halfExtents_)
inline

Constructor to initialize half extents from vector parameter.

Parameters
halfExtents_Initial half extents.

Member Data Documentation

◆ halfExtents

PxVec3 PxBoxGeometry::halfExtents

Half of the width, height, and depth of the box.

Referenced by PxMassProperties::PxMassProperties().


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