types.h

Go to the documentation of this file.

//
//   Copyright 2014 DreamWorks Animation LLC.
//
//   Licensed under the terms set forth in the LICENSE.txt file available at
//   https://opensubdiv.org/license.
//
#ifndef OPENSUBDIV3_VTR_TYPES_H
#define OPENSUBDIV3_VTR_TYPES_H
 
#include "../version.h"
 
#include "../vtr/array.h"
 
#include <limits>
#include <vector>
 
namespace OpenSubdiv {
namespace OPENSUBDIV_VERSION {
 
namespace Vtr {
 
//
//  A few types (and constants) for use within Vtr and potentially by its
//  clients (appropriately exported and retyped)
//
 
//
//  Integer type and constants to index the vectors of components.  Note that we
//  can't use specific width integer types like uint32_t, etc. as use of stdint
//  is not portable.
//
//  The convention throughout the OpenSubdiv code is to use "int" in most places,
//  with "unsigned int" being limited to a few cases (why?).  So we continue that
//  trend here and use "int" for topological indices (with -1 indicating "invalid")
//  despite the fact that we lose half the range compared to using "uint" (with ~0
//  as invalid).
//
typedef int Index;
 
inline Index constexpr INDEX_INVALID = -1;
 
inline bool IndexIsValid(Index index) { return (index != INDEX_INVALID); }
 
//
//  Integer type and constants used to index one component within another.  Ideally
//  this is just 2 bits once refinement reduces faces to tris or quads -- and so
//  could potentially be combined with an Index -- but we need something larger for
//  the N-sided face.
//
typedef unsigned short  LocalIndex;
 
//  Declared as "int" since it's intended for more general use
inline int constexpr VALENCE_LIMIT = std::numeric_limits<LocalIndex>::max();
 
//
//  Collections of integer types in variable or fixed sized arrays.  Note that the use
//  of "vector" in the name indicates a class that wraps an std::vector (typically a
//  member variable) which is fully resizable and owns its own storage, whereas "array"
//  wraps a vtr::Array which uses a fixed block of pre-allocated memory.
//
typedef std::vector<Index>  IndexVector;
 
typedef Array<Index>             IndexArray;
typedef ConstArray<Index>        ConstIndexArray;
 
typedef Array<LocalIndex>        LocalIndexArray;
typedef ConstArray<LocalIndex>   ConstLocalIndexArray;
 
 
} // end namespace Vtr
 
} // end namespace OPENSUBDIV_VERSION
using namespace OPENSUBDIV_VERSION;
} // end namespace OpenSubdiv
 
#endif /* OPENSUBDIV3_VTR_TYPES_H */