NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBoxGeometry Class Reference

NVIDIA PhysX SDK 3.4 API

PxBoxGeometry Class Reference
[Geomutils]

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

#include <PxBoxGeometry.h>

Inheritance diagram for PxBoxGeometry:
Collaboration diagram for PxBoxGeometry:

List of all members.


Public Member Functions

PX_INLINE PxBoxGeometry ()
 Default constructor, initializes to a box with zero dimensions.
PX_INLINE PxBoxGeometry (PxReal hx, PxReal hy, PxReal hz)
 Constructor to initialize half extents from scalar parameters.
PX_INLINE PxBoxGeometry (PxVec3 halfExtents_)
 Constructor to initialize half extents from vector parameter.
PX_INLINE bool isValid () const
 Returns true if the geometry is valid.

Public Attributes

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

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

PX_INLINE PxBoxGeometry::PxBoxGeometry (  )  [inline]

Default constructor, initializes to a box with zero dimensions.

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

Constructor to initialize half extents from scalar parameters.

Parameters:
hx Initial half extents' x component.
hy Initial half extents' y component.
hz Initial half extents' z component.

PX_INLINE PxBoxGeometry::PxBoxGeometry ( PxVec3  halfExtents_  )  [inline]

Constructor to initialize half extents from vector parameter.

Parameters:
halfExtents_ Initial half extents.


Member Data Documentation

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

Referenced by isValid(), and PxMassProperties::PxMassProperties().


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



Copyright © 2008-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com