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 "pxr/usd/usdPhysics/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.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 
60 {
61 public:
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 
125  USDPHYSICS_API
126  static bool
127  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
128 
144  USDPHYSICS_API
145  static UsdPhysicsMaterialAPI
146  Apply(const UsdPrim &prim);
147 
148 protected:
152  USDPHYSICS_API
153  UsdSchemaKind _GetSchemaKind() const override;
154 
155 private:
156  // needs to invoke _GetStaticTfType.
157  friend class UsdSchemaRegistry;
158  USDPHYSICS_API
159  static const TfType &_GetStaticTfType();
160 
161  static bool _IsTypedSchema();
162 
163  // override SchemaBase virtuals.
164  USDPHYSICS_API
165  const TfType &_GetTfType() const override;
166 
167 public:
168  // --------------------------------------------------------------------- //
169  // DYNAMICFRICTION
170  // --------------------------------------------------------------------- //
178  USDPHYSICS_API
180 
186  USDPHYSICS_API
187  UsdAttribute CreateDynamicFrictionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
188 
189 public:
190  // --------------------------------------------------------------------- //
191  // STATICFRICTION
192  // --------------------------------------------------------------------- //
200  USDPHYSICS_API
202 
208  USDPHYSICS_API
209  UsdAttribute CreateStaticFrictionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
210 
211 public:
212  // --------------------------------------------------------------------- //
213  // RESTITUTION
214  // --------------------------------------------------------------------- //
222  USDPHYSICS_API
224 
230  USDPHYSICS_API
231  UsdAttribute CreateRestitutionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
232 
233 public:
234  // --------------------------------------------------------------------- //
235  // DENSITY
236  // --------------------------------------------------------------------- //
247  USDPHYSICS_API
249 
255  USDPHYSICS_API
256  UsdAttribute CreateDensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
257 
258 public:
259  // ===================================================================== //
260  // Feel free to add custom code below this line, it will be preserved by
261  // the code generator.
262  //
263  // Just remember to:
264  // - Close the class declaration with };
265  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
266  // - Close the include guard with #endif
267  // ===================================================================== //
268  // --(BEGIN CUSTOM CODE)--
269 };
270 
271 PXR_NAMESPACE_CLOSE_SCOPE
272 
273 #endif
USDPHYSICS_API UsdAttribute GetDynamicFrictionAttr() const
Dynamic friction coefficient.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: materialAPI.h:65
USDPHYSICS_API UsdAttribute GetDensityAttr() const
If non-zero, defines the density of the material.
Adds simulation material properties to a Material.
Definition: materialAPI.h:59
UsdPhysicsMaterialAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsMaterialAPI on UsdPrim prim .
Definition: materialAPI.h:71
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
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...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDPHYSICS_API UsdAttribute CreateStaticFrictionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetStaticFrictionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDPHYSICS_API UsdAttribute GetRestitutionAttr() const
Restitution coefficient.
Single Apply API schema.
UsdPhysicsMaterialAPI(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsMaterialAPI on the prim held by schemaObj .
Definition: materialAPI.h:79
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
USDPHYSICS_API UsdAttribute CreateDynamicFrictionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDynamicFrictionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
USDPHYSICS_API UsdAttribute CreateDensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDensityAttr(), and also Create vs Get Property Methods 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.
USDPHYSICS_API UsdAttribute GetStaticFrictionAttr() const
Static friction coefficient.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
virtual USDPHYSICS_API ~UsdPhysicsMaterialAPI()
Destructor.
USDPHYSICS_API UsdAttribute CreateRestitutionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestitutionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
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.
static USDPHYSICS_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...