HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
flatNormals.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 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_FLAT_NORMALS_H
25 #define PXR_IMAGING_HD_FLAT_NORMALS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 
30 #include "pxr/imaging/hd/types.h"
31 
32 #include "pxr/base/gf/vec3d.h"
33 #include "pxr/base/gf/vec3f.h"
34 
36 
37 
38 class HdMeshTopology;
39 
40 /// \class Hd_FlatNormals
41 ///
42 /// Hd_FlatNormals encapsulates mesh flat normals information.
43 /// It uses passed-in face index data and points data to compute
44 /// flat per-face normals. It does this by breaking each face into
45 /// a triangle fan centered at vertex 0, and averaging triangle normals.
46 ///
47 class Hd_FlatNormals final
48 {
49 public:
50  /// Computes the flat normals result using the supplied face coord
51  /// information and points data. Returns an array of the same size and
52  /// type as the source points, with optional packing.
53  HD_API
55  HdMeshTopology const * topology,
56  GfVec3f const * pointsPtr);
57  HD_API
59  HdMeshTopology const * topology,
60  GfVec3d const * pointsPtr);
61  HD_API
63  HdMeshTopology const * topology,
64  GfVec3f const * pointsPtr);
65  HD_API
67  HdMeshTopology const * topology,
68  GfVec3d const * pointsPtr);
69 
70 private:
71  Hd_FlatNormals() = delete;
72  ~Hd_FlatNormals() = delete;
73 };
74 
75 
77 
78 #endif // PXR_IMAGING_HD_FLAT_NORMALS_H
static HD_API VtArray< HdVec4f_2_10_10_10_REV > ComputeFlatNormalsPacked(HdMeshTopology const *topology, GfVec3f const *pointsPtr)
Definition: vec3f.h:62
#define HD_API
Definition: api.h:40
GT_API const UT_StringHolder topology
static HD_API VtArray< GfVec3f > ComputeFlatNormals(HdMeshTopology const *topology, GfVec3f const *pointsPtr)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
Definition: vec3d.h:62
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91