All Classes Files Functions Variables Pages
materialAPI.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_GENERATED_MATERIALAPI_H
25 #define USDPHYSICS_GENERATED_MATERIALAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "usdPhysics/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 "usdPhysics/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 // PHYSICSMATERIALAPI //
51 // -------------------------------------------------------------------------- //
52 
59 class UsdPhysicsMaterialAPI : public UsdAPISchemaBase
60 {
61 public:
65  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
66 
71  explicit UsdPhysicsMaterialAPI(const UsdPrim& prim=UsdPrim())
72  : UsdAPISchemaBase(prim)
73  {
74  }
75 
79  explicit UsdPhysicsMaterialAPI(const UsdSchemaBase& schemaObj)
80  : UsdAPISchemaBase(schemaObj)
81  {
82  }
83 
85  USDPHYSICS_API
86  virtual ~UsdPhysicsMaterialAPI();
87 
91  USDPHYSICS_API
92  static const TfTokenVector &
93  GetSchemaAttributeNames(bool includeInherited=true);
94 
104  USDPHYSICS_API
105  static UsdPhysicsMaterialAPI
106  Get(const UsdStagePtr &stage, const SdfPath &path);
107 
108 
123  USDPHYSICS_API
124  static UsdPhysicsMaterialAPI
125  Apply(const UsdPrim &prim);
126 
127 protected:
131  USDPHYSICS_API
132  UsdSchemaType _GetSchemaType() const override;
133 
134 private:
135  // needs to invoke _GetStaticTfType.
136  friend class UsdSchemaRegistry;
137  USDPHYSICS_API
138  static const TfType &_GetStaticTfType();
139 
140  static bool _IsTypedSchema();
141 
142  // override SchemaBase virtuals.
143  USDPHYSICS_API
144  const TfType &_GetTfType() const override;
145 
146 public:
147  // --------------------------------------------------------------------- //
148  // DYNAMICFRICTION
149  // --------------------------------------------------------------------- //
157  USDPHYSICS_API
158  UsdAttribute GetDynamicFrictionAttr() const;
159 
165  USDPHYSICS_API
166  UsdAttribute CreateDynamicFrictionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
167 
168 public:
169  // --------------------------------------------------------------------- //
170  // STATICFRICTION
171  // --------------------------------------------------------------------- //
179  USDPHYSICS_API
180  UsdAttribute GetStaticFrictionAttr() const;
181 
187  USDPHYSICS_API
188  UsdAttribute CreateStaticFrictionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // RESTITUTION
193  // --------------------------------------------------------------------- //
201  USDPHYSICS_API
202  UsdAttribute GetRestitutionAttr() const;
203 
209  USDPHYSICS_API
210  UsdAttribute CreateRestitutionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
211 
212 public:
213  // --------------------------------------------------------------------- //
214  // DENSITY
215  // --------------------------------------------------------------------- //
226  USDPHYSICS_API
227  UsdAttribute GetDensityAttr() const;
228 
234  USDPHYSICS_API
235  UsdAttribute CreateDensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236 
237 public:
238  // ===================================================================== //
239  // Feel free to add custom code below this line, it will be preserved by
240  // the code generator.
241  //
242  // Just remember to:
243  // - Close the class declaration with };
244  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
245  // - Close the include guard with #endif
246  // ===================================================================== //
247  // --(BEGIN CUSTOM CODE)--
248 };
249 
250 PXR_NAMESPACE_CLOSE_SCOPE
251 
252 #endif
USDPHYSICS_API UsdAttribute GetDensityAttr() const
If non-zero, defines the density of the material.
USDPHYSICS_API UsdAttribute GetStaticFrictionAttr() const
Static friction coefficient.
Defines simulation material properties.
Definition: materialAPI.h:59
UsdPhysicsMaterialAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsMaterialAPI on UsdPrim prim .
Definition: materialAPI.h:71
USDPHYSICS_API UsdAttribute GetRestitutionAttr() const
Restitution coefficient.
USDPHYSICS_API UsdAttribute CreateStaticFrictionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetStaticFrictionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
USDPHYSICS_API UsdAttribute GetDynamicFrictionAttr() const
Dynamic friction coefficient.
static USDPHYSICS_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: materialAPI.h:65
USDPHYSICS_API UsdAttribute CreateRestitutionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestitutionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
USDPHYSICS_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
UsdPhysicsMaterialAPI(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsMaterialAPI on the prim held by schemaObj .
Definition: materialAPI.h:79
USDPHYSICS_API UsdAttribute CreateDensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDensityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
USDPHYSICS_API UsdAttribute CreateDynamicFrictionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDynamicFrictionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static USDPHYSICS_API UsdPhysicsMaterialAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
virtual USDPHYSICS_API ~UsdPhysicsMaterialAPI()
Destructor.
static USDPHYSICS_API UsdPhysicsMaterialAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsMaterialAPI holding the prim adhering to this schema at path on stage...