All Classes Files Functions Variables Pages
physxLimitAPI.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 PHYSXSCHEMA_GENERATED_PHYSXLIMITAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXLIMITAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.h"
31 #include "pxr/usd/usd/apiSchemaBase.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include ".//tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // PHYSXLIMITAPI //
51 // -------------------------------------------------------------------------- //
52 
56 class PhysxSchemaPhysxLimitAPI : public UsdAPISchemaBase
57 {
58 public:
62  static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI;
63 
73  explicit PhysxSchemaPhysxLimitAPI(
74  const UsdPrim& prim=UsdPrim(), const TfToken &name=TfToken())
75  : UsdAPISchemaBase(prim, /*instanceName*/ name)
76  { }
77 
82  explicit PhysxSchemaPhysxLimitAPI(
83  const UsdSchemaBase& schemaObj, const TfToken &name)
84  : UsdAPISchemaBase(schemaObj, /*instanceName*/ name)
85  { }
86 
88  PHYSXSCHEMA_API
89  virtual ~PhysxSchemaPhysxLimitAPI();
90 
94  PHYSXSCHEMA_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
103  PHYSXSCHEMA_API
104  static TfTokenVector
105  GetSchemaAttributeNames(bool includeInherited, const TfToken &instanceName);
106 
108  TfToken GetName() const {
109  return _GetInstanceName();
110  }
111 
126  PHYSXSCHEMA_API
127  static PhysxSchemaPhysxLimitAPI
128  Get(const UsdStagePtr &stage, const SdfPath &path);
129 
132  PHYSXSCHEMA_API
133  static PhysxSchemaPhysxLimitAPI
134  Get(const UsdPrim &prim, const TfToken &name);
135 
138  PHYSXSCHEMA_API
139  static std::vector<PhysxSchemaPhysxLimitAPI>
140  GetAll(const UsdPrim &prim);
141 
144  PHYSXSCHEMA_API
145  static bool
146  IsSchemaPropertyBaseName(const TfToken &baseName);
147 
151  PHYSXSCHEMA_API
152  static bool
153  IsPhysxLimitAPIPath(const SdfPath &path, TfToken *name);
154 
171  PHYSXSCHEMA_API
172  static bool
173  CanApply(const UsdPrim &prim, const TfToken &name,
174  std::string *whyNot=nullptr);
175 
195  PHYSXSCHEMA_API
196  static PhysxSchemaPhysxLimitAPI
197  Apply(const UsdPrim &prim, const TfToken &name);
198 
199 protected:
203  PHYSXSCHEMA_API
204  UsdSchemaKind _GetSchemaKind() const override;
205 
206 private:
207  // needs to invoke _GetStaticTfType.
208  friend class UsdSchemaRegistry;
209  PHYSXSCHEMA_API
210  static const TfType &_GetStaticTfType();
211 
212  static bool _IsTypedSchema();
213 
214  // override SchemaBase virtuals.
215  PHYSXSCHEMA_API
216  const TfType &_GetTfType() const override;
217 
218 public:
219  // --------------------------------------------------------------------- //
220  // RESTITUTION
221  // --------------------------------------------------------------------- //
231  PHYSXSCHEMA_API
232  UsdAttribute GetRestitutionAttr() const;
233 
239  PHYSXSCHEMA_API
240  UsdAttribute CreateRestitutionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
241 
242 public:
243  // --------------------------------------------------------------------- //
244  // BOUNCETHRESHOLD
245  // --------------------------------------------------------------------- //
256  PHYSXSCHEMA_API
257  UsdAttribute GetBounceThresholdAttr() const;
258 
264  PHYSXSCHEMA_API
265  UsdAttribute CreateBounceThresholdAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
266 
267 public:
268  // --------------------------------------------------------------------- //
269  // STIFFNESS
270  // --------------------------------------------------------------------- //
281  PHYSXSCHEMA_API
282  UsdAttribute GetStiffnessAttr() const;
283 
289  PHYSXSCHEMA_API
290  UsdAttribute CreateStiffnessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
291 
292 public:
293  // --------------------------------------------------------------------- //
294  // DAMPING
295  // --------------------------------------------------------------------- //
306  PHYSXSCHEMA_API
307  UsdAttribute GetDampingAttr() const;
308 
314  PHYSXSCHEMA_API
315  UsdAttribute CreateDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
316 
317 public:
318  // --------------------------------------------------------------------- //
319  // CONTACTDISTANCE
320  // --------------------------------------------------------------------- //
333  PHYSXSCHEMA_API
334  UsdAttribute GetContactDistanceAttr() const;
335 
341  PHYSXSCHEMA_API
342  UsdAttribute CreateContactDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
343 
344 public:
345  // ===================================================================== //
346  // Feel free to add custom code below this line, it will be preserved by
347  // the code generator.
348  //
349  // Just remember to:
350  // - Close the class declaration with };
351  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
352  // - Close the include guard with #endif
353  // ===================================================================== //
354  // --(BEGIN CUSTOM CODE)--
355 };
356 
357 PXR_NAMESPACE_CLOSE_SCOPE
358 
359 #endif