HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 PXR_IMAGING_HD_BASIS_CURVES_H
25 #define PXR_IMAGING_HD_BASIS_CURVES_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 #define HD_BASISCURVES_REPR_DESC_TOKENS \
35  (surfaceShader) \
36  (hullColor) \
37  (pointColor)
38 
39 TF_DECLARE_PUBLIC_TOKENS(HdBasisCurvesReprDescTokens, HD_API,
41 
42 /// \class HdBasisCurvesReprDesc
43 ///
44 /// Descriptor to configure a drawItem for a repr.
45 ///
49  TfToken shadingTerminal = HdBasisCurvesReprDescTokens->surfaceShader)
52  {}
53 
54  bool IsEmpty() const {
56  }
57 
59  /// Specifies how the fragment color should be computed from primvar;
60  /// this can be used to render heatmap highlighting etc.
62 };
63 
64 /// Hydra Schema for a collection of curves using a particular basis.
65 ///
66 class HdBasisCurves : public HdRprim {
67 public:
68  HD_API
69  virtual ~HdBasisCurves();
70 
71  ///
72  /// Topology
73  ///
75  inline HdDisplayStyle GetDisplayStyle(HdSceneDelegate* delegate) const;
76 
77  HD_API
78  TfTokenVector const & GetBuiltinPrimvarNames() const override;
79 
80  /// Configure geometric style of drawItems for \p reprName
81  HD_API
82  static void ConfigureRepr(TfToken const &reprName,
84 
85  /// Returns whether refinement is always on or not.
86  HD_API
87  static bool IsEnabledForceRefinedCurves();
88 
89 protected:
90  HD_API
91  HdBasisCurves(SdfPath const& id);
92 
94 
95  HD_API
97  _GetReprDesc(TfToken const &reprName);
98 
99 private:
100  // Class can not be default constructed or copied.
101  HdBasisCurves() = delete;
102  HdBasisCurves(const HdBasisCurves &) = delete;
103  HdBasisCurves &operator =(const HdBasisCurves &) = delete;
104 
105  static _BasisCurvesReprConfig _reprDescConfig;
106 };
107 
110 {
111  return delegate->GetBasisCurvesTopology(GetId());
112 }
113 
114 inline HdDisplayStyle
116 {
117  return delegate->GetDisplayStyle(GetId());
118 }
119 
120 
122 
123 #endif // PXR_IMAGING_HD_BASIS_CURVES_H
virtual HD_API ~HdBasisCurves()
HdBasisCurvesTopology GetBasisCurvesTopology(HdSceneDelegate *delegate) const
Definition: basisCurves.h:109
#define HD_API
Definition: api.h:40
HD_API TfTokenVector const & GetBuiltinPrimvarNames() const override
virtual HD_API HdBasisCurvesTopology GetBasisCurvesTopology(SdfPath const &id)
Gets the topological curve data for a given prim.
HdBasisCurvesReprDesc(HdBasisCurvesGeomStyle geomStyle=HdBasisCurvesGeomStyleInvalid, TfToken shadingTerminal=HdBasisCurvesReprDescTokens->surfaceShader)
Definition: basisCurves.h:47
static HD_API bool IsEnabledForceRefinedCurves()
Returns whether refinement is always on or not.
Definition: token.h:87
virtual HD_API HdDisplayStyle GetDisplayStyle(SdfPath const &id)
Definition: rprim.h:68
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Definition: path.h:288
#define HD_BASISCURVES_REPR_DESC_TOKENS
Definition: basisCurves.h:34
TF_DECLARE_PUBLIC_TOKENS(HdBasisCurvesReprDescTokens, HD_API, HD_BASISCURVES_REPR_DESC_TOKENS)
static HD_API _BasisCurvesReprConfig::DescArray _GetReprDesc(TfToken const &reprName)
bool IsEmpty() const
Definition: basisCurves.h:54
_ReprDescConfigs< HdBasisCurvesReprDesc > _BasisCurvesReprConfig
Definition: basisCurves.h:93
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
SdfPath const & GetId() const
Definition: rprim.h:176
HdBasisCurvesGeomStyle
Definition: enums.h:158
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::array< DESC_TYPE, N > DescArray
Definition: rprim.h:332
HdDisplayStyle GetDisplayStyle(HdSceneDelegate *delegate) const
Definition: basisCurves.h:115
static HD_API void ConfigureRepr(TfToken const &reprName, HdBasisCurvesReprDesc desc)
Configure geometric style of drawItems for reprName.
HdBasisCurvesGeomStyle geomStyle
Definition: basisCurves.h:58