All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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"
31 #include "pxr/usd/usdGeom/pointBased.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 // CURVES //
51 // -------------------------------------------------------------------------- //
52 
64 {
65 public:
70 
75  explicit UsdGeomCurves(const UsdPrim& prim=UsdPrim())
76  : UsdGeomPointBased(prim)
77  {
78  }
79 
83  explicit UsdGeomCurves(const UsdSchemaBase& schemaObj)
84  : UsdGeomPointBased(schemaObj)
85  {
86  }
87 
89  USDGEOM_API
90  virtual ~UsdGeomCurves();
91 
95  USDGEOM_API
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
108  USDGEOM_API
109  static UsdGeomCurves
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
112 
113 protected:
117  USDGEOM_API
118  UsdSchemaType _GetSchemaType() const override;
119 
120 private:
121  // needs to invoke _GetStaticTfType.
122  friend class UsdSchemaRegistry;
123  USDGEOM_API
124  static const TfType &_GetStaticTfType();
125 
126  static bool _IsTypedSchema();
127 
128  // override SchemaBase virtuals.
129  USDGEOM_API
130  const TfType &_GetTfType() const override;
131 
132 public:
133  // --------------------------------------------------------------------- //
134  // CURVEVERTEXCOUNTS
135  // --------------------------------------------------------------------- //
145  USDGEOM_API
147 
153  USDGEOM_API
154  UsdAttribute CreateCurveVertexCountsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
155 
156 public:
157  // --------------------------------------------------------------------- //
158  // WIDTHS
159  // --------------------------------------------------------------------- //
172  USDGEOM_API
173  UsdAttribute GetWidthsAttr() const;
174 
180  USDGEOM_API
181  UsdAttribute CreateWidthsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
182 
183 public:
184  // ===================================================================== //
185  // Feel free to add custom code below this line, it will be preserved by
186  // the code generator.
187  //
188  // Just remember to:
189  // - Close the class declaration with };
190  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
191  // - Close the include guard with #endif
192  // ===================================================================== //
193  // --(BEGIN CUSTOM CODE)--
194 
203  USDGEOM_API
205 
216  USDGEOM_API
217  bool SetWidthsInterpolation(TfToken const &interpolation);
218 
229  USDGEOM_API
230  static bool ComputeExtent(const VtVec3fArray& points,
231  const VtFloatArray& widths, VtVec3fArray* extent);
232 
235  USDGEOM_API
236  static bool ComputeExtent(const VtVec3fArray& points,
237  const VtFloatArray& widths, const GfMatrix4d& transform,
238  VtVec3fArray* extent);
239 };
240 
241 PXR_NAMESPACE_CLOSE_SCOPE
242 
243 #endif
UsdGeomCurves(const UsdSchemaBase &schemaObj)
Construct a UsdGeomCurves on the prim held by schemaObj .
Definition: curves.h:83
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:58
Base class for BasisCurves and NurbsCurves.
Definition: curves.h:63
USDGEOM_API UsdAttribute GetWidthsAttr() const
Provides width specification for the curves, whose application will depend on whether the curve is or...
virtual USDGEOM_API ~UsdGeomCurves()
Destructor.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
static USDGEOM_API bool ComputeExtent(const VtVec3fArray &points, const VtFloatArray &widths, VtVec3fArray *extent)
Compute the extent for the curves defined by points and widths.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
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 USDGEOM_API UsdGeomCurves Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomCurves holding the prim adhering to this schema at path on stage. ...
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
USDGEOM_API bool SetWidthsInterpolation(TfToken const &interpolation)
Set the interpolation for the widths attribute.
UsdGeomCurves(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomCurves on UsdPrim prim .
Definition: curves.h:75
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
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
Represents a non-concrete typed schema.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
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 const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: curves.h:69
USDGEOM_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
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...
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDGEOM_API TfToken GetWidthsInterpolation() const
Get the interpolation for the widths attribute.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182