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 UsdSchemaType schemaType = UsdSchemaType::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 
96  PHYSXSCHEMA_API
97  static const TfTokenVector &
98  GetSchemaAttributeNames(
99  bool includeInherited=true, const TfToken instanceName=TfToken());
100 
102  TfToken GetName() const {
103  return _GetInstanceName();
104  }
105 
120  PHYSXSCHEMA_API
121  static PhysxSchemaPhysxLimitAPI
122  Get(const UsdStagePtr &stage, const SdfPath &path);
123 
126  PHYSXSCHEMA_API
127  static PhysxSchemaPhysxLimitAPI
128  Get(const UsdPrim &prim, const TfToken &name);
129 
132  PHYSXSCHEMA_API
133  static bool
134  IsSchemaPropertyBaseName(const TfToken &baseName);
135 
139  PHYSXSCHEMA_API
140  static bool
141  IsPhysxLimitAPIPath(const SdfPath &path, TfToken *name);
142 
161  PHYSXSCHEMA_API
162  static PhysxSchemaPhysxLimitAPI
163  Apply(const UsdPrim &prim, const TfToken &name);
164 
165 protected:
169  PHYSXSCHEMA_API
170  UsdSchemaType _GetSchemaType() const override;
171 
172 private:
173  // needs to invoke _GetStaticTfType.
174  friend class UsdSchemaRegistry;
175  PHYSXSCHEMA_API
176  static const TfType &_GetStaticTfType();
177 
178  static bool _IsTypedSchema();
179 
180  // override SchemaBase virtuals.
181  PHYSXSCHEMA_API
182  const TfType &_GetTfType() const override;
183 
184 public:
185  // --------------------------------------------------------------------- //
186  // RESTITUTION
187  // --------------------------------------------------------------------- //
197  PHYSXSCHEMA_API
198  UsdAttribute GetRestitutionAttr() const;
199 
205  PHYSXSCHEMA_API
206  UsdAttribute CreateRestitutionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
207 
208 public:
209  // --------------------------------------------------------------------- //
210  // BOUNCETHRESHOLD
211  // --------------------------------------------------------------------- //
222  PHYSXSCHEMA_API
223  UsdAttribute GetBounceThresholdAttr() const;
224 
230  PHYSXSCHEMA_API
231  UsdAttribute CreateBounceThresholdAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
232 
233 public:
234  // --------------------------------------------------------------------- //
235  // STIFFNESS
236  // --------------------------------------------------------------------- //
247  PHYSXSCHEMA_API
248  UsdAttribute GetStiffnessAttr() const;
249 
255  PHYSXSCHEMA_API
256  UsdAttribute CreateStiffnessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
257 
258 public:
259  // --------------------------------------------------------------------- //
260  // DAMPING
261  // --------------------------------------------------------------------- //
272  PHYSXSCHEMA_API
273  UsdAttribute GetDampingAttr() const;
274 
280  PHYSXSCHEMA_API
281  UsdAttribute CreateDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
282 
283 public:
284  // --------------------------------------------------------------------- //
285  // CONTACTDISTANCE
286  // --------------------------------------------------------------------- //
299  PHYSXSCHEMA_API
300  UsdAttribute GetContactDistanceAttr() const;
301 
307  PHYSXSCHEMA_API
308  UsdAttribute CreateContactDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
309 
310 public:
311  // ===================================================================== //
312  // Feel free to add custom code below this line, it will be preserved by
313  // the code generator.
314  //
315  // Just remember to:
316  // - Close the class declaration with };
317  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
318  // - Close the include guard with #endif
319  // ===================================================================== //
320  // --(BEGIN CUSTOM CODE)--
321 };
322 
323 PXR_NAMESPACE_CLOSE_SCOPE
324 
325 #endif