All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nurbsCurves.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 USDGEOM_GENERATED_NURBSCURVES_H
25 #define USDGEOM_GENERATED_NURBSCURVES_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdGeom/api.h"
31 #include "pxr/usd/usdGeom/curves.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdGeom/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 // NURBSCURVES //
51 // -------------------------------------------------------------------------- //
52 
78 {
79 public:
84 
89  explicit UsdGeomNurbsCurves(const UsdPrim& prim=UsdPrim())
90  : UsdGeomCurves(prim)
91  {
92  }
93 
97  explicit UsdGeomNurbsCurves(const UsdSchemaBase& schemaObj)
98  : UsdGeomCurves(schemaObj)
99  {
100  }
101 
103  USDGEOM_API
104  virtual ~UsdGeomNurbsCurves();
105 
109  USDGEOM_API
110  static const TfTokenVector &
111  GetSchemaAttributeNames(bool includeInherited=true);
112 
122  USDGEOM_API
123  static UsdGeomNurbsCurves
124  Get(const UsdStagePtr &stage, const SdfPath &path);
125 
148  USDGEOM_API
149  static UsdGeomNurbsCurves
150  Define(const UsdStagePtr &stage, const SdfPath &path);
151 
152 protected:
156  USDGEOM_API
157  UsdSchemaType _GetSchemaType() const override;
158 
159 private:
160  // needs to invoke _GetStaticTfType.
161  friend class UsdSchemaRegistry;
162  USDGEOM_API
163  static const TfType &_GetStaticTfType();
164 
165  static bool _IsTypedSchema();
166 
167  // override SchemaBase virtuals.
168  USDGEOM_API
169  const TfType &_GetTfType() const override;
170 
171 public:
172  // --------------------------------------------------------------------- //
173  // ORDER
174  // --------------------------------------------------------------------- //
184  USDGEOM_API
185  UsdAttribute GetOrderAttr() const;
186 
192  USDGEOM_API
193  UsdAttribute CreateOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
194 
195 public:
196  // --------------------------------------------------------------------- //
197  // KNOTS
198  // --------------------------------------------------------------------- //
208  USDGEOM_API
209  UsdAttribute GetKnotsAttr() const;
210 
216  USDGEOM_API
217  UsdAttribute CreateKnotsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
218 
219 public:
220  // --------------------------------------------------------------------- //
221  // RANGES
222  // --------------------------------------------------------------------- //
234  USDGEOM_API
235  UsdAttribute GetRangesAttr() const;
236 
242  USDGEOM_API
243  UsdAttribute CreateRangesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
244 
245 public:
246  // ===================================================================== //
247  // Feel free to add custom code below this line, it will be preserved by
248  // the code generator.
249  //
250  // Just remember to:
251  // - Close the class declaration with };
252  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
253  // - Close the include guard with #endif
254  // ===================================================================== //
255  // --(BEGIN CUSTOM CODE)--
256 };
257 
258 PXR_NAMESPACE_CLOSE_SCOPE
259 
260 #endif
UsdGeomNurbsCurves(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomNurbsCurves on UsdPrim prim .
Definition: nurbsCurves.h:89
USDGEOM_API UsdAttribute GetKnotsAttr() const
Knot vector providing curve parameterization.
USDGEOM_API UsdAttribute CreateKnotsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetKnotsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static USDGEOM_API UsdGeomNurbsCurves Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
virtual USDGEOM_API ~UsdGeomNurbsCurves()
Destructor.
Base class for BasisCurves and NurbsCurves.
Definition: curves.h:63
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: nurbsCurves.h:83
static USDGEOM_API UsdGeomNurbsCurves Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomNurbsCurves holding the prim adhering to this schema at path on stage.
USDGEOM_API UsdAttribute CreateRangesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRangesAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDGEOM_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
static USDGEOM_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
This schema is analagous to NURBS Curves in packages like Maya and Houdini, often used for interchang...
Definition: nurbsCurves.h:77
USDGEOM_API UsdAttribute CreateOrderAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
USDGEOM_API UsdAttribute GetOrderAttr() const
Order of the curve.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
UsdGeomNurbsCurves(const UsdSchemaBase &schemaObj)
Construct a UsdGeomNurbsCurves on the prim held by schemaObj .
Definition: nurbsCurves.h:97
USDGEOM_API UsdAttribute GetRangesAttr() const
Provides the minimum and maximum parametric values (as defined by knots) over which the curve is actu...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182