HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
houdiniFieldAsset.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_HOUDINIFIELDASSET_H
25 #define USDHOUDINI_GENERATED_HOUDINIFIELDASSET_H
26 
27 /// \file usdHoudini/houdiniFieldAsset.h
28 
29 #include "pxr/pxr.h"
30 #include "./api.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 // HOUDINIFIELDASSET //
50 // -------------------------------------------------------------------------- //
51 
52 /// \class UsdHoudiniHoudiniFieldAsset
53 ///
54 /// Houdini field asset primitive.
55 ///
56 class
57 USDHOUDINI_API
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  /// \deprecated
67  /// Same as schemaKind, provided to maintain temporary backward
68  /// compatibility with older generated schemas.
69  static const UsdSchemaKind schemaType = UsdSchemaKind::ConcreteTyped;
70 
71  /// Construct a UsdHoudiniHoudiniFieldAsset on UsdPrim \p prim .
72  /// Equivalent to UsdHoudiniHoudiniFieldAsset::Get(prim.GetStage(), prim.GetPath())
73  /// for a \em valid \p prim, but will not immediately throw an error for
74  /// an invalid \p prim
76  : UsdVolFieldAsset(prim)
77  {
78  }
79 
80  /// Construct a UsdHoudiniHoudiniFieldAsset on the prim held by \p schemaObj .
81  /// Should be preferred over UsdHoudiniHoudiniFieldAsset(schemaObj.GetPrim()),
82  /// as it preserves SchemaBase state.
83  explicit UsdHoudiniHoudiniFieldAsset(const UsdSchemaBase& schemaObj)
84  : UsdVolFieldAsset(schemaObj)
85  {
86  }
87 
88  /// Destructor.
89  virtual ~UsdHoudiniHoudiniFieldAsset() override;
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  static const TfTokenVector &
95  GetSchemaAttributeNames(bool includeInherited=true);
96 
97  /// Return a UsdHoudiniHoudiniFieldAsset holding the prim adhering to this
98  /// schema at \p path on \p stage. If no prim exists at \p path on
99  /// \p stage, or if the prim at that path does not adhere to this schema,
100  /// return an invalid schema object. This is shorthand for the following:
101  ///
102  /// \code
103  /// UsdHoudiniHoudiniFieldAsset(stage->GetPrimAtPath(path));
104  /// \endcode
105  ///
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
109  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
110  /// is defined (according to UsdPrim::IsDefined()) on this stage.
111  ///
112  /// If a prim adhering to this schema at \p path is already defined on this
113  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
114  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
115  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
116  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
117  /// current EditTarget for any nonexistent, or existing but not \a Defined
118  /// ancestors.
119  ///
120  /// The given \a path must be an absolute prim path that does not contain
121  /// any variant selections.
122  ///
123  /// If it is impossible to author any of the necessary PrimSpecs, (for
124  /// example, in case \a path cannot map to the current UsdEditTarget's
125  /// namespace) issue an error and return an invalid \a UsdPrim.
126  ///
127  /// Note that this method may return a defined prim whose typeName does not
128  /// specify this schema class, in case a stronger typeName opinion overrides
129  /// the opinion at the current EditTarget.
130  ///
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  UsdSchemaKind _GetSchemaKind() const override;
139 
140  /// \deprecated
141  /// Same as _GetSchemaKind, provided to maintain temporary backward
142  /// compatibility with older generated schemas.
143  UsdSchemaKind _GetSchemaType() const override;
144 
145 private:
146  // needs to invoke _GetStaticTfType.
147  friend class UsdSchemaRegistry;
148  static const TfType &_GetStaticTfType();
149 
150  static bool _IsTypedSchema();
151 
152  // override SchemaBase virtuals.
153  const TfType &_GetTfType() const override;
154 
155 public:
156  // ===================================================================== //
157  // Feel free to add custom code below this line, it will be preserved by
158  // the code generator.
159  //
160  // Just remember to:
161  // - Close the class declaration with };
162  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
163  // - Close the include guard with #endif
164  // ===================================================================== //
165  // --(BEGIN CUSTOM CODE)--
166 };
167 
169 
170 #endif
UsdHoudiniHoudiniFieldAsset(const UsdSchemaBase &schemaObj)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3340
UsdSchemaKind
Definition: common.h:127
UsdHoudiniHoudiniFieldAsset(const UsdPrim &prim=UsdPrim())
Represents a concrete typed schema.
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Definition: path.h:288
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64