filteredPairsAPI.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_FILTEREDPAIRSAPI_H
25 #define USDPHYSICS_GENERATED_FILTEREDPAIRSAPI_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 // PHYSICSFILTEREDPAIRSAPI //
51 // -------------------------------------------------------------------------- //
52 
63 {
64 public:
69 
74  explicit UsdPhysicsFilteredPairsAPI(const UsdPrim& prim=UsdPrim())
75  : UsdAPISchemaBase(prim)
76  {
77  }
78 
82  explicit UsdPhysicsFilteredPairsAPI(const UsdSchemaBase& schemaObj)
83  : UsdAPISchemaBase(schemaObj)
84  {
85  }
86 
88  USDPHYSICS_API
90 
94  USDPHYSICS_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  USDPHYSICS_API
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
111 
128  USDPHYSICS_API
129  static bool
130  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
131 
147  USDPHYSICS_API
149  Apply(const UsdPrim &prim);
150 
151 protected:
155  USDPHYSICS_API
156  UsdSchemaKind _GetSchemaKind() const override;
157 
158 private:
159  // needs to invoke _GetStaticTfType.
160  friend class UsdSchemaRegistry;
161  USDPHYSICS_API
162  static const TfType &_GetStaticTfType();
163 
164  static bool _IsTypedSchema();
165 
166  // override SchemaBase virtuals.
167  USDPHYSICS_API
168  const TfType &_GetTfType() const override;
169 
170 public:
171  // --------------------------------------------------------------------- //
172  // FILTEREDPAIRS
173  // --------------------------------------------------------------------- //
176  USDPHYSICS_API
178 
181  USDPHYSICS_API
183 
184 public:
185  // ===================================================================== //
186  // Feel free to add custom code below this line, it will be preserved by
187  // the code generator.
188  //
189  // Just remember to:
190  // - Close the class declaration with };
191  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
192  // - Close the include guard with #endif
193  // ===================================================================== //
194  // --(BEGIN CUSTOM CODE)--
195 };
196 
197 PXR_NAMESPACE_CLOSE_SCOPE
198 
199 #endif
USDPHYSICS_API UsdRelationship CreateFilteredPairsRel() const
See GetFilteredPairsRel(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdPhysicsFilteredPairsAPI(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsFilteredPairsAPI on the prim held by schemaObj .
UsdPhysicsFilteredPairsAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsFilteredPairsAPI on UsdPrim prim .
static USDPHYSICS_API UsdPhysicsFilteredPairsAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsFilteredPairsAPI holding the prim adhering to this schema at path on stage.
The base class for all API schemas.
USDPHYSICS_API UsdRelationship GetFilteredPairsRel() const
Relationship to objects that should be filtered.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
Single Apply API schema.
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
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
static USDPHYSICS_API UsdPhysicsFilteredPairsAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
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...
virtual USDPHYSICS_API ~UsdPhysicsFilteredPairsAPI()
Destructor.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
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...
API to describe fine-grained filtering.
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
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.