MeshKernel
Public Member Functions | Public Attributes | List of all members
meshkernel::FuncDistanceFromAPoint Struct Reference

This structure is used to compute the point on a spline closest to another point. More...

#include <Splines.hpp>

Public Member Functions

 FuncDistanceFromAPoint (const Splines &splines, UInt splineIndex, Point point)
 Constructor. More...
 
double operator() (double adimensionalDistanceReferencePoint) const
 This is the function we want to find the root of.
 

Public Attributes

const Splinesm_spline
 Reference to splines.
 
UInt m_splineIndex
 Spline index.
 
Point m_point
 The point from where the distance is calculated.
 
double m_DimensionalDistance = 0.0
 Dimensional distance.
 

Detailed Description

This structure is used to compute the point on a spline closest to another point.

Constructor & Destructor Documentation

◆ FuncDistanceFromAPoint()

meshkernel::FuncDistanceFromAPoint::FuncDistanceFromAPoint ( const Splines splines,
UInt  splineIndex,
Point  point 
)
inline

Constructor.

Parameters
[in]splinesA pointer to splines
[in]splineIndexThe index of the current spline
[in]pointThe point from where the distance is calculated

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