HDK
 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 PXR_IMAGING_HD_POINTS_H
25 #define PXR_IMAGING_HD_POINTS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/rprim.h"
31 
33 
34 /// \class HdPointsReprDesc
35 ///
36 /// Descriptor to configure a drawItem for a repr.
37 ///
42  {}
43 
44  bool IsEmpty() const {
46  }
47 
49 };
50 
51 /// Hydra Schema for a point cloud.
52 ///
53 class HdPoints: public HdRprim {
54 public:
55  HD_API
56  virtual ~HdPoints();
57 
58  HD_API
59  TfTokenVector const & GetBuiltinPrimvarNames() const override;
60 
61  /// Configure geometric style of drawItems for \p reprName
62  HD_API
63  static void ConfigureRepr(TfToken const &reprName,
64  const HdPointsReprDesc &desc);
65 
66 protected:
67  /// Constructor. instancerId, if specified, is the instancer which uses
68  /// this point cloud as a prototype.
69  HD_API
70  HdPoints(SdfPath const& id);
71 
73 
74  HD_API
75  static _PointsReprConfig::DescArray _GetReprDesc(TfToken const &reprName);
76 
77 private:
78 
79  // Class can not be default constructed or copied.
80  HdPoints() = delete;
81  HdPoints(const HdPoints &) = delete;
82  HdPoints &operator =(const HdPoints &) = delete;
83 
84  static _PointsReprConfig _reprDescConfig;
85 };
86 
87 
89 
90 #endif // PXR_IMAGING_HD_POINTS_H
HdPointsGeomStyle geomStyle
Definition: points.h:48
#define HD_API
Definition: api.h:40
virtual HD_API ~HdPoints()
HD_API TfTokenVector const & GetBuiltinPrimvarNames() const override
_ReprDescConfigs< HdPointsReprDesc > _PointsReprConfig
Definition: points.h:72
Definition: token.h:87
Definition: rprim.h:68
static HD_API _PointsReprConfig::DescArray _GetReprDesc(TfToken const &reprName)
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
HdPointsReprDesc(HdPointsGeomStyle geomStyle=HdPointsGeomStyleInvalid)
Definition: points.h:39
Definition: path.h:288
HdPointsGeomStyle
Definition: enums.h:165
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::array< DESC_TYPE, N > DescArray
Definition: rprim.h:332
bool IsEmpty() const
Definition: points.h:44
static HD_API void ConfigureRepr(TfToken const &reprName, const HdPointsReprDesc &desc)
Configure geometric style of drawItems for reprName.