HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
tokens.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef USDPHYSICS_TOKENS_H
25 #define USDPHYSICS_TOKENS_H
26 
27 /// \file usdPhysics/tokens.h
28 
29 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
30 //
31 // This is an automatically generated file (by usdGenSchema.py).
32 // Do not hand-edit!
33 //
34 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
35 
36 #include "pxr/pxr.h"
37 #include "pxr/usd/usdPhysics/api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdPhysicsTokensType
46 ///
47 /// \link UsdPhysicsTokens \endlink provides static, efficient
48 /// \link TfToken TfTokens\endlink for use in all public USD API.
49 ///
50 /// These tokens are auto-generated from the module's schema, representing
51 /// property names, for when you need to fetch an attribute or relationship
52 /// directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient
53 /// manner, and allow the compiler to verify that you spelled the name
54 /// correctly.
55 ///
56 /// UsdPhysicsTokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use UsdPhysicsTokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(UsdPhysicsTokens->acceleration);
62 /// \endcode
65  /// \brief "acceleration"
66  ///
67  /// Possible value for UsdPhysicsDriveAPI::GetTypeAttr()
69  /// \brief "angular"
70  ///
71  /// This token represents the angular degree of freedom used in Revolute Joint Drive.
73  /// \brief "boundingCube"
74  ///
75  /// Possible value for UsdPhysicsMeshCollisionAPI::GetApproximationAttr()
77  /// \brief "boundingSphere"
78  ///
79  /// Possible value for UsdPhysicsMeshCollisionAPI::GetApproximationAttr()
81  /// \brief "colliders"
82  ///
83  /// This token represents the collection name to use with UsdCollectionAPI to represent colliders of a CollisionGroup prim.
85  /// \brief "convexDecomposition"
86  ///
87  /// Possible value for UsdPhysicsMeshCollisionAPI::GetApproximationAttr()
89  /// \brief "convexHull"
90  ///
91  /// Possible value for UsdPhysicsMeshCollisionAPI::GetApproximationAttr()
93  /// \brief "distance"
94  ///
95  /// This token represents the distance limit used for generic D6 joint.
97  /// \brief "drive"
98  ///
99  /// Property namespace prefix for the UsdPhysicsDriveAPI schema.
100  const TfToken drive;
101  /// \brief "drive:__INSTANCE_NAME__:physics:damping"
102  ///
103  /// UsdPhysicsDriveAPI
105  /// \brief "drive:__INSTANCE_NAME__:physics:maxForce"
106  ///
107  /// UsdPhysicsDriveAPI
109  /// \brief "drive:__INSTANCE_NAME__:physics:stiffness"
110  ///
111  /// UsdPhysicsDriveAPI
113  /// \brief "drive:__INSTANCE_NAME__:physics:targetPosition"
114  ///
115  /// UsdPhysicsDriveAPI
117  /// \brief "drive:__INSTANCE_NAME__:physics:targetVelocity"
118  ///
119  /// UsdPhysicsDriveAPI
121  /// \brief "drive:__INSTANCE_NAME__:physics:type"
122  ///
123  /// UsdPhysicsDriveAPI
125  /// \brief "force"
126  ///
127  /// Possible value for UsdPhysicsDriveAPI::GetTypeAttr(), Default value for UsdPhysicsDriveAPI::GetTypeAttr()
128  const TfToken force;
129  /// \brief "kilogramsPerUnit"
130  ///
131  /// Stage-level metadata that encodes a scene's linear unit of measure as kilograms per encoded unit.
133  /// \brief "limit"
134  ///
135  /// Property namespace prefix for the UsdPhysicsLimitAPI schema.
136  const TfToken limit;
137  /// \brief "limit:__INSTANCE_NAME__:physics:high"
138  ///
139  /// UsdPhysicsLimitAPI
141  /// \brief "limit:__INSTANCE_NAME__:physics:low"
142  ///
143  /// UsdPhysicsLimitAPI
145  /// \brief "linear"
146  ///
147  /// This token represents the linear degree of freedom used in Prismatic Joint Drive.
149  /// \brief "meshSimplification"
150  ///
151  /// Possible value for UsdPhysicsMeshCollisionAPI::GetApproximationAttr()
153  /// \brief "none"
154  ///
155  /// Possible value for UsdPhysicsMeshCollisionAPI::GetApproximationAttr(), Default value for UsdPhysicsMeshCollisionAPI::GetApproximationAttr()
156  const TfToken none;
157  /// \brief "physics:angularVelocity"
158  ///
159  /// UsdPhysicsRigidBodyAPI
161  /// \brief "physics:approximation"
162  ///
163  /// UsdPhysicsMeshCollisionAPI
165  /// \brief "physics:axis"
166  ///
167  /// UsdPhysicsSphericalJoint, UsdPhysicsPrismaticJoint, UsdPhysicsRevoluteJoint
169  /// \brief "physics:body0"
170  ///
171  /// UsdPhysicsJoint
173  /// \brief "physics:body1"
174  ///
175  /// UsdPhysicsJoint
177  /// \brief "physics:breakForce"
178  ///
179  /// UsdPhysicsJoint
181  /// \brief "physics:breakTorque"
182  ///
183  /// UsdPhysicsJoint
185  /// \brief "physics:centerOfMass"
186  ///
187  /// UsdPhysicsMassAPI
189  /// \brief "physics:collisionEnabled"
190  ///
191  /// UsdPhysicsJoint, UsdPhysicsCollisionAPI
193  /// \brief "physics:coneAngle0Limit"
194  ///
195  /// UsdPhysicsSphericalJoint
197  /// \brief "physics:coneAngle1Limit"
198  ///
199  /// UsdPhysicsSphericalJoint
201  /// \brief "physics:density"
202  ///
203  /// UsdPhysicsMaterialAPI, UsdPhysicsMassAPI
205  /// \brief "physics:diagonalInertia"
206  ///
207  /// UsdPhysicsMassAPI
209  /// \brief "physics:dynamicFriction"
210  ///
211  /// UsdPhysicsMaterialAPI
213  /// \brief "physics:excludeFromArticulation"
214  ///
215  /// UsdPhysicsJoint
217  /// \brief "physics:filteredGroups"
218  ///
219  /// UsdPhysicsCollisionGroup
221  /// \brief "physics:filteredPairs"
222  ///
223  /// UsdPhysicsFilteredPairsAPI
225  /// \brief "physics:gravityDirection"
226  ///
227  /// UsdPhysicsScene
229  /// \brief "physics:gravityMagnitude"
230  ///
231  /// UsdPhysicsScene
233  /// \brief "physics:jointEnabled"
234  ///
235  /// UsdPhysicsJoint
237  /// \brief "physics:kinematicEnabled"
238  ///
239  /// UsdPhysicsRigidBodyAPI
241  /// \brief "physics:localPos0"
242  ///
243  /// UsdPhysicsJoint
245  /// \brief "physics:localPos1"
246  ///
247  /// UsdPhysicsJoint
249  /// \brief "physics:localRot0"
250  ///
251  /// UsdPhysicsJoint
253  /// \brief "physics:localRot1"
254  ///
255  /// UsdPhysicsJoint
257  /// \brief "physics:lowerLimit"
258  ///
259  /// UsdPhysicsPrismaticJoint, UsdPhysicsRevoluteJoint
261  /// \brief "physics:mass"
262  ///
263  /// UsdPhysicsMassAPI
265  /// \brief "physics:maxDistance"
266  ///
267  /// UsdPhysicsDistanceJoint
269  /// \brief "physics:minDistance"
270  ///
271  /// UsdPhysicsDistanceJoint
273  /// \brief "physics:principalAxes"
274  ///
275  /// UsdPhysicsMassAPI
277  /// \brief "physics:restitution"
278  ///
279  /// UsdPhysicsMaterialAPI
281  /// \brief "physics:rigidBodyEnabled"
282  ///
283  /// UsdPhysicsRigidBodyAPI
285  /// \brief "physics:simulationOwner"
286  ///
287  /// UsdPhysicsCollisionAPI, UsdPhysicsRigidBodyAPI
289  /// \brief "physics:startsAsleep"
290  ///
291  /// UsdPhysicsRigidBodyAPI
293  /// \brief "physics:staticFriction"
294  ///
295  /// UsdPhysicsMaterialAPI
297  /// \brief "physics:upperLimit"
298  ///
299  /// UsdPhysicsPrismaticJoint, UsdPhysicsRevoluteJoint
301  /// \brief "physics:velocity"
302  ///
303  /// UsdPhysicsRigidBodyAPI
305  /// \brief "rotX"
306  ///
307  /// This token represents the rotate around X axis degree of freedom used in Joint Limits and Drives.
308  const TfToken rotX;
309  /// \brief "rotY"
310  ///
311  /// This token represents the rotate around Y axis degree of freedom used in Joint Limits and Drives.
312  const TfToken rotY;
313  /// \brief "rotZ"
314  ///
315  /// This token represents the rotate around Z axis degree of freedom used in Joint Limits and Drives.
316  const TfToken rotZ;
317  /// \brief "transX"
318  ///
319  /// This token represents the translate around X axis degree of freedom used in Joint Limits and Drives.
321  /// \brief "transY"
322  ///
323  /// This token represents the translate around Y axis degree of freedom used in Joint Limits and Drives.
325  /// \brief "transZ"
326  ///
327  /// This token represents the translate around Z axis degree of freedom used in Joint Limits and Drives.
329  /// \brief "X"
330  ///
331  /// Possible value for UsdPhysicsSphericalJoint::GetAxisAttr(), Default value for UsdPhysicsSphericalJoint::GetAxisAttr(), Possible value for UsdPhysicsPrismaticJoint::GetAxisAttr(), Default value for UsdPhysicsPrismaticJoint::GetAxisAttr(), Possible value for UsdPhysicsRevoluteJoint::GetAxisAttr(), Default value for UsdPhysicsRevoluteJoint::GetAxisAttr()
332  const TfToken x;
333  /// \brief "Y"
334  ///
335  /// Possible value for UsdPhysicsSphericalJoint::GetAxisAttr(), Possible value for UsdPhysicsPrismaticJoint::GetAxisAttr(), Possible value for UsdPhysicsRevoluteJoint::GetAxisAttr()
336  const TfToken y;
337  /// \brief "Z"
338  ///
339  /// Possible value for UsdPhysicsSphericalJoint::GetAxisAttr(), Possible value for UsdPhysicsPrismaticJoint::GetAxisAttr(), Possible value for UsdPhysicsRevoluteJoint::GetAxisAttr()
340  const TfToken z;
341  /// A vector of all of the tokens listed above.
342  const std::vector<TfToken> allTokens;
343 };
344 
345 /// \var UsdPhysicsTokens
346 ///
347 /// A global variable with static, efficient \link TfToken TfTokens\endlink
348 /// for use in all public USD API. \sa UsdPhysicsTokensType
350 
352 
353 #endif
const TfToken physicsLocalPos1
"physics:localPos1"
Definition: tokens.h:248
const TfToken convexHull
"convexHull"
Definition: tokens.h:92
const TfToken physicsCenterOfMass
"physics:centerOfMass"
Definition: tokens.h:188
const TfToken drive
"drive"
Definition: tokens.h:100
const TfToken physicsMinDistance
"physics:minDistance"
Definition: tokens.h:272
const TfToken physicsBody0
"physics:body0"
Definition: tokens.h:172
const TfToken y
"Y"
Definition: tokens.h:336
const TfToken z
"Z"
Definition: tokens.h:340
const TfToken physicsMass
"physics:mass"
Definition: tokens.h:264
const TfToken physicsCollisionEnabled
"physics:collisionEnabled"
Definition: tokens.h:192
const TfToken physicsLocalPos0
"physics:localPos0"
Definition: tokens.h:244
const TfToken rotZ
"rotZ"
Definition: tokens.h:316
const TfToken force
"force"
Definition: tokens.h:128
const TfToken physicsStartsAsleep
"physics:startsAsleep"
Definition: tokens.h:292
const TfToken physicsFilteredPairs
"physics:filteredPairs"
Definition: tokens.h:224
const TfToken physicsUpperLimit
"physics:upperLimit"
Definition: tokens.h:300
const TfToken physicsRestitution
"physics:restitution"
Definition: tokens.h:280
const TfToken physicsLocalRot0
"physics:localRot0"
Definition: tokens.h:252
const TfToken transX
"transX"
Definition: tokens.h:320
const TfToken physicsBreakTorque
"physics:breakTorque"
Definition: tokens.h:184
const TfToken physicsLocalRot1
"physics:localRot1"
Definition: tokens.h:256
const TfToken physicsExcludeFromArticulation
"physics:excludeFromArticulation"
Definition: tokens.h:216
const TfToken physicsKinematicEnabled
"physics:kinematicEnabled"
Definition: tokens.h:240
const TfToken acceleration
"acceleration"
Definition: tokens.h:68
const TfToken physicsDynamicFriction
"physics:dynamicFriction"
Definition: tokens.h:212
const TfToken physicsGravityMagnitude
"physics:gravityMagnitude"
Definition: tokens.h:232
USDPHYSICS_API TfStaticData< UsdPhysicsTokensType > UsdPhysicsTokens
const TfToken physicsPrincipalAxes
"physics:principalAxes"
Definition: tokens.h:276
const TfToken physicsMaxDistance
"physics:maxDistance"
Definition: tokens.h:268
const TfToken kilogramsPerUnit
"kilogramsPerUnit"
Definition: tokens.h:132
USDPHYSICS_API UsdPhysicsTokensType()
const TfToken transY
"transY"
Definition: tokens.h:324
const TfToken x
"X"
Definition: tokens.h:332
Definition: token.h:87
const TfToken drive_MultipleApplyTemplate_PhysicsType
"drive:__INSTANCE_NAME__:physics:type"
Definition: tokens.h:124
const TfToken limit_MultipleApplyTemplate_PhysicsHigh
"limit:__INSTANCE_NAME__:physics:high"
Definition: tokens.h:140
const TfToken physicsBody1
"physics:body1"
Definition: tokens.h:176
const TfToken physicsLowerLimit
"physics:lowerLimit"
Definition: tokens.h:260
const TfToken physicsVelocity
"physics:velocity"
Definition: tokens.h:304
const TfToken physicsDiagonalInertia
"physics:diagonalInertia"
Definition: tokens.h:208
const TfToken linear
"linear"
Definition: tokens.h:148
const TfToken rotX
"rotX"
Definition: tokens.h:308
const TfToken physicsRigidBodyEnabled
"physics:rigidBodyEnabled"
Definition: tokens.h:284
const TfToken physicsStaticFriction
"physics:staticFriction"
Definition: tokens.h:296
const TfToken colliders
"colliders"
Definition: tokens.h:84
const TfToken physicsAxis
"physics:axis"
Definition: tokens.h:168
const TfToken meshSimplification
"meshSimplification"
Definition: tokens.h:152
const TfToken physicsConeAngle1Limit
"physics:coneAngle1Limit"
Definition: tokens.h:200
const TfToken physicsAngularVelocity
"physics:angularVelocity"
Definition: tokens.h:160
#define USDPHYSICS_API
Definition: api.h:40
const TfToken drive_MultipleApplyTemplate_PhysicsTargetPosition
"drive:__INSTANCE_NAME__:physics:targetPosition"
Definition: tokens.h:116
const TfToken physicsConeAngle0Limit
"physics:coneAngle0Limit"
Definition: tokens.h:196
const TfToken none
"none"
Definition: tokens.h:156
const TfToken transZ
"transZ"
Definition: tokens.h:328
const TfToken boundingCube
"boundingCube"
Definition: tokens.h:76
const TfToken drive_MultipleApplyTemplate_PhysicsDamping
"drive:__INSTANCE_NAME__:physics:damping"
Definition: tokens.h:104
const TfToken physicsJointEnabled
"physics:jointEnabled"
Definition: tokens.h:236
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
const TfToken drive_MultipleApplyTemplate_PhysicsStiffness
"drive:__INSTANCE_NAME__:physics:stiffness"
Definition: tokens.h:112
const TfToken distance
"distance"
Definition: tokens.h:96
const TfToken physicsBreakForce
"physics:breakForce"
Definition: tokens.h:180
const TfToken convexDecomposition
"convexDecomposition"
Definition: tokens.h:88
const TfToken physicsApproximation
"physics:approximation"
Definition: tokens.h:164
const TfToken physicsGravityDirection
"physics:gravityDirection"
Definition: tokens.h:228
const TfToken angular
"angular"
Definition: tokens.h:72
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:342
const TfToken boundingSphere
"boundingSphere"
Definition: tokens.h:80
const TfToken limit
"limit"
Definition: tokens.h:136
const TfToken drive_MultipleApplyTemplate_PhysicsMaxForce
"drive:__INSTANCE_NAME__:physics:maxForce"
Definition: tokens.h:108
const TfToken physicsSimulationOwner
"physics:simulationOwner"
Definition: tokens.h:288
const TfToken physicsDensity
"physics:density"
Definition: tokens.h:204
const TfToken rotY
"rotY"
Definition: tokens.h:312
const TfToken physicsFilteredGroups
"physics:filteredGroups"
Definition: tokens.h:220
const TfToken drive_MultipleApplyTemplate_PhysicsTargetVelocity
"drive:__INSTANCE_NAME__:physics:targetVelocity"
Definition: tokens.h:120
const TfToken limit_MultipleApplyTemplate_PhysicsLow
"limit:__INSTANCE_NAME__:physics:low"
Definition: tokens.h:144