aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Include/PxClient.h
blob: 68e1e130969f7a6e3aef4d69340f9297af53b795 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_PHYSICS_NX_CLIENT
#define PX_PHYSICS_NX_CLIENT

#include "foundation/PxFlags.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

/**
\brief An ID to identify different clients for multiclient support.

@see PxScene::createClient() 
*/
typedef PxU8 PxClientID;

/**
\brief The predefined default PxClientID value.

@see PxClientID PxScene::createClient() 
*/
static const PxClientID PX_DEFAULT_CLIENT = 0;

/**
\brief The maximum number of clients we support.

@see PxClientID PxScene::createClient() 
*/
static const PxClientID PX_MAX_CLIENTS = 128;

/**
\brief Behavior bit flags for simulation clients.

\deprecated PxClientBehaviorFlag feature has been deprecated in PhysX version 3.4

@see PxClientBehaviorFlags PxScene::setClientBehaviorFlags() 
*/
struct PX_DEPRECATED PxClientBehaviorFlag
{ 
	enum Enum 
	{
		/**
		\brief Report actors belonging to other clients to the trigger callback of this client.

		@see PxSimulationEventCallback::onTrigger()
		*/
		eREPORT_FOREIGN_OBJECTS_TO_TRIGGER_NOTIFY			= (1<<0),
		/**
		\brief Report actors belonging to other clients to the contact callback of this client.

		@see PxSimulationEventCallback::onContact()
		*/
		eREPORT_FOREIGN_OBJECTS_TO_CONTACT_NOTIFY			= (1<<1),
		/**
		\brief Report actors belonging to other clients to the constraint break callback of this client.

		@see PxSimulationEventCallback::onConstraintBreak()
		*/
		eREPORT_FOREIGN_OBJECTS_TO_CONSTRAINT_BREAK_NOTIFY	= (1<<2),
		/**
		\brief Report actors belonging to other clients to scene queries of this client.
		*/
		eREPORT_FOREIGN_OBJECTS_TO_SCENE_QUERY				= (1<<3)
	};
};

/**
\brief Bitfield that contains a set of raised flags defined in PxClientBehaviorFlag.

\deprecated PxActorClientBehaviorFlag feature has been deprecated in PhysX version 3.4

@see PxClientBehaviorFlag PxScene::setClientBehaviorFlags() 
*/
typedef PX_DEPRECATED PxFlags<PxClientBehaviorFlag::Enum, PxU8> PxClientBehaviorFlags;
PX_FLAGS_OPERATORS(PxClientBehaviorFlag::Enum, PxU8)


/**
\brief Multiclient behavior bit flags for actors.

\deprecated PxActorClientBehaviorFlag feature has been deprecated in PhysX version 3.4

@see PxActorClientBehaviorFlags PxActor::setClientBehaviorFlags()
*/
struct PX_DEPRECATED PxActorClientBehaviorFlag
{ 
	enum Enum
	{
		/**
		\brief Report this actor to trigger callbacks of other clients.

		@see PxSimulationEventCallback::onTrigger()
		*/
		eREPORT_TO_FOREIGN_CLIENTS_TRIGGER_NOTIFY			= (1<<0),
		/**
		\brief Report this actor to contact callbacks of other clients.

		@see PxSimulationEventCallback::onContact()
		*/
		eREPORT_TO_FOREIGN_CLIENTS_CONTACT_NOTIFY			= (1<<1),
		/**
		\brief Report this actor to constraint break callbacks of other clients.

		@see PxSimulationEventCallback::onConstraintBreak()
		*/
		eREPORT_TO_FOREIGN_CLIENTS_CONSTRAINT_BREAK_NOTIFY	= (1<<2),
		/**
		\brief Report this actor to scene queries of other clients.
		*/
		eREPORT_TO_FOREIGN_CLIENTS_SCENE_QUERY				= (1<<3)
	};
};

/**
\brief Bitfield that contains a set of raised flags defined in PxActorClientBehaviorFlag.

\deprecated PxActorClientBehaviorFlag feature has been deprecated in PhysX version 3.4

@see PxActorClientBehaviorFlag PxActor::setClientBehaviorFlags()
*/
typedef PX_DEPRECATED PxFlags<PxActorClientBehaviorFlag::Enum, PxU8> PxActorClientBehaviorFlags;
PX_FLAGS_OPERATORS(PxActorClientBehaviorFlag::Enum, PxU8)

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif