basisCurves.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_BASISCURVES_H
25 #define USDGEOM_GENERATED_BASISCURVES_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 // BASISCURVES //
51 // -------------------------------------------------------------------------- //
52 
264 {
265 public:
270 
275  explicit UsdGeomBasisCurves(const UsdPrim& prim=UsdPrim())
276  : UsdGeomCurves(prim)
277  {
278  }
279 
283  explicit UsdGeomBasisCurves(const UsdSchemaBase& schemaObj)
284  : UsdGeomCurves(schemaObj)
285  {
286  }
287 
289  USDGEOM_API
290  virtual ~UsdGeomBasisCurves();
291 
295  USDGEOM_API
296  static const TfTokenVector &
297  GetSchemaAttributeNames(bool includeInherited=true);
298 
308  USDGEOM_API
309  static UsdGeomBasisCurves
310  Get(const UsdStagePtr &stage, const SdfPath &path);
311 
334  USDGEOM_API
335  static UsdGeomBasisCurves
336  Define(const UsdStagePtr &stage, const SdfPath &path);
337 
338 protected:
342  USDGEOM_API
343  UsdSchemaKind _GetSchemaKind() const override;
344 
345 private:
346  // needs to invoke _GetStaticTfType.
347  friend class UsdSchemaRegistry;
348  USDGEOM_API
349  static const TfType &_GetStaticTfType();
350 
351  static bool _IsTypedSchema();
352 
353  // override SchemaBase virtuals.
354  USDGEOM_API
355  const TfType &_GetTfType() const override;
356 
357 public:
358  // --------------------------------------------------------------------- //
359  // TYPE
360  // --------------------------------------------------------------------- //
371  USDGEOM_API
372  UsdAttribute GetTypeAttr() const;
373 
379  USDGEOM_API
380  UsdAttribute CreateTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
381 
382 public:
383  // --------------------------------------------------------------------- //
384  // BASIS
385  // --------------------------------------------------------------------- //
398  USDGEOM_API
399  UsdAttribute GetBasisAttr() const;
400 
406  USDGEOM_API
407  UsdAttribute CreateBasisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
408 
409 public:
410  // --------------------------------------------------------------------- //
411  // WRAP
412  // --------------------------------------------------------------------- //
426  USDGEOM_API
427  UsdAttribute GetWrapAttr() const;
428 
434  USDGEOM_API
435  UsdAttribute CreateWrapAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
436 
437 public:
438  // ===================================================================== //
439  // Feel free to add custom code below this line, it will be preserved by
440  // the code generator.
441  //
442  // Just remember to:
443  // - Close the class declaration with };
444  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
445  // - Close the include guard with #endif
446  // ===================================================================== //
447  // --(BEGIN CUSTOM CODE)--
448 
451 
452  typedef std::vector< std::pair<TfToken, size_t> > ComputeInterpolationInfo;
453 
460  USDGEOM_API
462  const UsdTimeCode& timeCode,
463  ComputeInterpolationInfo* info=NULL) const;
464 
469  USDGEOM_API
470  size_t ComputeUniformDataSize(const UsdTimeCode& timeCode) const;
471 
476  USDGEOM_API
477  size_t ComputeVaryingDataSize(const UsdTimeCode& timeCode) const;
478 
483  USDGEOM_API
484  size_t ComputeVertexDataSize(const UsdTimeCode& timeCode) const;
485 
487 };
488 
489 PXR_NAMESPACE_CLOSE_SCOPE
490 
491 #endif
USDGEOM_API UsdAttribute CreateWrapAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWrapAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static USDGEOM_API UsdGeomBasisCurves Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomBasisCurves holding the prim adhering to this schema at path on stage.
USDGEOM_API size_t ComputeUniformDataSize(const UsdTimeCode &timeCode) const
Computes the expected size for data with "uniform" interpolation.
Base class for UsdGeomBasisCurves, UsdGeomNurbsCurves, and UsdGeomHermiteCurves.
Definition: curves.h:75
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: basisCurves.h:269
USDGEOM_API UsdAttribute CreateBasisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBasisAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static USDGEOM_API UsdGeomBasisCurves Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
UsdGeomBasisCurves(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomBasisCurves on UsdPrim prim .
Definition: basisCurves.h:275
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
USDGEOM_API UsdAttribute GetWrapAttr() const
If wrap is set to periodic, the curve when rendered will repeat the initial vertices (dependent on th...
virtual USDGEOM_API ~UsdGeomBasisCurves()
Destructor.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDGEOM_API UsdAttribute GetTypeAttr() const
Linear curves interpolate linearly between two vertices.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
USDGEOM_API TfToken ComputeInterpolationForSize(size_t n, const UsdTimeCode &timeCode, ComputeInterpolationInfo *info=NULL) const
Computes interpolation token for n.
Represents a concrete typed schema.
USDGEOM_API size_t ComputeVaryingDataSize(const UsdTimeCode &timeCode) const
Computes the expected size for data with "varying" interpolation.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
BasisCurves are a batched curve representation analogous to the classic RIB definition via Basis and ...
Definition: basisCurves.h:263
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
USDGEOM_API UsdAttribute GetBasisAttr() const
The basis specifies the vstep and matrix used for cubic interpolation.
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 UsdAttribute CreateTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDGEOM_API size_t ComputeVertexDataSize(const UsdTimeCode &timeCode) const
Computes the expected size for data with "vertex" interpolation.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
UsdGeomBasisCurves(const UsdSchemaBase &schemaObj)
Construct a UsdGeomBasisCurves on the prim held by schemaObj .
Definition: basisCurves.h:283