planeMeshGenerator.h

//
// Copyright 2024 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_GEOM_UTIL_PLANE_MESH_GENERATOR_H
#define PXR_IMAGING_GEOM_UTIL_PLANE_MESH_GENERATOR_H
 
#include "pxr/imaging/geomUtil/api.h"
#include "pxr/imaging/geomUtil/meshGeneratorBase.h"
#include "pxr/imaging/geomUtil/tokens.h"
 
#include "pxr/pxr.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class GfMatrix4d;
class PxOsdMeshTopology;
 
class GeomUtilPlaneMeshGenerator final
    : public GeomUtilMeshGeneratorBase
{
public:
    GEOMUTIL_API
    static size_t ComputeNumPoints();
 
    static size_t ComputeNumNormals()
    {
        // A single normal for all points.
        return 1;
    }
 
    static TfToken GetNormalsInterpolation()
    {
        // A single normal for all points.
        return GeomUtilInterpolationTokens->constant;
    }
 
    GEOMUTIL_API
    static PxOsdMeshTopology GenerateTopology();
 
    template<typename PointIterType,
             typename ScalarType,
             typename Enabled =
                typename _EnableIfGfVec3Iterator<PointIterType>::type>
    static void GeneratePoints(
        PointIterType iter,
        const ScalarType xLength,
        const ScalarType yLength,
        const GfMatrix4d* framePtr = nullptr)
    {
        using PointType =
            typename std::iterator_traits<PointIterType>::value_type;
 
        _GeneratePointsImpl(xLength, yLength,
            framePtr ? _PointWriter<PointType>(iter, framePtr)
                     : _PointWriter<PointType>(iter));
    }
 
    using GeomUtilMeshGeneratorBase::GeneratePoints;
 
    template<typename PointIterType,
             typename Enabled =
                typename _EnableIfGfVec3Iterator<PointIterType>::type>
    static void GenerateNormals(
        PointIterType iter,
        const GfMatrix4d* framePtr = nullptr)
    {
        using PointType =
            typename std::iterator_traits<PointIterType>::value_type;
 
        _GenerateNormalsImpl(
            framePtr ? _PointWriter<PointType>(iter, framePtr)
                     : _PointWriter<PointType>(iter));
    }
 
    using GeomUtilMeshGeneratorBase::GenerateNormals;
 
private:
 
    template<typename PointType>
    static void _GeneratePointsImpl(
        const typename PointType::ScalarType xLength,
        const typename PointType::ScalarType yLength,
        const _PointWriter<PointType>& ptWriter);
 
    template<typename PointType>
    static void _GenerateNormalsImpl(
        const _PointWriter<PointType>& ptWriter);
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_GEOM_UTIL_PLANE_MESH_GENERATOR_H