microsoft-visualbasic-runtime/Extensions/Image/Math/GeomTransform.vb

#Region "Microsoft.VisualBasic::dc40206759ca6caac1a3b5a682cef17b, Microsoft.VisualBasic.Core\Extensions\Image\Math\GeomTransform.vb"

    ' Author:
    ' 
    '       asuka (amethyst.asuka@gcmodeller.org)
    '       xie (genetics@smrucc.org)
    '       xieguigang (xie.guigang@live.com)
    ' 
    ' Copyright (c) 2018 GPL3 Licensed
    ' 
    ' 
    ' GNU GENERAL PUBLIC LICENSE (GPL3)
    ' 
    ' 
    ' This program is free software: you can redistribute it and/or modify
    ' it under the terms of the GNU General Public License as published by
    ' the Free Software Foundation, either version 3 of the License, or
    ' (at your option) any later version.
    ' 
    ' This program is distributed in the hope that it will be useful,
    ' but WITHOUT ANY WARRANTY; without even the implied warranty of
    ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ' GNU General Public License for more details.
    ' 
    ' You should have received a copy of the GNU General Public License
    ' along with this program. If not, see <http://www.gnu.org/licenses/>.



    ' /********************************************************************************/

    ' Summaries:

    '     Module GeomTransform
    ' 
    '         Function: Angle, Area, (+2 Overloads) CalculateAngle, CenterAlign, (+2 Overloads) CentralOffset
    '                   (+4 Overloads) Centre, CircleRectangle, (+4 Overloads) Distance, (+2 Overloads) GetBounds, GetCenter
    '                   (+2 Overloads) InRegion, MirrorX, MirrorY, (+8 Overloads) OffSet2D, Offsets
    '                   (+5 Overloads) Scale, ShapePoints, SquareSize
    ' 
    ' 
    ' /********************************************************************************/

#End Region

Imports System.Drawing
Imports System.Math
Imports System.Runtime.CompilerServices
Imports Microsoft.VisualBasic.CommandLine.Reflection
Imports Microsoft.VisualBasic.Language
Imports Microsoft.VisualBasic.Linq
Imports Microsoft.VisualBasic.Scripting.MetaData
Imports stdNum = System.Math

