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