HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
houdiniLayerInfo.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 USDHOUDINI_GENERATED_HOUDINILAYERINFO_H
25 #define USDHOUDINI_GENERATED_HOUDINILAYERINFO_H
26 
27 /// \file usdHoudini/houdiniLayerInfo.h
28 
29 #include "pxr/pxr.h"
30 #include "./api.h"
31 #include "pxr/usd/usd/typed.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 
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // HOUDINILAYERINFO //
50 // -------------------------------------------------------------------------- //
51 
52 /// \class UsdHoudiniHoudiniLayerInfo
53 ///
54 /// Holder for Houdini-specific layer information.
55 ///
56 class
59 {
60 public:
61  /// Compile time constant representing what kind of schema this class is.
62  ///
63  /// \sa UsdSchemaKind
64  static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
65 
66  /// Construct a UsdHoudiniHoudiniLayerInfo on UsdPrim \p prim .
67  /// Equivalent to UsdHoudiniHoudiniLayerInfo::Get(prim.GetStage(), prim.GetPath())
68  /// for a \em valid \p prim, but will not immediately throw an error for
69  /// an invalid \p prim
70  explicit UsdHoudiniHoudiniLayerInfo(const UsdPrim& prim=UsdPrim())
71  : UsdTyped(prim)
72  {
73  }
74 
75  /// Construct a UsdHoudiniHoudiniLayerInfo on the prim held by \p schemaObj .
76  /// Should be preferred over UsdHoudiniHoudiniLayerInfo(schemaObj.GetPrim()),
77  /// as it preserves SchemaBase state.
78  explicit UsdHoudiniHoudiniLayerInfo(const UsdSchemaBase& schemaObj)
79  : UsdTyped(schemaObj)
80  {
81  }
82 
83  /// Destructor.
84  virtual ~UsdHoudiniHoudiniLayerInfo() override;
85 
86  /// Return a vector of names of all pre-declared attributes for this schema
87  /// class and all its ancestor classes. Does not include attributes that
88  /// may be authored by custom/extended methods of the schemas involved.
89  static const TfTokenVector &
90  GetSchemaAttributeNames(bool includeInherited=true);
91 
92  /// Return a UsdHoudiniHoudiniLayerInfo holding the prim adhering to this
93  /// schema at \p path on \p stage. If no prim exists at \p path on
94  /// \p stage, or if the prim at that path does not adhere to this schema,
95  /// return an invalid schema object. This is shorthand for the following:
96  ///
97  /// \code
98  /// UsdHoudiniHoudiniLayerInfo(stage->GetPrimAtPath(path));
99  /// \endcode
100  ///
102  Get(const UsdStagePtr &stage, const SdfPath &path);
103 
104  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
105  /// is defined (according to UsdPrim::IsDefined()) on this stage.
106  ///
107  /// If a prim adhering to this schema at \p path is already defined on this
108  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
109  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
110  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
111  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
112  /// current EditTarget for any nonexistent, or existing but not \a Defined
113  /// ancestors.
114  ///
115  /// The given \a path must be an absolute prim path that does not contain
116  /// any variant selections.
117  ///
118  /// If it is impossible to author any of the necessary PrimSpecs, (for
119  /// example, in case \a path cannot map to the current UsdEditTarget's
120  /// namespace) issue an error and return an invalid \a UsdPrim.
121  ///
122  /// Note that this method may return a defined prim whose typeName does not
123  /// specify this schema class, in case a stronger typeName opinion overrides
124  /// the opinion at the current EditTarget.
125  ///
127  Define(const UsdStagePtr &stage, const SdfPath &path);
128 
129 protected:
130  /// Returns the kind of schema this class belongs to.
131  ///
132  /// \sa UsdSchemaKind
133  UsdSchemaKind _GetSchemaKind() const override;
134 
135 private:
136  // needs to invoke _GetStaticTfType.
137  friend class UsdSchemaRegistry;
138  static const TfType &_GetStaticTfType();
139 
140  static bool _IsTypedSchema();
141 
142  // override SchemaBase virtuals.
143  const TfType &_GetTfType() const override;
144 
145 public:
146  // ===================================================================== //
147  // Feel free to add custom code below this line, it will be preserved by
148  // the code generator.
149  //
150  // Just remember to:
151  // - Close the class declaration with };
152  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
153  // - Close the include guard with #endif
154  // ===================================================================== //
155  // --(BEGIN CUSTOM CODE)--
156 };
157 
159 
160 #endif
#define USDHOUDINI_API
Definition: api.h:47
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
UsdHoudiniHoudiniLayerInfo(const UsdPrim &prim=UsdPrim())
Represents a concrete typed schema.
Definition: prim.h:135
Definition: typed.h:61
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Definition: path.h:291
UsdSchemaKind
Definition: common.h:127
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
UsdHoudiniHoudiniLayerInfo(const UsdSchemaBase &schemaObj)