mesh.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_MESH_H
25 #define PXR_IMAGING_HD_MESH_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/enums.h"
31 #include "pxr/imaging/hd/meshTopology.h"
32 #include "pxr/imaging/hd/rprim.h"
33 #include "pxr/imaging/hd/tokens.h"
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 #define HD_MESH_REPR_DESC_TOKENS \
39  (surfaceShader) \
40  (surfaceShaderUnlit) \
41  (surfaceShaderSheer) \
42  (surfaceShaderOutline) \
43  (constantColor) \
44  (hullColor) \
45  (pointColor)
46 
47 TF_DECLARE_PUBLIC_TOKENS(HdMeshReprDescTokens, HD_API,
48  HD_MESH_REPR_DESC_TOKENS);
49 
55 {
56  HdMeshReprDesc(HdMeshGeomStyle geomStyle = HdMeshGeomStyleInvalid,
57  HdCullStyle cullStyle = HdCullStyleDontCare,
58  TfToken shadingTerminal = HdMeshReprDescTokens->surfaceShader,
59  bool flatShadingEnabled = true,
60  bool blendWireframeColor = true,
61  bool doubleSided = false,
62  float lineWidth = 0,
63  bool useCustomDisplacement = true,
64  bool enableScalarOverride = true)
74  {}
75 
76  bool IsEmpty() const {
77  return geomStyle == HdMeshGeomStyleInvalid;
78  }
79 
81  HdMeshGeomStyle geomStyle;
83  HdCullStyle cullStyle;
95  float lineWidth;
102 };
103 
106 class HdMesh : public HdRprim
107 {
108 public:
109  HD_API
110  ~HdMesh() override;
111 
115  inline bool IsDoubleSided(HdSceneDelegate* delegate) const;
116  inline HdCullStyle GetCullStyle(HdSceneDelegate* delegate) const;
117  inline VtValue GetShadingStyle(HdSceneDelegate* delegate) const;
118 
122  inline HdMeshTopology GetMeshTopology(HdSceneDelegate* delegate) const;
123  inline HdDisplayStyle GetDisplayStyle(HdSceneDelegate* delegate) const;
124  inline PxOsdSubdivTags GetSubdivTags(HdSceneDelegate* delegate) const;
125 
127  virtual HdMeshTopologySharedPtr GetTopology() const;
128 
132  inline VtValue GetPoints(HdSceneDelegate* delegate) const;
133  inline VtValue GetNormals(HdSceneDelegate* delegate) const;
134 
135  HD_API
136  TfTokenVector const & GetBuiltinPrimvarNames() const override;
137 
142  HD_API
143  static void ConfigureRepr(TfToken const &reprName,
144  HdMeshReprDesc desc1,
146 
147 protected:
150  HD_API
151  HdMesh(SdfPath const& id);
152 
153  // We allow up to 2 repr descs per repr for meshes (see ConfigureRepr above)
154  using _MeshReprConfig = _ReprDescConfigs<HdMeshReprDesc, 2>;
155 
156  HD_API
157  static _MeshReprConfig::DescArray _GetReprDesc(TfToken const &reprName);
158 
159 private:
160 
161  // Class can not be default constructed or copied.
162  HdMesh() = delete;
163  HdMesh(const HdMesh &) = delete;
164  HdMesh &operator =(const HdMesh &) = delete;
165 
166  static _MeshReprConfig _reprDescConfig;
167 };
168 
169 inline bool
171 {
172  return delegate->GetDoubleSided(GetId());
173 }
174 
175 inline HdCullStyle
176 HdMesh::GetCullStyle(HdSceneDelegate* delegate) const
177 {
178  return delegate->GetCullStyle(GetId());
179 }
180 
181 inline VtValue
182 HdMesh::GetShadingStyle(HdSceneDelegate* delegate) const
183 {
184  return delegate->GetShadingStyle(GetId());
185 }
186 
187 inline HdMeshTopology
189 {
190  return delegate->GetMeshTopology(GetId());
191 }
192 
193 inline HdDisplayStyle
194 HdMesh::GetDisplayStyle(HdSceneDelegate* delegate) const
195 {
196  return delegate->GetDisplayStyle(GetId());
197 }
198 
199 inline PxOsdSubdivTags
200 HdMesh::GetSubdivTags(HdSceneDelegate* delegate) const
201 {
202  return delegate->GetSubdivTags(GetId());
203 }
204 
205 inline HdMeshTopologySharedPtr
207 {
208  return HdMeshTopologySharedPtr();
209 }
210 
211 inline VtValue
213 {
214  return GetPrimvar(delegate, HdTokens->points);
215 }
216 
217 inline VtValue
218 HdMesh::GetNormals(HdSceneDelegate* delegate) const
219 {
220  return GetPrimvar(delegate, HdTokens->normals);
221 }
222 
223 
224 PXR_NAMESPACE_CLOSE_SCOPE
225 
226 #endif //PXR_IMAGING_HD_MESH_H
HdMeshTopology GetMeshTopology(HdSceneDelegate *delegate) const
Topological accessors via the scene delegate.
Definition: mesh.h:188
Tags for non-hierarchial subdiv surfaces.
Definition: subdivTags.h:43
HD_API TfTokenVector const & GetBuiltinPrimvarNames() const override
Returns the names of built-in primvars, i.e.
bool doubleSided
Should this mesh be treated as double-sided? The resolved value is (prim.doubleSided || repr....
Definition: mesh.h:93
bool enableScalarOverride
Should scalar override be allowed on this drawItem.
Definition: mesh.h:101
Descriptor to configure the drawItem(s) for a repr.
Definition: mesh.h:54
Describes how the geometry of a prim should be displayed.
Definition: sceneDelegate.h:80
virtual HD_API VtValue GetShadingStyle(SdfPath const &id)
Returns the shading style for the given prim.
float lineWidth
How big (in pixels) should line drawing be?
Definition: mesh.h:95
bool flatShadingEnabled
Does this mesh want flat shading?
Definition: mesh.h:88
virtual HD_API bool GetDoubleSided(SdfPath const &id)
Returns the doubleSided state for the given prim.
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
virtual HD_API HdCullStyle GetCullStyle(SdfPath const &id)
Returns the cullstyle for the given prim.
Adapter class providing data exchange with the client scene graph.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
static HD_API void ConfigureRepr(TfToken const &reprName, HdMeshReprDesc desc1, HdMeshReprDesc desc2=HdMeshReprDesc())
Configure the geometric style of the mesh for a given representation.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
VtValue GetPoints(HdSceneDelegate *delegate) const
Primvars Accessors.
Definition: mesh.h:212
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
HdMeshGeomStyle geomStyle
The rendering style: draw refined/unrefined, edge, points, etc.
Definition: mesh.h:81
SdfPath const & GetId() const
Returns the identifier of this Rprim.
Definition: rprim.h:163
virtual HD_API HdMeshTopology GetMeshTopology(SdfPath const &id)
Gets the topological mesh data for a given prim.
bool useCustomDisplacement
Should this mesh use displacementShader() to displace points?
Definition: mesh.h:97
virtual HD_API PxOsdSubdivTags GetSubdivTags(SdfPath const &id)
Gets the subdivision surface tags (sharpness, holes, etc).
TfToken shadingTerminal
Specifies how the fragment color should be computed from surfaceShader; this can be used to render a ...
Definition: mesh.h:86
bool blendWireframeColor
Should the wireframe color be blended into the color primvar?
Definition: mesh.h:90
bool IsDoubleSided(HdSceneDelegate *delegate) const
Render State.
Definition: mesh.h:170
Hydra Schema for a subdivision surface or poly-mesh object.
Definition: mesh.h:106
virtual HD_API HdDisplayStyle GetDisplayStyle(SdfPath const &id)
Returns the refinement level for the given prim in the range [0,8].
Topology data for meshes.
Definition: meshTopology.h:55
HdCullStyle cullStyle
The culling style: draw front faces, back faces, etc.
Definition: mesh.h:83
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
virtual HdMeshTopologySharedPtr GetTopology() const
Topology getter.
Definition: mesh.h:206