Loading...
Searching...
No Matches
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"
32#include "pxr/usd/usd/prim.h"
33#include "pxr/usd/usd/stage.h"
35
36#include "pxr/base/vt/value.h"
37
38#include "pxr/base/gf/vec3d.h"
39#include "pxr/base/gf/vec3f.h"
41
42#include "pxr/base/tf/token.h"
43#include "pxr/base/tf/type.h"
44
45PXR_NAMESPACE_OPEN_SCOPE
46
47class SdfAssetPath;
48
49// -------------------------------------------------------------------------- //
50// NURBSCURVES //
51// -------------------------------------------------------------------------- //
52
78{
79public:
83 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
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
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
152protected:
156 USDGEOM_API
158
159private:
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
171public:
172 // --------------------------------------------------------------------- //
173 // ORDER
174 // --------------------------------------------------------------------- //
185 USDGEOM_API
187
193 USDGEOM_API
194 UsdAttribute CreateOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
195
196public:
197 // --------------------------------------------------------------------- //
198 // KNOTS
199 // --------------------------------------------------------------------- //
210 USDGEOM_API
212
218 USDGEOM_API
219 UsdAttribute CreateKnotsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
220
221public:
222 // --------------------------------------------------------------------- //
223 // RANGES
224 // --------------------------------------------------------------------- //
237 USDGEOM_API
239
245 USDGEOM_API
246 UsdAttribute CreateRangesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
247
248public:
249 // --------------------------------------------------------------------- //
250 // POINTWEIGHTS
251 // --------------------------------------------------------------------- //
264 USDGEOM_API
266
272 USDGEOM_API
273 UsdAttribute CreatePointWeightsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
274
275public:
276 // ===================================================================== //
277 // Feel free to add custom code below this line, it will be preserved by
278 // the code generator.
279 //
280 // Just remember to:
281 // - Close the class declaration with };
282 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
283 // - Close the include guard with #endif
284 // ===================================================================== //
285 // --(BEGIN CUSTOM CODE)--
286};
287
288PXR_NAMESPACE_CLOSE_SCOPE
289
290#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
TfType represents a dynamic runtime type.
Definition: type.h:65
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
Base class for UsdGeomBasisCurves, UsdGeomNurbsCurves, and UsdGeomHermiteCurves.
Definition: curves.h:76
This schema is analagous to NURBS Curves in packages like Maya and Houdini, often used for interchang...
Definition: nurbsCurves.h:78
USDGEOM_API UsdAttribute CreatePointWeightsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPointWeightsAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
virtual USDGEOM_API ~UsdGeomNurbsCurves()
Destructor.
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.
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 const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: nurbsCurves.h:83
USDGEOM_API UsdAttribute GetRangesAttr() const
Provides the minimum and maximum parametric values (as defined by knots) over which the curve is actu...
USDGEOM_API UsdAttribute GetOrderAttr() const
Order of the curve.
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 UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
USDGEOM_API UsdAttribute GetPointWeightsAttr() const
Optionally provides "w" components for each control point, thus must be the same length as the points...
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...
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.
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...
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.
UsdGeomNurbsCurves(const UsdSchemaBase &schemaObj)
Construct a UsdGeomNurbsCurves on the prim held by schemaObj .
Definition: nurbsCurves.h:97
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Singleton registry that provides access to schema type information and the prim definitions for regis...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:164
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:129
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457