1//
2// Redistribution and use in source and binary forms, with or without
3// modification, are permitted provided that the following conditions
4// are met:
5// * Redistributions of source code must retain the above copyright
6// notice, this list of conditions and the following disclaimer.
7// * Redistributions in binary form must reproduce the above copyright
8// notice, this list of conditions and the following disclaimer in the
9// documentation and/or other materials provided with the distribution.
10// * Neither the name of NVIDIA CORPORATION nor the names of its
11// contributors may be used to endorse or promote products derived
12// from this software without specific prior written permission.
13//
14// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
15// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25//
26// Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.
27// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29
30#ifndef PX_PHYSICS_CCT_BEHAVIOR
31#define PX_PHYSICS_CCT_BEHAVIOR
32/** \addtogroup character
33 @{
34*/
35
36#include "PxFiltering.h"
37
38#if !PX_DOXYGEN
39namespace physx
40{
41#endif
42
43 class PxShape;
44 class PxObstacle;
45 class PxController;
46
47 /**
48 \brief specifies controller behavior
49 */
50 struct PxControllerBehaviorFlag
51 {
52 enum Enum
53 {
54 eCCT_CAN_RIDE_ON_OBJECT = (1<<0), //!< Controller can ride on touched object (i.e. when this touched object is moving horizontally). \note The CCT vs. CCT case is not supported.
55 eCCT_SLIDE = (1<<1), //!< Controller should slide on touched object
56 eCCT_USER_DEFINED_RIDE = (1<<2) //!< Disable all code dealing with controllers riding on objects, let users define it outside of the SDK.
57 };
58 };
59
60 /**
61 \brief Bitfield that contains a set of raised flags defined in PxControllerBehaviorFlag.
62
63 @see PxControllerBehaviorFlag
64 */
65 typedef PxFlags<PxControllerBehaviorFlag::Enum, PxU8> PxControllerBehaviorFlags;
66 PX_FLAGS_OPERATORS(PxControllerBehaviorFlag::Enum, PxU8)
67
68 /**
69 \brief User behavior callback.
70
71 This behavior callback is called to customize the controller's behavior w.r.t. touched shapes.
72 */
73 class PxControllerBehaviorCallback
74 {
75 public:
76 /**
77 \brief Retrieve behavior flags for a shape.
78
79 When the CCT touches a shape, the CCT's behavior w.r.t. this shape can be customized by users.
80 This function retrieves the desired PxControllerBehaviorFlag flags capturing the desired behavior.
81
82 \note See comments about deprecated functions at the start of this class
83
84 \param[in] shape The shape the CCT is currently touching
85 \param[in] actor The actor owning the shape
86
87 \return Desired behavior flags for the given shape
88
89 @see PxControllerBehaviorFlag
90 */
91 virtual PxControllerBehaviorFlags getBehaviorFlags(const PxShape& shape, const PxActor& actor) = 0;
92
93 /**
94 \brief Retrieve behavior flags for a controller.
95
96 When the CCT touches a controller, the CCT's behavior w.r.t. this controller can be customized by users.
97 This function retrieves the desired PxControllerBehaviorFlag flags capturing the desired behavior.
98
99 \note The flag PxControllerBehaviorFlag::eCCT_CAN_RIDE_ON_OBJECT is not supported.
100 \note See comments about deprecated functions at the start of this class
101
102 \param[in] controller The controller the CCT is currently touching
103
104 \return Desired behavior flags for the given controller
105
106 @see PxControllerBehaviorFlag
107 */
108 virtual PxControllerBehaviorFlags getBehaviorFlags(const PxController& controller) = 0;
109
110 /**
111 \brief Retrieve behavior flags for an obstacle.
112
113 When the CCT touches an obstacle, the CCT's behavior w.r.t. this obstacle can be customized by users.
114 This function retrieves the desired PxControllerBehaviorFlag flags capturing the desired behavior.
115
116 \note See comments about deprecated functions at the start of this class
117
118 \param[in] obstacle The obstacle the CCT is currently touching
119
120 \return Desired behavior flags for the given obstacle
121
122 @see PxControllerBehaviorFlag
123 */
124 virtual PxControllerBehaviorFlags getBehaviorFlags(const PxObstacle& obstacle) = 0;
125
126 protected:
127 virtual ~PxControllerBehaviorCallback(){}
128 };
129
130#if !PX_DOXYGEN
131}
132#endif
133
134/** @} */
135#endif
136

source code of qtquick3dphysics/src/3rdparty/PhysX/include/characterkinematic/PxControllerBehavior.h