GeodesicEngine< Scalar, Index > Class Template Reference

Engine that is used to compute geodesic distances on a surface mesh. More...

#include <lagrange/geodesic/GeodesicEngine.h>

Inheritance diagram for GeodesicEngine< Scalar, Index >:

Public Types
using	Mesh = SurfaceMesh<Scalar, Index>
	The mesh type.

Public Member Functions
	GeodesicEngine (Mesh &mesh)
	Base class constructor.
virtual	~GeodesicEngine ()=default
	Base class destructor.
virtual SingleSourceGeodesicResult	single_source_geodesic (const SingleSourceGeodesicOptions &options)=0
	Computes geodesic distance from one source to each vertex on the mesh.
virtual Scalar	point_to_point_geodesic (const PointToPointGeodesicOptions &options)
	Computes the geodesic distance between two points on the mesh.

Protected Member Functions
const Mesh &	mesh () const
Mesh &	mesh ()

Detailed Description

template<typename Scalar, typename Index>
class lagrange::geodesic::GeodesicEngine< Scalar, Index >

Engine that is used to compute geodesic distances on a surface mesh.

Template Parameters

Scalar	Mesh scalar type.
Index	Mesh index type.

Constructor & Destructor Documentation

GeodesicEngine()

template<typename Scalar, typename Index>

GeodesicEngine ( Mesh & mesh )

explicit

Base class constructor.

Parameters

mesh	Reference to the input mesh.

Member Function Documentation

single_source_geodesic()

template<typename Scalar, typename Index>

virtual SingleSourceGeodesicResult single_source_geodesic ( const SingleSourceGeodesicOptions & options )

pure virtual

Computes geodesic distance from one source to each vertex on the mesh.

Parameters

[in]

options

Input options for single source geodesic computation.

Returns

The attribute id of the computed geodesic distance attribute.

Implemented in GeodesicEngineDGPC< Scalar, Index >, GeodesicEngineHeat< Scalar, Index >::Impl, GeodesicEngineHeat< Scalar, Index >, GeodesicEngineMMP< Scalar, Index >::Impl, and GeodesicEngineMMP< Scalar, Index >.

point_to_point_geodesic()

template<typename Scalar, typename Index>

Scalar point_to_point_geodesic ( const PointToPointGeodesicOptions & options )

virtual

Computes the geodesic distance between two points on the mesh.

Parameters

[in]

options

Input options for point-to-point geodesic computation.

Returns

The geodesic distance between the source and target points.

---

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

• lagrange/geodesic/GeodesicEngine.h
• GeodesicEngine.cpp