opensubdiv/far/patchDescriptor.h Source File

patchDescriptor.h
Go to the documentation of this file.
1 //
2 // Copyright 2013 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
25 #ifndef OPENSUBDIV3_FAR_PATCH_DESCRIPTOR_H
26 #define OPENSUBDIV3_FAR_PATCH_DESCRIPTOR_H
27
28 #include "../version.h"
29
30 #include "../far/types.h"
31 #include "../sdc/types.h"
32
33 #include <vector>
34
35 namespace OpenSubdiv {
36 namespace OPENSUBDIV_VERSION {
37
38 namespace Far {
39
50 class PatchDescriptor {
51
52 public:
53
54 enum Type {
55 NON_PATCH = 0,
56
57 POINTS,
58 LINES,
59
60 QUADS,
61 TRIANGLES,
62
63 LOOP,
64
65 REGULAR,
66 GREGORY,
67 GREGORY_BOUNDARY,
68 GREGORY_BASIS
69 };
70
71 public:
72
74 PatchDescriptor() :
75 _type(NON_PATCH) { }
76
78 PatchDescriptor(int type) :
79 _type(type) { }
80
82 PatchDescriptor( PatchDescriptor const & d ) :
83 _type(d.GetType()) { }
84
86 Type GetType() const {
87 return (Type)_type;
88 }
89
91 static inline bool IsAdaptive(Type type) {
92 return (type>=LOOP && type<=GREGORY_BASIS);
93 }
94
96 bool IsAdaptive() const {
97 return IsAdaptive( this->GetType() );
98 }
99
102 static inline short GetNumControlVertices( Type t );
103
105 static inline short GetNumFVarControlVertices( Type t );
106
109 short GetNumControlVertices() const {
110 return GetNumControlVertices( this->GetType() );
111 }
112
114 short GetNumFVarControlVertices() const {
115 return GetNumFVarControlVertices( this->GetType() );
116 }
117
119 static short GetRegularPatchSize() { return 16; }
120
122 static short GetGregoryPatchSize() { return 4; }
123
125 static short GetGregoryBasisPatchSize() { return 20; }
126
127
130 static Vtr::ConstArray<PatchDescriptor> GetAdaptivePatchDescriptors(Sdc::SchemeType type);
131
133 inline bool operator < ( PatchDescriptor const other ) const;
134
136 inline bool operator == ( PatchDescriptor const other ) const;
137
138 // debug helper
139 void print() const;
140
141 private:
142 unsigned int _type;
143 };
144
145 typedef Vtr::ConstArray<PatchDescriptor> ConstPatchDescriptorArray;
146
147 // Returns the number of control vertices expected for a patch of this type
148 inline short
149 PatchDescriptor::GetNumControlVertices( Type type ) {
150 switch (type) {
151 case REGULAR : return GetRegularPatchSize();
152 case QUADS : return 4;
153 case GREGORY :
154 case GREGORY_BOUNDARY : return GetGregoryPatchSize();
155 case GREGORY_BASIS : return GetGregoryBasisPatchSize();
156 case TRIANGLES : return 3;
157 case LINES : return 2;
158 case POINTS : return 1;
159 default : return -1;
160 }
161 }
162
163 // Returns the number of face-varying control vertices expected for a patch of this type
164 inline short
165 PatchDescriptor::GetNumFVarControlVertices( Type type ) {
166 return PatchDescriptor::GetNumControlVertices(type);
167 }
168
169 // Allows ordering of patches by type
170 inline bool
171 PatchDescriptor::operator < ( PatchDescriptor const other ) const {
172 return (_type < other._type);
173 }
174
175 // True if the descriptors are identical
176 inline bool
177 PatchDescriptor::operator == ( PatchDescriptor const other ) const {
178 return _type == other._type;
179 }
180
181
182
183 } // end namespace Far
184
185 } // end namespace OPENSUBDIV_VERSION
186 using namespace OPENSUBDIV_VERSION;
187
188 } // end namespace OpenSubdiv
189
190 #endif /* OPENSUBDIV3_FAR_PATCH_DESCRIPTOR_H */
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::REGULAR
feature-adaptive bicubic patches
Definition: patchDescriptor.h:65
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::PatchDescriptor
PatchDescriptor()
Default constructor.
Definition: patchDescriptor.h:74
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::IsAdaptive
bool IsAdaptive() const
Returns true if the type is an adaptive patch.
Definition: patchDescriptor.h:96
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::operator==
bool operator==(PatchDescriptor const other) const
True if the descriptors are identical.
Definition: patchDescriptor.h:177
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GetGregoryBasisPatchSize
static short GetGregoryBasisPatchSize()
Number of control vertices of Gregory patch basis (20)
Definition: patchDescriptor.h:125
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GREGORY_BOUNDARY
Definition: patchDescriptor.h:67
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GetRegularPatchSize
static short GetRegularPatchSize()
Number of control vertices of Regular Patches in table.
Definition: patchDescriptor.h:119
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::TRIANGLES
bilinear triangles-only mesh
Definition: patchDescriptor.h:61
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::Type
Type
Definition: patchDescriptor.h:54
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::NON_PATCH
undefined
Definition: patchDescriptor.h:55
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::print
void print() const
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GetGregoryPatchSize
static short GetGregoryPatchSize()
Number of control vertices of Gregory (and Gregory Boundary) Patches in table.
Definition: patchDescriptor.h:122
OpenSubdiv::OPENSUBDIV_VERSION::Sdc::SchemeType
SchemeType
Enumerated type for all subdivisions schemes supported by OpenSubdiv.
Definition: types.h:37
OpenSubdiv::OPENSUBDIV_VERSION::Far::ConstPatchDescriptorArray
Vtr::ConstArray< PatchDescriptor > ConstPatchDescriptorArray
Definition: patchDescriptor.h:145
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::LOOP
Loop patch.
Definition: patchDescriptor.h:63
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GREGORY
Definition: patchDescriptor.h:66
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::operator<
bool operator<(PatchDescriptor const other) const
Allows ordering of patches by type.
Definition: patchDescriptor.h:171
OpenSubdiv::OPENSUBDIV_VERSION::Vtr::ConstArray
Definition: array.h:53
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GetNumControlVertices
short GetNumControlVertices() const
Returns the number of control vertices expected for a patch of the type described.
Definition: patchDescriptor.h:109
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GetAdaptivePatchDescriptors
static Vtr::ConstArray< PatchDescriptor > GetAdaptivePatchDescriptors(Sdc::SchemeType type)
Returns a vector of all the legal patch descriptors for the given adaptive subdivision scheme...
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::PatchDescriptor
PatchDescriptor(PatchDescriptor const &d)
Copy Constructor.
Definition: patchDescriptor.h:82
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GREGORY_BASIS
Definition: patchDescriptor.h:68
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::QUADS
bilinear quads-only patches
Definition: patchDescriptor.h:60
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GetNumFVarControlVertices
short GetNumFVarControlVertices() const
Deprecated.
Definition: patchDescriptor.h:114
OpenSubdiv
Definition: error.h:30
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::IsAdaptive
static bool IsAdaptive(Type type)
Returns true if the type is an adaptive patch.
Definition: patchDescriptor.h:91
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::LINES
lines (useful for cage drawing)
Definition: patchDescriptor.h:58
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::GetType
Type GetType() const
Returns the type of the patch.
Definition: patchDescriptor.h:86
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::POINTS
points (useful for cage drawing)
Definition: patchDescriptor.h:57
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor::PatchDescriptor
PatchDescriptor(int type)
Constructor.
Definition: patchDescriptor.h:78
OpenSubdiv::OPENSUBDIV_VERSION::Far::PatchDescriptor
Describes the type of a patch.
Definition: patchDescriptor.h:50