All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
points.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_POINTS_H
25 #define USDGEOM_GENERATED_POINTS_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 // POINTS //
51 // -------------------------------------------------------------------------- //
52 
67 {
68 public:
73 
78  explicit UsdGeomPoints(const UsdPrim& prim=UsdPrim())
79  : UsdGeomPointBased(prim)
80  {
81  }
82 
86  explicit UsdGeomPoints(const UsdSchemaBase& schemaObj)
87  : UsdGeomPointBased(schemaObj)
88  {
89  }
90 
92  USDGEOM_API
93  virtual ~UsdGeomPoints();
94 
98  USDGEOM_API
99  static const TfTokenVector &
100  GetSchemaAttributeNames(bool includeInherited=true);
101 
111  USDGEOM_API
112  static UsdGeomPoints
113  Get(const UsdStagePtr &stage, const SdfPath &path);
114 
137  USDGEOM_API
138  static UsdGeomPoints
139  Define(const UsdStagePtr &stage, const SdfPath &path);
140 
141 protected:
145  USDGEOM_API
146  UsdSchemaType _GetSchemaType() const override;
147 
148 private:
149  // needs to invoke _GetStaticTfType.
150  friend class UsdSchemaRegistry;
151  USDGEOM_API
152  static const TfType &_GetStaticTfType();
153 
154  static bool _IsTypedSchema();
155 
156  // override SchemaBase virtuals.
157  USDGEOM_API
158  const TfType &_GetTfType() const override;
159 
160 public:
161  // --------------------------------------------------------------------- //
162  // WIDTHS
163  // --------------------------------------------------------------------- //
176  USDGEOM_API
177  UsdAttribute GetWidthsAttr() const;
178 
184  USDGEOM_API
185  UsdAttribute CreateWidthsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
186 
187 public:
188  // --------------------------------------------------------------------- //
189  // IDS
190  // --------------------------------------------------------------------- //
203  USDGEOM_API
204  UsdAttribute GetIdsAttr() const;
205 
211  USDGEOM_API
212  UsdAttribute CreateIdsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213 
214 public:
215  // ===================================================================== //
216  // Feel free to add custom code below this line, it will be preserved by
217  // the code generator.
218  //
219  // Just remember to:
220  // - Close the class declaration with };
221  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
222  // - Close the include guard with #endif
223  // ===================================================================== //
224  // --(BEGIN CUSTOM CODE)--
225 
234  USDGEOM_API
236 
247  USDGEOM_API
248  bool SetWidthsInterpolation(TfToken const &interpolation);
249 
261  USDGEOM_API
262  static bool ComputeExtent(const VtVec3fArray& points,
263  const VtFloatArray& widths, VtVec3fArray* extent);
264 
267  USDGEOM_API
268  static bool ComputeExtent(const VtVec3fArray& points,
269  const VtFloatArray& widths, const GfMatrix4d& transform,
270  VtVec3fArray* extent);
271 };
272 
273 PXR_NAMESPACE_CLOSE_SCOPE
274 
275 #endif
static USDGEOM_API bool ComputeExtent(const VtVec3fArray &points, const VtFloatArray &widths, VtVec3fArray *extent)
Compute the extent for the point cloud defined by points and widths.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: points.h:72
USDGEOM_API UsdAttribute CreateIdsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetIdsAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
Points are analogous to the RiPoints spec.
Definition: points.h:66
Base class for all UsdGeomGprims that possess points, providing common attributes such as normals and...
Definition: pointBased.h:58
USDGEOM_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
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 bool SetWidthsInterpolation(TfToken const &interpolation)
Set the interpolation for the widths attribute.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
static USDGEOM_API UsdGeomPoints Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomPoints holding the prim adhering to this schema at path on stage. ...
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:127
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 GetWidthsAttr() const
Widths are defined as the diameter of the points, in object space.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:433
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
UsdGeomPoints(const UsdSchemaBase &schemaObj)
Construct a UsdGeomPoints on the prim held by schemaObj .
Definition: points.h:86
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...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
UsdGeomPoints(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomPoints on UsdPrim prim .
Definition: points.h:78
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
static USDGEOM_API UsdGeomPoints Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
USDGEOM_API TfToken GetWidthsInterpolation() const
Get the interpolation for the widths attribute.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDGEOM_API UsdAttribute GetIdsAttr() const
Ids are optional; if authored, the ids array should be the same length as the points array...
virtual USDGEOM_API ~UsdGeomPoints()
Destructor.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182