basisCurves.h
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 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
34 #define HD_BASISCURVES_REPR_DESC_TOKENS \
35  (surfaceShader) \
36  (surfaceShaderUnlit) \
37  (hullColor) \
38  (pointColor)
39 
40 TF_DECLARE_PUBLIC_TOKENS(HdBasisCurvesReprDescTokens, HD_API,
41  HD_BASISCURVES_REPR_DESC_TOKENS);
42 
48 {
50  HdBasisCurvesGeomStyle geomStyle = HdBasisCurvesGeomStyleInvalid,
51  TfToken shadingTerminal = HdBasisCurvesReprDescTokens->surfaceShader)
52  : geomStyle(geomStyle),
54  {}
55 
56  bool IsEmpty() const {
57  return geomStyle == HdBasisCurvesGeomStyleInvalid;
58  }
59 
60  HdBasisCurvesGeomStyle geomStyle;
64 };
65 
68 class HdBasisCurves : public HdRprim
69 {
70 public:
71  HD_API
72  ~HdBasisCurves() override;
73 
78  inline HdDisplayStyle GetDisplayStyle(HdSceneDelegate* delegate) const;
79 
80  HD_API
81  TfTokenVector const & GetBuiltinPrimvarNames() const override;
82 
84  HD_API
85  static void ConfigureRepr(TfToken const &reprName,
87 
89  HD_API
90  static bool IsEnabledForceRefinedCurves();
91 
92 protected:
93  HD_API
94  HdBasisCurves(SdfPath const& id);
95 
96  using _BasisCurvesReprConfig = _ReprDescConfigs<HdBasisCurvesReprDesc>;
97 
98  HD_API
99  static _BasisCurvesReprConfig::DescArray
100  _GetReprDesc(TfToken const &reprName);
101 
102 private:
103  // Class can not be default constructed or copied.
104  HdBasisCurves() = delete;
105  HdBasisCurves(const HdBasisCurves &) = delete;
106  HdBasisCurves &operator =(const HdBasisCurves &) = delete;
107 
108  static _BasisCurvesReprConfig _reprDescConfig;
109 };
110 
113 {
114  return delegate->GetBasisCurvesTopology(GetId());
115 }
116 
117 inline HdDisplayStyle
118 HdBasisCurves::GetDisplayStyle(HdSceneDelegate* delegate) const
119 {
120  return delegate->GetDisplayStyle(GetId());
121 }
122 
123 
124 PXR_NAMESPACE_CLOSE_SCOPE
125 
126 #endif // PXR_IMAGING_HD_BASIS_CURVES_H
virtual HD_API HdBasisCurvesTopology GetBasisCurvesTopology(SdfPath const &id)
Gets the topological curve data for a given prim.
Describes how the geometry of a prim should be displayed.
Definition: sceneDelegate.h:80
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
The render engine state for a given rprim from the scene graph.
Definition: rprim.h:54
Adapter class providing data exchange with the client scene graph.
Descriptor to configure a drawItem for a repr.
Definition: basisCurves.h:47
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
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
Topology data for basisCurves.
static HD_API bool IsEnabledForceRefinedCurves()
Returns whether refinement is always on or not.
SdfPath const & GetId() const
Returns the identifier of this Rprim.
Definition: rprim.h:163
static HD_API void ConfigureRepr(TfToken const &reprName, HdBasisCurvesReprDesc desc)
Configure geometric style of drawItems for reprName.
virtual HD_API HdDisplayStyle GetDisplayStyle(SdfPath const &id)
Returns the refinement level for the given prim in the range [0,8].
HdBasisCurvesTopology GetBasisCurvesTopology(HdSceneDelegate *delegate) const
Topology.
Definition: basisCurves.h:112
Hydra Schema for a collection of curves using a particular basis.
Definition: basisCurves.h:68
HD_API TfTokenVector const & GetBuiltinPrimvarNames() const override
Returns the names of built-in primvars, i.e.
TfToken shadingTerminal
Specifies how the fragment color should be computed from primvar; this can be used to render heatmap ...
Definition: basisCurves.h:63