topologyDescriptor.h
Go to the documentation of this file.
//
// Copyright 2014 DreamWorks Animation LLC.
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
// names, trademarks, service marks, or product names of the Licensor
// and its affiliates, except as required to comply with Section 4(c) of
// the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef OPENSUBDIV3_FAR_TOPOLOGY_DESCRIPTOR_H
#define OPENSUBDIV3_FAR_TOPOLOGY_DESCRIPTOR_H
#include "../version.h"
#include "../far/topologyRefiner.h"
#include "../far/topologyRefinerFactory.h"
#include "../far/error.h"
#include <cassert>
namespace OpenSubdiv {
namespace OPENSUBDIV_VERSION {
namespace Far {
struct TopologyDescriptor {
int numVertices,
numFaces;
int const * numVertsPerFace;
Index const * vertIndicesPerFace;
int numCreases;
Index const * creaseVertexIndexPairs;
float const * creaseWeights;
int numCorners;
Index const * cornerVertexIndices;
float const * cornerWeights;
int numHoles;
Index const * holeIndices;
bool isLeftHanded;
// Face-varying data channel -- value indices correspond to vertex indices,
// i.e. one for every vertex of every face:
//
struct FVarChannel {
int numValues;
Index const * valueIndices;
FVarChannel() : numValues(0), valueIndices(0) { }
};
int numFVarChannels;
FVarChannel const * fvarChannels;
TopologyDescriptor();
};
//
// Forward declarations of required TopologyRefinerFactory<TopologyDescriptor>
// specializations (defined internally):
//
// @cond EXCLUDE_DOXYGEN
template <>
bool
TopologyRefinerFactory<TopologyDescriptor>::resizeComponentTopology(
TopologyRefiner & refiner, TopologyDescriptor const & desc);
template <>
bool
TopologyRefinerFactory<TopologyDescriptor>::assignComponentTopology(
TopologyRefiner & refiner, TopologyDescriptor const & desc);
template <>
bool
TopologyRefinerFactory<TopologyDescriptor>::assignComponentTags(
TopologyRefiner & refiner, TopologyDescriptor const & desc);
template <>
bool
TopologyRefinerFactory<TopologyDescriptor>::assignFaceVaryingTopology(
TopologyRefiner & refiner, TopologyDescriptor const & desc);
template <>
void
TopologyRefinerFactory<TopologyDescriptor>::reportInvalidTopology(
TopologyError errCode, char const * msg, TopologyDescriptor const & desc);
// @endcond
} // end namespace Far
} // end namespace OPENSUBDIV_VERSION
using namespace OPENSUBDIV_VERSION;
} // end namespace OpenSubdiv
#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