Namespace Imaging.Math2D

    <Package("GDI.Transform")> Public Module GeomTransform

        ''' <summary>
        ''' Returns a size value that its width equals height. 
        ''' </summary>
        ''' <param name="width%"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function SquareSize(width%) As Size
            Return New Size(width, width)
        End Function

        ''' <summary>
        ''' 这个方形区域的面积
        ''' </summary>
        ''' <param name="rect"></param>
        ''' <returns></returns>
        ''' 
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function Area(rect As Rectangle) As Double
            Return rect.Width * rect.Height
        End Function

        ''' <summary>
        ''' left,top -> right, top -> right, bottom -> left, bottom
        ''' </summary>
        ''' <param name="rect"></param>
        ''' <returns></returns>
        <Extension>
        Public Iterator Function ShapePoints(rect As RectangleF) As IEnumerable(Of PointF)
            With rect
                Yield New PointF(.Left, .Top)
                Yield New PointF(.Right, .Top)
                Yield New PointF(.Right, .Bottom)
                Yield New PointF(.Left, .Bottom)
            End With
        End Function

        ''' <summary>
        ''' Is target point in the target region?
        ''' </summary>
        ''' <param name="x"></param>
        ''' <param name="rect"></param>
        ''' <returns></returns>
        ''' 
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function InRegion(x As Point, rect As Rectangle) As Boolean
            Return New PointF(x.X, x.Y).InRegion(rect)
        End Function

        ''' <summary>
        ''' Is target point in the target region?
        ''' </summary>
        ''' <param name="x"></param>
        ''' <param name="rect"></param>
        ''' <returns></returns>
        <Extension>
        Public Function InRegion(x As PointF, rect As Rectangle) As Boolean
            If x.X < rect.Left OrElse x.X > rect.Right Then
                Return False
            End If
            If x.Y < rect.Top OrElse x.Y > rect.Bottom Then
                Return False
            End If

            Return True
        End Function

        ''' <summary>
        ''' Calculate the center location of the target sized region
        ''' </summary>
        ''' <param name="size"></param>
        ''' <returns></returns>
        ''' 
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function GetCenter(size As Size) As Point
            Return New Point(size.Width / 2, size.Height / 2)
        End Function

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function OffSet2D(rect As Rectangle, offset As Point) As Rectangle
            Return New Rectangle With {
                .Location = rect.Location.OffSet2D(offset),
                .Size = rect.Size
            }
        End Function

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function OffSet2D(rect As Rectangle, offset As PointF) As Rectangle
            Return New Rectangle With {
                .Location = rect.Location.OffSet2D(offset),
                .Size = rect.Size
            }
        End Function

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function OffSet2D(rect As Rectangle, offsetX!, offsetY!) As Rectangle
            Return New Rectangle With {
                .Location = rect.Location.OffSet2D(offsetX, offsetY),
                .Size = rect.Size
            }
        End Function

        ''' <summary>
        ''' 返回位移的新的点位置值
        ''' </summary>
        ''' <param name="p"></param>
        ''' <param name="x"></param>
        ''' <param name="y"></param>
        ''' <returns></returns>
        <ExportAPI("Offset")>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function OffSet2D(p As Point, x As Integer, y As Integer) As Point
            Return New Point(x + p.X, y + p.Y)
        End Function

        ''' <summary>
        ''' 返回位置的新的点位置值
        ''' </summary>
        ''' <param name="p"></param>
        ''' <param name="offset"></param>
        ''' <returns></returns>
        <ExportAPI("Offset")>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function OffSet2D(p As Point, offset As Point) As Point
            Return p.OffSet2D(offset.PointF)
        End Function

        ''' <summary>
        ''' 返回位置的新的点位置值
        ''' </summary>
        ''' <param name="p"></param>
        ''' <param name="offset"></param>
        ''' <returns></returns>
        <ExportAPI("Offset")>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function OffSet2D(p As Point, offset As PointF) As Point
            Return New Point(offset.X + p.X, offset.Y + p.Y)
        End Function

        ''' <summary>
        ''' Default is ``A + B``
        ''' </summary>
        ''' <param name="pt"></param>
        ''' <param name="offset"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function OffSet2D(pt As PointF, offset As PointF, Optional d% = 1) As PointF
            With pt
                Return New PointF(d * offset.X + .X, d * offset.Y + .Y)
            End With
        End Function

        ''' <summary>
        ''' <see cref="Point"/> <paramref name="pt"/> + offset
        ''' </summary>
        ''' <param name="pt"></param>
        ''' <param name="x!"></param>
        ''' <param name="y!"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function OffSet2D(pt As PointF, x!, y!) As PointF
            With pt
                Return New PointF(x + .X, y + .Y)
            End With
        End Function

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function Offsets(points As IEnumerable(Of Point), offset As PointF) As Point()
            Return points.Select(Function(pt) pt.OffSet2D(offset)).ToArray
        End Function

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function MirrorX(pt As PointF, rect As RectangleF) As PointF
            Return New PointF With {
                .X = rect.Right - (pt.X - rect.Left),
                .Y = pt.Y
            }
        End Function

        ''' <summary>
        ''' 
        ''' </summary>
        ''' <param name="pt">假设<paramref name="pt"/>是位于<paramref name="rect"/>内部的</param>
        ''' <param name="rect"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function MirrorY(pt As PointF, rect As RectangleF) As PointF
            Return New PointF With {
                .X = pt.X,
                .Y = rect.Bottom - (pt.Y - rect.Top)
            }
        End Function

        ''' <summary>
        ''' <see cref="Graphics.DrawEllipse(Pen, RectangleF)"/>
        ''' </summary>
        ''' <param name="center"></param>
        ''' <param name="r!"></param>
        ''' <returns></returns>
        <Extension>
        Public Function CircleRectangle(center As PointF, r!) As RectangleF
            Dim d = r * 2
            Return New RectangleF(center.OffSet2D(-r, -r), New SizeF(d, d))
        End Function

        <Extension>
        Public Function CenterAlign(rect As RectangleF, size As SizeF) As PointF
            Dim x! = (rect.Width - size.Width) / 2 + rect.Left
            Dim y! = (rect.Height - size.Height) / 2 + rect.Top
            Return New PointF(x, y)
        End Function

        ''' <summary>
        ''' 计算两个二维坐标的欧几里得距离
        ''' </summary>
        ''' <param name="x1#"></param>
        ''' <param name="y1#"></param>
        ''' <param name="x2#"></param>
        ''' <param name="y2#"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        Public Function Distance(x1#, y1#, x2#, y2#) As Double
            Return stdNum.Sqrt((x1 - x2) ^ 2 + (y1 - y2) ^ 2)
        End Function

        ''' <summary>
        ''' 计算两个坐标点之间的欧几里得距离
        ''' </summary>
        ''' <param name="a"></param>
        ''' <param name="b"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function Distance(a As Point, b As Point) As Double
            Return Distance(a.X, a.Y, b.X, b.Y)
        End Function

        ''' <summary>
        ''' 计算任意两点之间的欧几里得距离
        ''' </summary>
        ''' <param name="a"></param>
        ''' <param name="b"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function Distance(a As PointF, b As PointF) As Double
            Return Distance(a.X, a.Y, b.X, b.Y)
        End Function

        ''' <summary>
        ''' 计算每一个顶点到同一个锚点的距离值的集合
        ''' </summary>
        ''' <param name="points"></param>
        ''' <param name="anchor"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function Distance(points As IEnumerable(Of Point), anchor As Point) As Double()
            Return points _
                .Select(Function(pt) Distance(pt.X, pt.Y, anchor.X, anchor.Y)) _
                .ToArray
        End Function

        ''' <summary>
        ''' 函数返回角度
        ''' </summary>
        ''' <param name="p1"></param>
        ''' <param name="p2"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function CalculateAngle(p1 As PointF, p2 As PointF) As Double
            Dim xDiff As Single = p2.X - p1.X
            Dim yDiff As Single = p2.Y - p1.Y
            Dim a = stdNum.Atan2(yDiff, xDiff) * 180.0 / PI

            Return a
        End Function

        ''' <summary>
        ''' 函数返回角度
        ''' </summary>
        ''' <param name="p1"></param>
        ''' <param name="p2"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function CalculateAngle(p1 As Point, p2 As Point) As Double
            Return CalculateAngle(p1.PointF, p2.PointF)
        End Function

        ''' <summary>
        ''' 函数返回切线和X轴之间的夹角
        ''' </summary>
        ''' <param name="tangent"></param>
        ''' <returns>单位为角度</returns>
        ''' 
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function Angle(tangent As (A As PointF, B As PointF)) As Double
            Return CalculateAngle(tangent.A, tangent.B)
        End Function

        ''' <summary>
        ''' 获取目标多边形对象的边界结果，包括左上角的位置以及所占的矩形区域的大小
        ''' </summary>
        ''' <param name="points"></param>
        ''' <returns></returns>
        ''' 
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function GetBounds(points As IEnumerable(Of Point)) As RectangleF
            Return points.Select(Function(pt) pt.PointF).GetBounds
        End Function

        ''' <summary>
        ''' 获取目标多边形对象的边界结果，包括左上角的位置以及所占的矩形区域的大小
        ''' </summary>
        ''' <param name="points"></param>
        ''' <returns></returns>
        <Extension>
        Public Function GetBounds(points As IEnumerable(Of PointF)) As RectangleF
            Dim array = points.ToArray
            Dim xmin = array.Min(Function(pt) pt.X)
            Dim xmax = array.Max(Function(pt) pt.X)
            Dim ymin = array.Min(Function(pt) pt.Y)
            Dim ymax = array.Max(Function(pt) pt.Y)
            Dim topLeft As New PointF(xmin, ymin)
            Dim size As New SizeF(xmax - xmin, ymax - ymin)

            Return New RectangleF(topLeft, size)
        End Function

        ''' <summary>
        ''' Gets the center location of the region rectangle.
        ''' </summary>
        ''' <param name="rect"></param>
        ''' <returns></returns>
        <ExportAPI("Center")>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function Centre(rect As Rectangle) As Point
            Return New Point(rect.Left + rect.Width / 2, rect.Top + rect.Height / 2)
        End Function

        ''' <summary>
        ''' Resize the rectangle
        ''' </summary>
        ''' <param name="rect"></param>
        ''' <param name="factor"></param>
        ''' <returns></returns>
        <Extension> Public Function Scale(rect As RectangleF, factor As SizeF) As RectangleF
            Dim size = New SizeF(rect.Width * factor.Width, rect.Height * factor.Height)
            Dim delta = size - rect.Size
            Dim location As New PointF(rect.Left - delta.Width / 2, rect.Top - delta.Height / 2)
            Return New RectangleF(location, size)
        End Function

        ''' <summary>
        ''' 宽和高进行等比缩放
        ''' </summary>
        ''' <param name="size"></param>
        ''' <param name="factor#"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function Scale(size As SizeF, factor#) As SizeF
            Return New SizeF(size.Width * factor, size.Height * factor)
        End Function

        ''' <summary>
        ''' 宽和高进行等比缩放
        ''' </summary>
        ''' <param name="size"></param>
        ''' <param name="factor#"></param>
        ''' <returns></returns>
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function Scale(size As Size, factor#) As Size
            Return New Size(size.Width * factor, size.Height * factor)
        End Function

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function Scale(rect As Rectangle, factor As SizeF) As Rectangle
            With rect
                With New RectangleF(.Location.PointF, .Size.SizeF).Scale(factor)
                    Return New Rectangle(.Location.ToPoint, .Size.ToSize)
                End With
            End With
        End Function

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension> Public Function Scale(rect As Rectangle, factorX!, factorY!) As Rectangle
            With rect
                With New RectangleF(.Location.PointF, .Size.SizeF).Scale(New SizeF(factorX, factorY))
                    Return New Rectangle(.Location.ToPoint, .Size.ToSize)
                End With
            End With
        End Function

        ''' <summary>
        ''' 获取目标多边形对象的中心点的坐标位置
        ''' </summary>
        ''' <param name="shape"></param>
        ''' <returns></returns>
        <Extension>
        Public Function Centre(shape As IEnumerable(Of PointF)) As PointF
            Dim x As New List(Of Single)
            Dim y As New List(Of Single)

            Call shape.DoEach(Sub(pt)
                                  x += pt.X
                                  y += pt.Y
                              End Sub)

            Return New PointF(x.Average, y.Average)
        End Function

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function Centre(shape As IEnumerable(Of Point)) As PointF
            Return shape.PointF.Centre
        End Function

        ''' <summary>
        ''' Gets the center location of the region rectangle.
        ''' </summary>
        ''' <param name="rect"></param>
        ''' <returns></returns>
        ''' 
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <ExportAPI("Center")>
        <Extension> Public Function Centre(rect As RectangleF) As PointF
            Return New PointF(rect.Left + rect.Width / 2, rect.Top + rect.Height / 2)
        End Function

        ''' <summary>
        ''' 获取将目标多边形置于区域的中央位置的位置偏移量
        ''' </summary>
        ''' <param name="pts"></param>
        ''' <param name="frameSize"></param>
        ''' <returns></returns>
        ''' 
        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        <Extension>
        Public Function CentralOffset(pts As IEnumerable(Of Point), frameSize As Size) As PointF
            Return pts _
                .Select(Function(pt) pt.PointF) _
                .CentralOffset(frameSize.SizeF)
        End Function

        ''' <summary>
        ''' 获取将目标多边形置于区域的中央位置的位置偏移量
        ''' </summary>
        ''' <param name="pts"></param>
        ''' <param name="frameSize"></param>
        ''' <returns></returns>
        <Extension>
        Public Function CentralOffset(pts As IEnumerable(Of PointF), frameSize As SizeF) As PointF
            Dim xOffset!() = pts.Select(Function(x) x.X).ToArray
            Dim yOffset!() = pts.Select(Function(x) x.Y).ToArray
            Dim xo, yo As Single

            If xOffset.Length > 0 Then
                xo = xOffset.Min
            End If
            If yOffset.Length > 0 Then
                yo = yOffset.Min
            End If

            Dim size As New SizeF(xOffset.Max - xOffset.Min, yOffset.Max - yOffset.Min)
            Dim left! = (frameSize.Width - size.Width) / 2
            Dim top! = (frameSize.Height - size.Height) / 2

            Return New PointF(left - xo, top - yo)
        End Function
    End Module
End Namespace