Loading...
Searching...
No Matches
curves.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_CURVES_H
25#define USDGEOM_GENERATED_CURVES_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// CURVES //
51// -------------------------------------------------------------------------- //
52
76{
77public:
81 static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped;
82
87 explicit UsdGeomCurves(const UsdPrim& prim=UsdPrim())
88 : UsdGeomPointBased(prim)
89 {
90 }
91
95 explicit UsdGeomCurves(const UsdSchemaBase& schemaObj)
96 : UsdGeomPointBased(schemaObj)
97 {
98 }
99
101 USDGEOM_API
102 virtual ~UsdGeomCurves();
103
107 USDGEOM_API
108 static const TfTokenVector &
109 GetSchemaAttributeNames(bool includeInherited=true);
110
120 USDGEOM_API
121 static UsdGeomCurves
122 Get(const UsdStagePtr &stage, const SdfPath &path);
123
124
125protected:
129 USDGEOM_API
131
132private:
133 // needs to invoke _GetStaticTfType.
134 friend class UsdSchemaRegistry;
135 USDGEOM_API
136 static const TfType &_GetStaticTfType();
137
138 static bool _IsTypedSchema();
139
140 // override SchemaBase virtuals.
141 USDGEOM_API
142 const TfType &_GetTfType() const override;
143
144public:
145 // --------------------------------------------------------------------- //
146 // CURVEVERTEXCOUNTS
147 // --------------------------------------------------------------------- //
158 USDGEOM_API
160
166 USDGEOM_API
167 UsdAttribute CreateCurveVertexCountsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
168
169public:
170 // --------------------------------------------------------------------- //
171 // WIDTHS
172 // --------------------------------------------------------------------- //
186 USDGEOM_API
188
194 USDGEOM_API
195 UsdAttribute CreateWidthsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
196
197public:
198 // ===================================================================== //
199 // Feel free to add custom code below this line, it will be preserved by
200 // the code generator.
201 //
202 // Just remember to:
203 // - Close the class declaration with };
204 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
205 // - Close the include guard with #endif
206 // ===================================================================== //
207 // --(BEGIN CUSTOM CODE)--
208
217 USDGEOM_API
219
230 USDGEOM_API
231 bool SetWidthsInterpolation(TfToken const &interpolation);
232
243 USDGEOM_API
244 static bool ComputeExtent(const VtVec3fArray& points,
245 const VtFloatArray& widths, VtVec3fArray* extent);
246
249 USDGEOM_API
250 static bool ComputeExtent(const VtVec3fArray& points,
251 const VtFloatArray& widths, const GfMatrix4d& transform,
252 VtVec3fArray* extent);
253
259 USDGEOM_API
261};
262
263PXR_NAMESPACE_CLOSE_SCOPE
264
265#endif
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
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
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
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
virtual USDGEOM_API ~UsdGeomCurves()
Destructor.
UsdGeomCurves(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomCurves on UsdPrim prim .
Definition: curves.h:87
USDGEOM_API UsdAttribute CreateCurveVertexCountsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCurveVertexCountsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static USDGEOM_API UsdGeomCurves Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomCurves holding the prim adhering to this schema at path on stage.
USDGEOM_API UsdAttribute CreateWidthsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWidthsAttr(), 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: curves.h:81
USDGEOM_API UsdAttribute GetWidthsAttr() const
Provides width specification for the curves, whose application will depend on whether the curve is or...
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind 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...
USDGEOM_API size_t GetCurveCount(UsdTimeCode timeCode=UsdTimeCode::Default()) const
Returns the number of curves as defined by the size of the curveVertexCounts array at timeCode.
USDGEOM_API TfToken GetWidthsInterpolation() const
Get the interpolation for the widths attribute.
static USDGEOM_API bool ComputeExtent(const VtVec3fArray &points, const VtFloatArray &widths, const GfMatrix4d &transform, VtVec3fArray *extent)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USDGEOM_API bool SetWidthsInterpolation(TfToken const &interpolation)
Set the interpolation for the widths attribute.
static USDGEOM_API bool ComputeExtent(const VtVec3fArray &points, const VtFloatArray &widths, VtVec3fArray *extent)
Compute the extent for the curves defined by points and widths.
UsdGeomCurves(const UsdSchemaBase &schemaObj)
Construct a UsdGeomCurves on the prim held by schemaObj .
Definition: curves.h:95
USDGEOM_API UsdAttribute GetCurveVertexCountsAttr() const
Curves-derived primitives can represent multiple distinct, potentially disconnected curves.
Base class for all UsdGeomGprims that possess points, providing common attributes such as normals and...
Definition: pointBased.h:59
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...
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:84
static constexpr UsdTimeCode Default()
Produce a UsdTimeCode representing the sentinel value for 'default'.
Definition: timeCode.h:112
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