opensubdiv/far/topologyDescriptor.h Source File

- Main Page
- Namespaces
- Classes
- Files

- File List

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
topologyDescriptor.h
Go to the documentation of this file.
1 //
2 // Copyright 2014 DreamWorks Animation LLC.
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 OPENSUBDIV3_FAR_TOPOLOGY_DESCRIPTOR_H
25 #define OPENSUBDIV3_FAR_TOPOLOGY_DESCRIPTOR_H
26
27 #include "../version.h"
28
29 #include "../far/topologyRefiner.h"
30 #include "../far/topologyRefinerFactory.h"
31 #include "../far/error.h"
32
33 #include <cassert>
34
35 namespace OpenSubdiv {
36 namespace OPENSUBDIV_VERSION {
37
38 namespace Far {
39
46 struct TopologyDescriptor {
47
48 int numVertices,
49 numFaces;
50
51 int const * numVertsPerFace;
52 Index const * vertIndicesPerFace;
53
54 int numCreases;
55 Index const * creaseVertexIndexPairs;
56 float const * creaseWeights;
57
58 int numCorners;
59 Index const * cornerVertexIndices;
60 float const * cornerWeights;
61
62 int numHoles;
63 Index const * holeIndices;
64
65 bool isLeftHanded;
66
67 // Face-varying data channel -- value indices correspond to vertex indices,
68 // i.e. one for every vertex of every face:
69 //
70 struct FVarChannel {
71
72 int numValues;
73 Index const * valueIndices;
74
75 FVarChannel() : numValues(0), valueIndices(0) { }
76 };
77
78 int numFVarChannels;
79 FVarChannel const * fvarChannels;
80
81 TopologyDescriptor();
82 };
83
84
85 //
86 // Forward declarations of required TopologyRefinerFactory<TopologyDescriptor>
87 // specializations (defined internally):
88 //
89 // @cond EXCLUDE_DOXYGEN
90
91 template <>
92 bool
93 TopologyRefinerFactory<TopologyDescriptor>::resizeComponentTopology(
94 TopologyRefiner & refiner, TopologyDescriptor const & desc);
95
96 template <>
97 bool
98 TopologyRefinerFactory<TopologyDescriptor>::assignComponentTopology(
99 TopologyRefiner & refiner, TopologyDescriptor const & desc);
100
101 template <>
102 bool
103 TopologyRefinerFactory<TopologyDescriptor>::assignComponentTags(
104 TopologyRefiner & refiner, TopologyDescriptor const & desc);
105
106 template <>
107 bool
108 TopologyRefinerFactory<TopologyDescriptor>::assignFaceVaryingTopology(
109 TopologyRefiner & refiner, TopologyDescriptor const & desc);
110
111 template <>
112 void
113 TopologyRefinerFactory<TopologyDescriptor>::reportInvalidTopology(
114 TopologyError errCode, char const * msg, TopologyDescriptor const & desc);
115
116 // @endcond
117
118 } // end namespace Far
119
120 } // end namespace OPENSUBDIV_VERSION
121 using namespace OPENSUBDIV_VERSION;
122 } // end namespace OpenSubdiv
123
124 #endif /* OPENSUBDIV3_FAR_TOPOLOGY_DESCRIPTOR_H */
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::creaseWeights
float const * creaseWeights
Definition: topologyDescriptor.h:56
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numCreases
int numCreases
Definition: topologyDescriptor.h:54
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::isLeftHanded
bool isLeftHanded
Definition: topologyDescriptor.h:65
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyRefinerFactory::reportInvalidTopology
static void reportInvalidTopology(TopologyError errCode, char const *msg, MESH const &mesh)
(Optional) Control run-time topology validation and error reporting
Definition: topologyRefinerFactory.h:671
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numVertsPerFace
int const * numVertsPerFace
Definition: topologyDescriptor.h:51
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::TopologyDescriptor
TopologyDescriptor()
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numCorners
int numCorners
Definition: topologyDescriptor.h:58
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numFaces
int numFaces
Definition: topologyDescriptor.h:48
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyRefinerFactory::assignComponentTopology
static bool assignComponentTopology(TopologyRefiner &newRefiner, MESH const &mesh)
Specify the relationships between vertices, faces, etc. ie the face-vertices, vertex-faces, edge-vertices, etc.
Definition: topologyRefinerFactory.h:585
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor
Descriptor for raw topology data, provided as a convenience with a corresponding Factory. It should be functionally complete and simple to use, but for more demanding situations, writing a custom Factory is likely warranted.
Definition: topologyDescriptor.h:46
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::holeIndices
Index const * holeIndices
Definition: topologyDescriptor.h:63
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyRefinerFactory::assignComponentTags
static bool assignComponentTags(TopologyRefiner &newRefiner, MESH const &mesh)
(Optional) Specify edge or vertex sharpness or face holes
Definition: topologyRefinerFactory.h:654
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::FVarChannel::valueIndices
Index const * valueIndices
Definition: topologyDescriptor.h:73
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numHoles
int numHoles
Definition: topologyDescriptor.h:62
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::FVarChannel::FVarChannel
FVarChannel()
Definition: topologyDescriptor.h:75
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::cornerWeights
float const * cornerWeights
Definition: topologyDescriptor.h:60
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::fvarChannels
FVarChannel const * fvarChannels
Definition: topologyDescriptor.h:79
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::FVarChannel
Definition: topologyDescriptor.h:70
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::cornerVertexIndices
Index const * cornerVertexIndices
Definition: topologyDescriptor.h:59
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::creaseVertexIndexPairs
Index const * creaseVertexIndexPairs
Definition: topologyDescriptor.h:55
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numVertices
int numVertices
Definition: topologyDescriptor.h:48
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyRefinerFactory::resizeComponentTopology
static bool resizeComponentTopology(TopologyRefiner &newRefiner, MESH const &mesh)
Specify the number of vertices, faces, face-vertices, etc.
Definition: topologyRefinerFactory.h:544
OpenSubdiv::OPENSUBDIV_VERSION::Far::Index
Vtr::Index Index
Definition: types.h:41
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::vertIndicesPerFace
Index const * vertIndicesPerFace
Definition: topologyDescriptor.h:52
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyRefiner
Stores topology data for a specified set of refinement options.
Definition: topologyRefiner.h:49
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numFVarChannels
int numFVarChannels
Definition: topologyDescriptor.h:78
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::FVarChannel::numValues
int numValues
Definition: topologyDescriptor.h:72
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyRefinerFactory::assignFaceVaryingTopology
static bool assignFaceVaryingTopology(TopologyRefiner &newRefiner, MESH const &mesh)
(Optional) Specify face-varying data per face
Definition: topologyRefinerFactory.h:638