Loading...
Searching...
No Matches
filteredPairsAPI.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef USDPHYSICS_GENERATED_FILTEREDPAIRSAPI_H
8#define USDPHYSICS_GENERATED_FILTEREDPAIRSAPI_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdPhysics/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// PHYSICSFILTEREDPAIRSAPI //
34// -------------------------------------------------------------------------- //
35
46{
47public:
52
58 : UsdAPISchemaBase(prim)
59 {
60 }
61
65 explicit UsdPhysicsFilteredPairsAPI(const UsdSchemaBase& schemaObj)
66 : UsdAPISchemaBase(schemaObj)
67 {
68 }
69
71 USDPHYSICS_API
73
77 USDPHYSICS_API
78 static const TfTokenVector &
79 GetSchemaAttributeNames(bool includeInherited=true);
80
90 USDPHYSICS_API
92 Get(const UsdStagePtr &stage, const SdfPath &path);
93
94
111 USDPHYSICS_API
112 static bool
113 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
114
130 USDPHYSICS_API
132 Apply(const UsdPrim &prim);
133
134protected:
138 USDPHYSICS_API
140
141private:
142 // needs to invoke _GetStaticTfType.
143 friend class UsdSchemaRegistry;
144 USDPHYSICS_API
145 static const TfType &_GetStaticTfType();
146
147 static bool _IsTypedSchema();
148
149 // override SchemaBase virtuals.
150 USDPHYSICS_API
151 const TfType &_GetTfType() const override;
152
153public:
154 // --------------------------------------------------------------------- //
155 // FILTEREDPAIRS
156 // --------------------------------------------------------------------- //
159 USDPHYSICS_API
161
164 USDPHYSICS_API
166
167public:
168 // ===================================================================== //
169 // Feel free to add custom code below this line, it will be preserved by
170 // the code generator.
171 //
172 // Just remember to:
173 // - Close the class declaration with };
174 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
175 // - Close the include guard with #endif
176 // ===================================================================== //
177 // --(BEGIN CUSTOM CODE)--
178};
179
180PXR_NAMESPACE_CLOSE_SCOPE
181
182#endif
Contains an asset path and optional evaluated and resolved paths.
Definition assetPath.h:79
A path value used to locate objects in layers or scenegraphs.
Definition path.h:281
TfType represents a dynamic runtime type.
Definition type.h:48
The base class for all API schemas.
API to describe fine-grained filtering.
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.
USDPHYSICS_API UsdRelationship CreateFilteredPairsRel() const
See GetFilteredPairsRel(), and also Create vs Get Property Methods for when to use Get vs Create.
USDPHYSICS_API UsdRelationship GetFilteredPairsRel() const
Relationship to objects that should be filtered.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
static USDPHYSICS_API UsdPhysicsFilteredPairsAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given 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.
UsdPhysicsFilteredPairsAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsFilteredPairsAPI on UsdPrim prim .
virtual USDPHYSICS_API ~UsdPhysicsFilteredPairsAPI()
Destructor.
UsdPhysicsFilteredPairsAPI(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsFilteredPairsAPI 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...
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition prim.h:117
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
The base class for all schema types in Usd.
Definition schemaBase.h:39
Singleton registry that provides access to schema type information and the prim definitions for regis...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition common.h:112
@ SingleApplyAPI
Single Apply API schema.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition token.h:489