All Classes Files Functions Variables Pages
physxMeshMergeCollisionAPI.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_PHYSXMESHMERGECOLLISIONAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXMESHMERGECOLLISIONAPI_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 "pxr/usd/usd/collectionAPI.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 // PHYSXMESHMERGECOLLISIONAPI //
51 // -------------------------------------------------------------------------- //
52 
69 class PhysxSchemaPhysxMeshMergeCollisionAPI : public UsdAPISchemaBase
70 {
71 public:
75  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
76 
81  explicit PhysxSchemaPhysxMeshMergeCollisionAPI(const UsdPrim& prim=UsdPrim())
82  : UsdAPISchemaBase(prim)
83  {
84  }
85 
89  explicit PhysxSchemaPhysxMeshMergeCollisionAPI(const UsdSchemaBase& schemaObj)
90  : UsdAPISchemaBase(schemaObj)
91  {
92  }
93 
95  PHYSXSCHEMA_API
97 
101  PHYSXSCHEMA_API
102  static const TfTokenVector &
103  GetSchemaAttributeNames(bool includeInherited=true);
104 
114  PHYSXSCHEMA_API
116  Get(const UsdStagePtr &stage, const SdfPath &path);
117 
118 
135  PHYSXSCHEMA_API
136  static bool
137  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
138 
154  PHYSXSCHEMA_API
156  Apply(const UsdPrim &prim);
157 
158 protected:
162  PHYSXSCHEMA_API
163  UsdSchemaKind _GetSchemaKind() const override;
164 
165 private:
166  // needs to invoke _GetStaticTfType.
167  friend class UsdSchemaRegistry;
168  PHYSXSCHEMA_API
169  static const TfType &_GetStaticTfType();
170 
171  static bool _IsTypedSchema();
172 
173  // override SchemaBase virtuals.
174  PHYSXSCHEMA_API
175  const TfType &_GetTfType() const override;
176 
177 public:
178  // ===================================================================== //
179  // Feel free to add custom code below this line, it will be preserved by
180  // the code generator.
181  //
182  // Just remember to:
183  // - Close the class declaration with };
184  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
185  // - Close the include guard with #endif
186  // ===================================================================== //
187  // --(BEGIN CUSTOM CODE)--
188 
191  PHYSXSCHEMA_API
192  UsdCollectionAPI GetCollisionMeshesCollectionAPI() const;
193 
194 };
195 
196 PXR_NAMESPACE_CLOSE_SCOPE
197 
198 #endif
static PHYSXSCHEMA_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 PHYSXSCHEMA_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.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxMeshMergeCollisionAPI()
Destructor.
PhysxSchemaPhysxMeshMergeCollisionAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxMeshMergeCollisionAPI on UsdPrim prim .
static PHYSXSCHEMA_API PhysxSchemaPhysxMeshMergeCollisionAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
PHYSXSCHEMA_API UsdCollectionAPI GetCollisionMeshesCollectionAPI() const
Return the UsdCollectionAPI interface used for defining what prims belong to the mesh merge API...
PhysxMeshMergeCollisionAPI enables implicit mesh merging of given meshes with respect to physics coll...
PhysxSchemaPhysxMeshMergeCollisionAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxMeshMergeCollisionAPI on the prim held by schemaObj . ...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
static PHYSXSCHEMA_API PhysxSchemaPhysxMeshMergeCollisionAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxMeshMergeCollisionAPI holding the prim adhering to this schema at path on st...