All Classes Files Functions Variables Pages
massAPI.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_MASSAPI_H
25 #define USDPHYSICS_GENERATED_MASSAPI_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 // PHYSICSMASSAPI //
51 // -------------------------------------------------------------------------- //
52 
59 class UsdPhysicsMassAPI : public UsdAPISchemaBase
60 {
61 public:
65  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
66 
71  explicit UsdPhysicsMassAPI(const UsdPrim& prim=UsdPrim())
72  : UsdAPISchemaBase(prim)
73  {
74  }
75 
79  explicit UsdPhysicsMassAPI(const UsdSchemaBase& schemaObj)
80  : UsdAPISchemaBase(schemaObj)
81  {
82  }
83 
85  USDPHYSICS_API
86  virtual ~UsdPhysicsMassAPI();
87 
91  USDPHYSICS_API
92  static const TfTokenVector &
93  GetSchemaAttributeNames(bool includeInherited=true);
94 
104  USDPHYSICS_API
105  static UsdPhysicsMassAPI
106  Get(const UsdStagePtr &stage, const SdfPath &path);
107 
108 
123  USDPHYSICS_API
124  static UsdPhysicsMassAPI
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  // MASS
149  // --------------------------------------------------------------------- //
165  USDPHYSICS_API
166  UsdAttribute GetMassAttr() const;
167 
173  USDPHYSICS_API
174  UsdAttribute CreateMassAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
175 
176 public:
177  // --------------------------------------------------------------------- //
178  // DENSITY
179  // --------------------------------------------------------------------- //
198  USDPHYSICS_API
199  UsdAttribute GetDensityAttr() const;
200 
206  USDPHYSICS_API
207  UsdAttribute CreateDensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
208 
209 public:
210  // --------------------------------------------------------------------- //
211  // CENTEROFMASS
212  // --------------------------------------------------------------------- //
220  USDPHYSICS_API
221  UsdAttribute GetCenterOfMassAttr() const;
222 
228  USDPHYSICS_API
229  UsdAttribute CreateCenterOfMassAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
230 
231 public:
232  // --------------------------------------------------------------------- //
233  // DIAGONALINERTIA
234  // --------------------------------------------------------------------- //
244  USDPHYSICS_API
245  UsdAttribute GetDiagonalInertiaAttr() const;
246 
252  USDPHYSICS_API
253  UsdAttribute CreateDiagonalInertiaAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
254 
255 public:
256  // --------------------------------------------------------------------- //
257  // PRINCIPALAXES
258  // --------------------------------------------------------------------- //
267  USDPHYSICS_API
268  UsdAttribute GetPrincipalAxesAttr() const;
269 
275  USDPHYSICS_API
276  UsdAttribute CreatePrincipalAxesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
277 
278 public:
279  // ===================================================================== //
280  // Feel free to add custom code below this line, it will be preserved by
281  // the code generator.
282  //
283  // Just remember to:
284  // - Close the class declaration with };
285  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
286  // - Close the include guard with #endif
287  // ===================================================================== //
288  // --(BEGIN CUSTOM CODE)--
289 };
290 
291 PXR_NAMESPACE_CLOSE_SCOPE
292 
293 #endif
USDPHYSICS_API UsdAttribute CreateCenterOfMassAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCenterOfMassAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
USDPHYSICS_API UsdAttribute GetDensityAttr() const
If non-zero, specifies the density of the object.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: massAPI.h:65
UsdPhysicsMassAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsMassAPI on UsdPrim prim .
Definition: massAPI.h:71
virtual USDPHYSICS_API ~UsdPhysicsMassAPI()
Destructor.
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...
USDPHYSICS_API UsdAttribute CreateDiagonalInertiaAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDiagonalInertiaAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static USDPHYSICS_API UsdPhysicsMassAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsMassAPI holding the prim adhering to this schema at path on stage.
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 GetDiagonalInertiaAttr() const
If non-zero, specifies diagonalized inertia tensor along the principal axes.
USDPHYSICS_API UsdAttribute GetMassAttr() const
If non-zero, directly specifies the mass of the object.
USDPHYSICS_API UsdAttribute GetCenterOfMassAttr() const
Center of mass in the prim's local space.
USDPHYSICS_API UsdAttribute CreateMassAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMassAttr(), 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.
static USDPHYSICS_API UsdPhysicsMassAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
USDPHYSICS_API UsdAttribute CreatePrincipalAxesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPrincipalAxesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
USDPHYSICS_API UsdAttribute GetPrincipalAxesAttr() const
Orientation of the inertia tensor's principal axes in the prim's local space.
UsdPhysicsMassAPI(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsMassAPI on the prim held by schemaObj .
Definition: massAPI.h:79
Defines explicit mass properties (mass, density, inertia etc.).
Definition: massAPI.h:59