HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Static Public Member Functions | Static Public Attributes | List of all members
GeomUtilSphereMeshGenerator Class Referencefinal

#include <sphereMeshGenerator.h>

+ Inheritance diagram for GeomUtilSphereMeshGenerator:

Static Public Member Functions

static GEOMUTIL_API size_t ComputeNumPoints (const size_t numRadial, const size_t numAxial, const bool closedSweep=true)
 
static size_t ComputeNumNormals (const size_t numRadial, const size_t numAxial, const bool closedSweep=true)
 
static TfToken GetNormalsInterpolation ()
 
static GEOMUTIL_API
PxOsdMeshTopology 		GenerateTopology (const size_t numRadial, const size_t numAxial, const bool closedSweep=true)
 
template<typename PointIterType , typename ScalarType , typename Enabled = typename _EnableIfGfVec3Iterator<PointIterType>::type>
static void GeneratePoints (PointIterType iter, const size_t numRadial, const size_t numAxial, const ScalarType radius, const GfMatrix4d *framePtr=nullptr)
 
template<typename PointIterType , typename ScalarType , typename Enabled = typename _EnableIfGfVec3Iterator<PointIterType>::type>
static void GeneratePoints (PointIterType iter, const size_t numRadial, const size_t numAxial, const ScalarType radius, const ScalarType sweepDegrees, const GfMatrix4d *framePtr=nullptr)
 
template<typename PointIterType , typename Enabled = typename _EnableIfGfVec3Iterator<PointIterType>::type>
static void GenerateNormals (PointIterType iter, const size_t numRadial, const size_t numAxial, const GfMatrix4d *framePtr=nullptr)
 
template<typename PointIterType , typename ScalarType , typename Enabled = typename _EnableIfGfVec3Iterator<PointIterType>::type>
static void GenerateNormals (PointIterType iter, const size_t numRadial, const size_t numAxial, const ScalarType sweepDegrees, const GfMatrix4d *framePtr=nullptr)
 
- Static Public Member Functions inherited from GeomUtilMeshGeneratorBase
template<typename PointIterType , typename Enabled = typename _EnableIfNotGfVec3Iterator<PointIterType>::type>
static void GeneratePoints (PointIterType iter,...)
 
template<typename PointIterType , typename Enabled = typename _EnableIfNotGfVec3Iterator<PointIterType>::type>
static void GenerateNormals (PointIterType iter,...)
 

Static Public Attributes

static constexpr size_t minNumRadial = 3
 
static constexpr size_t minNumAxial = 2
 

Additional Inherited Members

- Protected Types inherited from GeomUtilMeshGeneratorBase
enum  _CapStyle { CapStyleNone, CapStyleSharedEdge, CapStyleSeparateEdge }
 
- Static Protected Member Functions inherited from GeomUtilMeshGeneratorBase
static PxOsdMeshTopology _GenerateCappedQuadTopology (const size_t numRadial, const size_t numQuadStrips, const _CapStyle bottomCapStyle, const _CapStyle topCapStyle, const bool closedSweep)
 
static size_t _ComputeNumRadialPoints (const size_t numRadial, const bool closedSweep)
 
static size_t _ComputeNumCappedQuadTopologyPoints (const size_t numRadial, const size_t numQuadStrips, const _CapStyle bottomCapStyle, const _CapStyle topCapStyle, const bool closedSweep)
 
template<typename ScalarType >
static std::vector< std::array
< ScalarType, 2 > > 		_GenerateUnitArcXY (const size_t numRadial, const ScalarType sweepDegrees)
 

Detailed Description

This class provides an implementation for generating topology, point positions and surface normals on a sphere with a given radius. The sphere is made up of circular cross-sections in the XY plane and is centered at the origin. Each cross-section has numRadial segments. Successive cross-sections are generated at numAxial locations along the Z axis, with the bottom of the sphere at Z = -r and top at Z = r.

An optional transform may be provided to GeneratePoints and GenerateNormals to orient the sphere as necessary (e.g., cross-sections in the YZ plane).

