OpenSubdiv: opensubdiv/far/topologyDescriptor.h Source File

| OpenSubdiv

Loading...
Searching...
No Matches
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
35namespace OpenSubdiv {
36namespace OPENSUBDIV_VERSION {
37
38namespace Far {
39
49 struct TopologyDescriptor {
50
51 int numVertices,
52 numFaces;
53
54 int const * numVertsPerFace;
55 Index const * vertIndicesPerFace;
56
57 int numCreases;
58 Index const * creaseVertexIndexPairs;
59 float const * creaseWeights;
60
61 int numCorners;
62 Index const * cornerVertexIndices;
63 float const * cornerWeights;
64
65 int numHoles;
66 Index const * holeIndices;
67
68 bool isLeftHanded;
69
70 // Face-varying data channel -- value indices correspond to vertex indices,
71 // i.e. one for every vertex of every face:
72 //
73 struct FVarChannel {
74
75 int numValues;
76 Index const * valueIndices;
77
78 FVarChannel() : numValues(0), valueIndices(0) { }
79 };
80
81 int numFVarChannels;
82 FVarChannel const * fvarChannels;
83
84 TopologyDescriptor();
85};
86
87
88//
89// Forward declarations of required TopologyRefinerFactory<TopologyDescriptor>
90// specializations (defined internally):
91//
92// @cond EXCLUDE_DOXYGEN
93
94template <>
95bool
96 TopologyRefinerFactory<TopologyDescriptor>::resizeComponentTopology(
97 TopologyRefiner & refiner, TopologyDescriptor const & desc);
98
99template <>
100bool
101 TopologyRefinerFactory<TopologyDescriptor>::assignComponentTopology(
102 TopologyRefiner & refiner, TopologyDescriptor const & desc);
103
104template <>
105bool
106 TopologyRefinerFactory<TopologyDescriptor>::assignComponentTags(
107 TopologyRefiner & refiner, TopologyDescriptor const & desc);
108
109template <>
110bool
111 TopologyRefinerFactory<TopologyDescriptor>::assignFaceVaryingTopology(
112 TopologyRefiner & refiner, TopologyDescriptor const & desc);
113
114template <>
115void
116 TopologyRefinerFactory<TopologyDescriptor>::reportInvalidTopology(
117 TopologyError errCode, char const * msg, TopologyDescriptor const & desc);
118
119// @endcond
120
121} // end namespace Far
122
123} // end namespace OPENSUBDIV_VERSION
124using namespace OPENSUBDIV_VERSION;
125} // end namespace OpenSubdiv
126
127#endif /* OPENSUBDIV3_FAR_TOPOLOGY_DESCRIPTOR_H */
OpenSubdiv
Definition: limits.h:32
OpenSubdiv::OPENSUBDIV_VERSION::Far::Index
Vtr::Index Index
Definition: types.h:41
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor
A simple reference to raw topology data for use with TopologyRefinerFactory.
Definition: topologyDescriptor.h:49
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::fvarChannels
FVarChannel const * fvarChannels
Definition: topologyDescriptor.h:82
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numVertices
int numVertices
Definition: topologyDescriptor.h:51
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::cornerVertexIndices
Index const * cornerVertexIndices
Definition: topologyDescriptor.h:62
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::vertIndicesPerFace
Index const * vertIndicesPerFace
Definition: topologyDescriptor.h:55
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::creaseVertexIndexPairs
Index const * creaseVertexIndexPairs
Definition: topologyDescriptor.h:58
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::holeIndices
Index const * holeIndices
Definition: topologyDescriptor.h:66
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numFaces
int numFaces
Definition: topologyDescriptor.h:52
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numCorners
int numCorners
Definition: topologyDescriptor.h:61
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::cornerWeights
float const * cornerWeights
Definition: topologyDescriptor.h:63
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::isLeftHanded
bool isLeftHanded
Definition: topologyDescriptor.h:68
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numVertsPerFace
int const * numVertsPerFace
Definition: topologyDescriptor.h:54
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::TopologyDescriptor
TopologyDescriptor()
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::creaseWeights
float const * creaseWeights
Definition: topologyDescriptor.h:59
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numCreases
int numCreases
Definition: topologyDescriptor.h:57
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numHoles
int numHoles
Definition: topologyDescriptor.h:65
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::numFVarChannels
int numFVarChannels
Definition: topologyDescriptor.h:81
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::FVarChannel
Definition: topologyDescriptor.h:73
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::FVarChannel::FVarChannel
FVarChannel()
Definition: topologyDescriptor.h:78
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::FVarChannel::valueIndices
Index const * valueIndices
Definition: topologyDescriptor.h:76
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyDescriptor::FVarChannel::numValues
int numValues
Definition: topologyDescriptor.h:75
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,...
Definition: topologyRefinerFactory.h:621
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:707
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:690
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:580
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyRefinerFactory::assignFaceVaryingTopology
static bool assignFaceVaryingTopology(TopologyRefiner &newRefiner, MESH const &mesh)
(Optional) Specify face-varying data per face
Definition: topologyRefinerFactory.h:674
OpenSubdiv::OPENSUBDIV_VERSION::Far::TopologyRefiner
Stores topology data for a specified set of refinement options.
Definition: topologyRefiner.h:51