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 27 /// \file usdPhysics/filteredPairsAPI.h 28 29 #include "pxr/pxr.h" 30 #include "pxr/usd/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 "pxr/usd/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 // PHYSICSFILTEREDPAIRSAPI // 51 // -------------------------------------------------------------------------- // 52 53 /// \class UsdPhysicsFilteredPairsAPI 54 /// 55 /// API to describe fine-grained filtering. If a collision between 56 /// two objects occurs, this pair might be filtered if the pair is defined 57 /// through this API. This API can be applied either to a body or collision 58 /// or even articulation. The "filteredPairs" defines what objects it should 59 /// not collide against. Note that FilteredPairsAPI filtering has precedence 60 /// over CollisionGroup filtering. 61 /// 62 class UsdPhysicsFilteredPairsAPI : public UsdAPISchemaBase 63 { 64 public: 65 /// Compile time constant representing what kind of schema this class is. 66 /// 67 /// \sa UsdSchemaKind 68 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI; 69 70 /// Construct a UsdPhysicsFilteredPairsAPI on UsdPrim \p prim . 71 /// Equivalent to UsdPhysicsFilteredPairsAPI::Get(prim.GetStage(), prim.GetPath()) 72 /// for a \em valid \p prim, but will not immediately throw an error for 73 /// an invalid \p prim 74 explicit UsdPhysicsFilteredPairsAPI(const UsdPrim& prim=UsdPrim()) UsdAPISchemaBase(prim)75 : UsdAPISchemaBase(prim) 76 { 77 } 78 79 /// Construct a UsdPhysicsFilteredPairsAPI on the prim held by \p schemaObj . 80 /// Should be preferred over UsdPhysicsFilteredPairsAPI(schemaObj.GetPrim()), 81 /// as it preserves SchemaBase state. UsdPhysicsFilteredPairsAPI(const UsdSchemaBase & schemaObj)82 explicit UsdPhysicsFilteredPairsAPI(const UsdSchemaBase& schemaObj) 83 : UsdAPISchemaBase(schemaObj) 84 { 85 } 86 87 /// Destructor. 88 USDPHYSICS_API 89 virtual ~UsdPhysicsFilteredPairsAPI(); 90 91 /// Return a vector of names of all pre-declared attributes for this schema 92 /// class and all its ancestor classes. Does not include attributes that 93 /// may be authored by custom/extended methods of the schemas involved. 94 USDPHYSICS_API 95 static const TfTokenVector & 96 GetSchemaAttributeNames(bool includeInherited=true); 97 98 /// Return a UsdPhysicsFilteredPairsAPI holding the prim adhering to this 99 /// schema at \p path on \p stage. If no prim exists at \p path on 100 /// \p stage, or if the prim at that path does not adhere to this schema, 101 /// return an invalid schema object. This is shorthand for the following: 102 /// 103 /// \code 104 /// UsdPhysicsFilteredPairsAPI(stage->GetPrimAtPath(path)); 105 /// \endcode 106 /// 107 USDPHYSICS_API 108 static UsdPhysicsFilteredPairsAPI 109 Get(const UsdStagePtr &stage, const SdfPath &path); 110 111 112 /// Returns true if this <b>single-apply</b> API schema can be applied to 113 /// the given \p prim. If this schema can not be a applied to the prim, 114 /// this returns false and, if provided, populates \p whyNot with the 115 /// reason it can not be applied. 116 /// 117 /// Note that if CanApply returns false, that does not necessarily imply 118 /// that calling Apply will fail. Callers are expected to call CanApply 119 /// before calling Apply if they want to ensure that it is valid to 120 /// apply a schema. 121 /// 122 /// \sa UsdPrim::GetAppliedSchemas() 123 /// \sa UsdPrim::HasAPI() 124 /// \sa UsdPrim::CanApplyAPI() 125 /// \sa UsdPrim::ApplyAPI() 126 /// \sa UsdPrim::RemoveAPI() 127 /// 128 USDPHYSICS_API 129 static bool 130 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr); 131 132 /// Applies this <b>single-apply</b> API schema to the given \p prim. 133 /// This information is stored by adding "PhysicsFilteredPairsAPI" to the 134 /// token-valued, listOp metadata \em apiSchemas on the prim. 135 /// 136 /// \return A valid UsdPhysicsFilteredPairsAPI object is returned upon success. 137 /// An invalid (or empty) UsdPhysicsFilteredPairsAPI object is returned upon 138 /// failure. See \ref UsdPrim::ApplyAPI() for conditions 139 /// resulting in failure. 140 /// 141 /// \sa UsdPrim::GetAppliedSchemas() 142 /// \sa UsdPrim::HasAPI() 143 /// \sa UsdPrim::CanApplyAPI() 144 /// \sa UsdPrim::ApplyAPI() 145 /// \sa UsdPrim::RemoveAPI() 146 /// 147 USDPHYSICS_API 148 static UsdPhysicsFilteredPairsAPI 149 Apply(const UsdPrim &prim); 150 151 protected: 152 /// Returns the kind of schema this class belongs to. 153 /// 154 /// \sa UsdSchemaKind 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 // --------------------------------------------------------------------- // 174 /// Relationship to objects that should be filtered. 175 /// 176 USDPHYSICS_API 177 UsdRelationship GetFilteredPairsRel() const; 178 179 /// See GetFilteredPairsRel(), and also 180 /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create 181 USDPHYSICS_API 182 UsdRelationship CreateFilteredPairsRel() const; 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 200