An additional overload of GeneratePoints is provided to specify a sweep angle for the sphere about the +Z axis. When the sweep is less than 360 degrees, the generated geometry is not closed.

Usage:

const size_t numRadial = 4, numAxial = 4;
const size_t numPoints =
GeomUtilSphereMeshGenerator::ComputeNumPoints(numRadial, numAxial);
const float radius = 5;
MyPointContainer<GfVec3f> points(numPoints);
GeomUtilSphereMeshGenerator::GeneratePoints(
points.begin(), numRadial, numAxial, radius);
const size_t numNormals =
GeomUtilSphereMeshGenerator::ComputeNumPoints(numRadial, numAxial);
MyPointContainer<GfVec3f> normals(numNormals);
GeomUtilSphereMeshGenerator::GenerateNormals(
normals.begin(), numRadial, numAxial);

Definition at line 58 of file sphereMeshGenerator.h.

Member Function Documentation

static size_t GeomUtilSphereMeshGenerator::ComputeNumNormals ( const size_t  numRadial,
const size_t  numAxial,
const bool  closedSweep = true 
)
inlinestatic

Definition at line 71 of file sphereMeshGenerator.h.

static GEOMUTIL_API size_t GeomUtilSphereMeshGenerator::ComputeNumPoints ( const size_t  numRadial,
const size_t  numAxial,
const bool  closedSweep = true 
)
static
template<typename PointIterType , typename Enabled = typename _EnableIfGfVec3Iterator<PointIterType>::type>
static void GeomUtilSphereMeshGenerator::GenerateNormals ( PointIterType  iter,
const size_t  numRadial,
const size_t  numAxial,
const GfMatrix4d *  framePtr = nullptr 
)
inlinestatic

Definition at line 132 of file sphereMeshGenerator.h.

template<typename PointIterType , typename ScalarType , typename Enabled = typename _EnableIfGfVec3Iterator<PointIterType>::type>
static void GeomUtilSphereMeshGenerator::GenerateNormals ( PointIterType  iter,
const size_t  numRadial,
const size_t  numAxial,
const ScalarType  sweepDegrees,
const GfMatrix4d *  framePtr = nullptr 
)
inlinestatic

Definition at line 149 of file sphereMeshGenerator.h.

template<typename PointIterType , typename ScalarType , typename Enabled = typename _EnableIfGfVec3Iterator<PointIterType>::type>
static void GeomUtilSphereMeshGenerator::GeneratePoints ( PointIterType  iter,
const size_t  numRadial,
const size_t  numAxial,
const ScalarType  radius,
const GfMatrix4d *  framePtr = nullptr 
)
inlinestatic

Definition at line 96 of file sphereMeshGenerator.h.

template<typename PointIterType , typename ScalarType , typename Enabled = typename _EnableIfGfVec3Iterator<PointIterType>::type>
static void GeomUtilSphereMeshGenerator::GeneratePoints ( PointIterType  iter,
const size_t  numRadial,
const size_t  numAxial,
const ScalarType  radius,
const ScalarType  sweepDegrees,
const GfMatrix4d *  framePtr = nullptr 
)
inlinestatic

Definition at line 111 of file sphereMeshGenerator.h.

static GEOMUTIL_API PxOsdMeshTopology GeomUtilSphereMeshGenerator::GenerateTopology ( const size_t  numRadial,
const size_t  numAxial,
const bool  closedSweep = true 
)
static
static TfToken GeomUtilSphereMeshGenerator::GetNormalsInterpolation ( )
inlinestatic

Definition at line 80 of file sphereMeshGenerator.h.

Member Data Documentation

constexpr size_t GeomUtilSphereMeshGenerator::minNumAxial = 2
static

Definition at line 63 of file sphereMeshGenerator.h.

constexpr size_t GeomUtilSphereMeshGenerator::minNumRadial = 3
static

Definition at line 62 of file sphereMeshGenerator.h.

The documentation for this class was generated from the following file: