From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/classPxBoxController.html | 283 +++++++++++++++++++++ 1 file changed, 283 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html new file mode 100644 index 00000000..97d20f43 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html @@ -0,0 +1,283 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBoxController Class Reference + + + + + + + +
+

PxBoxController Class Reference
+ +[Character] +

Box character controller. +More... +

+#include <PxBoxController.h> +

+

+Inheritance diagram for PxBoxController:
+
+

Inheritance graph
+ +PxController +
[legend]
+
+Collaboration diagram for PxBoxController:
+
+

Collaboration graph
+ +PxController +
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

virtual PxF32 getHalfHeight () const =0
 Gets controller's half height.
virtual PxF32 getHalfSideExtent () const =0
 Gets controller's half side extent.
virtual PxF32 getHalfForwardExtent () const =0
 Gets controller's half forward extent.
virtual bool setHalfHeight (PxF32 halfHeight)=0
 Sets controller's half height.
virtual bool setHalfSideExtent (PxF32 halfSideExtent)=0
 Sets controller's half side extent.
virtual bool setHalfForwardExtent (PxF32 halfForwardExtent)=0
 Sets controller's half forward extent.

Protected Member Functions

PX_INLINE PxBoxController ()
virtual ~PxBoxController ()
+

Detailed Description

+Box character controller. +

+

See also:
PxBoxControllerDesc PxController
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PX_INLINE PxBoxController::PxBoxController (  )  [inline, protected]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
virtual PxBoxController::~PxBoxController (  )  [inline, protected, virtual]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
virtual PxF32 PxBoxController::getHalfForwardExtent (  )  const [pure virtual]
+
+
+ +

+Gets controller's half forward extent. +

+

Returns:
The half forward extent of the controller.
+
See also:
PxBoxControllerDesc.halfForwardExtent setHalfForwardExtent()
+ +
+

+ +

+
+ + + + + + + + +
virtual PxF32 PxBoxController::getHalfHeight (  )  const [pure virtual]
+
+
+ +

+Gets controller's half height. +

+

Returns:
The half height of the controller.
+
See also:
PxBoxControllerDesc.halfHeight setHalfHeight()
+ +
+

+ +

+
+ + + + + + + + +
virtual PxF32 PxBoxController::getHalfSideExtent (  )  const [pure virtual]
+
+
+ +

+Gets controller's half side extent. +

+

Returns:
The half side extent of the controller.
+
See also:
PxBoxControllerDesc.halfSideExtent setHalfSideExtent()
+ +
+

+ +

+
+ + + + + + + + + +
virtual bool PxBoxController::setHalfForwardExtent (PxF32  halfForwardExtent  )  [pure virtual]
+
+
+ +

+Sets controller's half forward extent. +

+

Warning:
this doesn't check for collisions.
+
Parameters:
+ + +
[in] halfForwardExtent The new half forward extent for the controller.
+
+
Returns:
Currently always true.
+
See also:
PxBoxControllerDesc.halfForwardExtent getHalfForwardExtent()
+ +
+

+ +

+
+ + + + + + + + + +
virtual bool PxBoxController::setHalfHeight (PxF32  halfHeight  )  [pure virtual]
+
+
+ +

+Sets controller's half height. +

+

Warning:
this doesn't check for collisions.
+
Parameters:
+ + +
[in] halfHeight The new half height for the controller.
+
+
Returns:
Currently always true.
+
See also:
PxBoxControllerDesc.halfHeight getHalfHeight()
+ +
+

+ +

+
+ + + + + + + + + +
virtual bool PxBoxController::setHalfSideExtent (PxF32  halfSideExtent  )  [pure virtual]
+
+
+ +

+Sets controller's half side extent. +

+

Warning:
this doesn't check for collisions.
+
Parameters:
+ + +
[in] halfSideExtent The new half side extent for the controller.
+
+
Returns:
Currently always true.
+
See also:
PxBoxControllerDesc.halfSideExtent getHalfSideExtent()
+ +
+

+

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

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