All Classes Files Functions Variables Pages
meshCollisionAPI.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_MESHCOLLISIONAPI_H
25 #define USDPHYSICS_GENERATED_MESHCOLLISIONAPI_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 // PHYSICSMESHCOLLISIONAPI //
51 // -------------------------------------------------------------------------- //
52 
63 class UsdPhysicsMeshCollisionAPI : public UsdAPISchemaBase
64 {
65 public:
69  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
70 
75  explicit UsdPhysicsMeshCollisionAPI(const UsdPrim& prim=UsdPrim())
76  : UsdAPISchemaBase(prim)
77  {
78  }
79 
83  explicit UsdPhysicsMeshCollisionAPI(const UsdSchemaBase& schemaObj)
84  : UsdAPISchemaBase(schemaObj)
85  {
86  }
87 
89  USDPHYSICS_API
91 
95  USDPHYSICS_API
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
108  USDPHYSICS_API
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
112 
127  USDPHYSICS_API
129  Apply(const UsdPrim &prim);
130 
131 protected:
135  USDPHYSICS_API
136  UsdSchemaType _GetSchemaType() const override;
137 
138 private:
139  // needs to invoke _GetStaticTfType.
140  friend class UsdSchemaRegistry;
141  USDPHYSICS_API
142  static const TfType &_GetStaticTfType();
143 
144  static bool _IsTypedSchema();
145 
146  // override SchemaBase virtuals.
147  USDPHYSICS_API
148  const TfType &_GetTfType() const override;
149 
150 public:
151  // --------------------------------------------------------------------- //
152  // APPROXIMATION
153  // --------------------------------------------------------------------- //
175  USDPHYSICS_API
176  UsdAttribute GetApproximationAttr() const;
177 
183  USDPHYSICS_API
184  UsdAttribute CreateApproximationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
185 
186 public:
187  // ===================================================================== //
188  // Feel free to add custom code below this line, it will be preserved by
189  // the code generator.
190  //
191  // Just remember to:
192  // - Close the class declaration with };
193  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
194  // - Close the include guard with #endif
195  // ===================================================================== //
196  // --(BEGIN CUSTOM CODE)--
197 };
198 
199 PXR_NAMESPACE_CLOSE_SCOPE
200 
201 #endif
static USDPHYSICS_API UsdPhysicsMeshCollisionAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
Attributes to control how a Mesh is made into a collider.
USDPHYSICS_API UsdAttribute CreateApproximationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetApproximationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
USDPHYSICS_API UsdAttribute GetApproximationAttr() const
Determines the mesh's collision approximation: "none" - The mesh geometry is used directly as a colli...
virtual USDPHYSICS_API ~UsdPhysicsMeshCollisionAPI()
Destructor.
USDPHYSICS_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
UsdPhysicsMeshCollisionAPI(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsMeshCollisionAPI on the prim held by schemaObj .
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...
UsdPhysicsMeshCollisionAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsMeshCollisionAPI on UsdPrim prim .
static USDPHYSICS_API UsdPhysicsMeshCollisionAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsMeshCollisionAPI holding the prim adhering to this schema at path on stage...