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 USDGEOM_GENERATED_SCOPE_H 25 #define USDGEOM_GENERATED_SCOPE_H 26 27 /// \file usdGeom/scope.h 28 29 #include "pxr/pxr.h" 30 #include "pxr/usd/usdGeom/api.h" 31 #include "pxr/usd/usdGeom/imageable.h" 32 #include "pxr/usd/usd/prim.h" 33 #include "pxr/usd/usd/stage.h" 34 35 #include "pxr/base/vt/value.h" 36 37 #include "pxr/base/gf/vec3d.h" 38 #include "pxr/base/gf/vec3f.h" 39 #include "pxr/base/gf/matrix4d.h" 40 41 #include "pxr/base/tf/token.h" 42 #include "pxr/base/tf/type.h" 43 44 PXR_NAMESPACE_OPEN_SCOPE 45 46 class SdfAssetPath; 47 48 // -------------------------------------------------------------------------- // 49 // SCOPE // 50 // -------------------------------------------------------------------------- // 51 52 /// \class UsdGeomScope 53 /// 54 /// Scope is the simplest grouping primitive, and does not carry the 55 /// baggage of transformability. Note that transforms should inherit down 56 /// through a Scope successfully - it is just a guaranteed no-op from a 57 /// transformability perspective. 58 /// 59 class UsdGeomScope : public UsdGeomImageable 60 { 61 public: 62 /// Compile time constant representing what kind of schema this class is. 63 /// 64 /// \sa UsdSchemaKind 65 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped; 66 67 /// Construct a UsdGeomScope on UsdPrim \p prim . 68 /// Equivalent to UsdGeomScope::Get(prim.GetStage(), prim.GetPath()) 69 /// for a \em valid \p prim, but will not immediately throw an error for 70 /// an invalid \p prim 71 explicit UsdGeomScope(const UsdPrim& prim=UsdPrim()) UsdGeomImageable(prim)72 : UsdGeomImageable(prim) 73 { 74 } 75 76 /// Construct a UsdGeomScope on the prim held by \p schemaObj . 77 /// Should be preferred over UsdGeomScope(schemaObj.GetPrim()), 78 /// as it preserves SchemaBase state. UsdGeomScope(const UsdSchemaBase & schemaObj)79 explicit UsdGeomScope(const UsdSchemaBase& schemaObj) 80 : UsdGeomImageable(schemaObj) 81 { 82 } 83 84 /// Destructor. 85 USDGEOM_API 86 virtual ~UsdGeomScope(); 87 88 /// Return a vector of names of all pre-declared attributes for this schema 89 /// class and all its ancestor classes. Does not include attributes that 90 /// may be authored by custom/extended methods of the schemas involved. 91 USDGEOM_API 92 static const TfTokenVector & 93 GetSchemaAttributeNames(bool includeInherited=true); 94 95 /// Return a UsdGeomScope holding the prim adhering to this 96 /// schema at \p path on \p stage. If no prim exists at \p path on 97 /// \p stage, or if the prim at that path does not adhere to this schema, 98 /// return an invalid schema object. This is shorthand for the following: 99 /// 100 /// \code 101 /// UsdGeomScope(stage->GetPrimAtPath(path)); 102 /// \endcode 103 /// 104 USDGEOM_API 105 static UsdGeomScope 106 Get(const UsdStagePtr &stage, const SdfPath &path); 107 108 /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path 109 /// is defined (according to UsdPrim::IsDefined()) on this stage. 110 /// 111 /// If a prim adhering to this schema at \p path is already defined on this 112 /// stage, return that prim. Otherwise author an \a SdfPrimSpec with 113 /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for 114 /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s 115 /// with \p specifier == \a SdfSpecifierDef and empty typeName at the 116 /// current EditTarget for any nonexistent, or existing but not \a Defined 117 /// ancestors. 118 /// 119 /// The given \a path must be an absolute prim path that does not contain 120 /// any variant selections. 121 /// 122 /// If it is impossible to author any of the necessary PrimSpecs, (for 123 /// example, in case \a path cannot map to the current UsdEditTarget's 124 /// namespace) issue an error and return an invalid \a UsdPrim. 125 /// 126 /// Note that this method may return a defined prim whose typeName does not 127 /// specify this schema class, in case a stronger typeName opinion overrides 128 /// the opinion at the current EditTarget. 129 /// 130 USDGEOM_API 131 static UsdGeomScope 132 Define(const UsdStagePtr &stage, const SdfPath &path); 133 134 protected: 135 /// Returns the kind of schema this class belongs to. 136 /// 137 /// \sa UsdSchemaKind 138 USDGEOM_API 139 UsdSchemaKind _GetSchemaKind() const override; 140 141 private: 142 // needs to invoke _GetStaticTfType. 143 friend class UsdSchemaRegistry; 144 USDGEOM_API 145 static const TfType &_GetStaticTfType(); 146 147 static bool _IsTypedSchema(); 148 149 // override SchemaBase virtuals. 150 USDGEOM_API 151 const TfType &_GetTfType() const override; 152 153 public: 154 // ===================================================================== // 155 // Feel free to add custom code below this line, it will be preserved by 156 // the code generator. 157 // 158 // Just remember to: 159 // - Close the class declaration with }; 160 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE 161 // - Close the include guard with #endif 162 // ===================================================================== // 163 // --(BEGIN CUSTOM CODE)-- 164 }; 165 166 PXR_NAMESPACE_CLOSE_SCOPE 167 168 #endif 169