diff --git a/Doc/sphinx/scriptref/tpa.rst b/Doc/sphinx/scriptref/tpa.rst index 271ee2e..e3e755c 100644 --- a/Doc/sphinx/scriptref/tpa.rst +++ b/Doc/sphinx/scriptref/tpa.rst @@ -11,6 +11,8 @@ Quicksort procedure Quicksort(var Arr : TIntegerArray); +Sorts a TIntegerArray using the Quicksort algorithm + tSwap ----- @@ -19,6 +21,8 @@ tSwap procedure tSwap(var a, b: TPoint); +Swaps the values of a and b around + tpaSwap ------- @@ -27,6 +31,8 @@ tpaSwap procedure tpaSwap(var a, b: TPointArray); +Swaps the values of a and b around + SwapE ----- @@ -35,6 +41,8 @@ SwapE procedure SwapE(var a, b: Extended); +Swaps the values of a and b around + RAaSTPAEx --------- @@ -43,6 +51,7 @@ RAaSTPAEx procedure RAaSTPAEx(var a: TPointArray; const w, h: Integer); +Leaves one point per box with side lengths W and H to the TPA RAaSTPA ------- @@ -51,6 +60,8 @@ RAaSTPA procedure RAaSTPA(var a: TPointArray; const Dist: Integer); +Leaves one point per box with the side length Dist + NearbyPointInArrayEx -------------------- @@ -59,6 +70,8 @@ NearbyPointInArrayEx function NearbyPointInArrayEx(const P: TPoint; w, h:Integer;const a: TPointArray): Boolean; +Returns true if the point P is near a point in the TPA a with the + NearbyPointInArray ------------------ @@ -67,6 +80,8 @@ NearbyPointInArray function NearbyPointInArray(const P: TPoint; Dist:Integer;const a: TPointArray): Boolean; +Returns true if the point P is near a point in the TPA a with the + QuickTPASort ------------ @@ -91,6 +106,8 @@ SortTPAFrom procedure SortTPAFrom(var a: TPointArray; const From: TPoint); +Sorts the TPA a from the TPoint From + SortATPAFrom ------------ @@ -99,6 +116,8 @@ SortATPAFrom procedure SortATPAFrom(var a: T2DPointArray; const From: TPoint); +Sorts the T2DPointArray a from the TPoint From + SortATPAFromFirstPoint ---------------------- @@ -115,6 +134,8 @@ InvertTPA procedure InvertTPA(var a: TPointArray); +Reverses the TPA + InvertATPA ---------- @@ -123,6 +144,8 @@ InvertATPA procedure InvertATPA(var a: T2DPointArray); +Reverses the T2dPointArray + MiddleTPAEx ----------- @@ -131,6 +154,8 @@ MiddleTPAEx function MiddleTPAEx(const TPA: TPointArray; var x, y: Integer): Boolean; +Stores the middle point from the TPA in x and y + MiddleTPA --------- @@ -139,6 +164,8 @@ MiddleTPA function MiddleTPA(const tpa: TPointArray): TPoint; +Returns the middle TPA in the result + SortATPASize ------------ @@ -147,6 +174,8 @@ SortATPASize procedure SortATPASize(var a: T2DPointArray; const BigFirst: Boolean); +Sorts the T2dPointArray from largest to smallest if BigFirst is true or smallest to largest if BigFirst is false + SortATPAFromSize ---------------- @@ -155,6 +184,8 @@ SortATPAFromSize procedure SortATPAFromSize(var a: T2DPointArray; const Size: Integer; CloseFirst: Boolean); +Sorts the T2DPointArray from Size by the closest first if CloseFirst is true + InIntArrayEx ------------ @@ -163,6 +194,8 @@ InIntArrayEx function InIntArrayEx(const a: TIntegerArray; var Where: Integer; const Number: Integer): Boolean; +Returns true if Number was found in the TIntegerArray a and returns its location in Where + InIntArray ---------- @@ -171,6 +204,8 @@ InIntArray function InIntArray(const a: TIntegerArray; Number: Integer): Boolean; +Returns true if Number is found in the TintegerArray a + ClearSameIntegers ----------------- @@ -179,6 +214,8 @@ ClearSameIntegers procedure ClearSameIntegers(var a: TIntegerArray); +Deletes the indexes in the TintegerArray a which are duplicated + ClearSameIntegersAndTPA ----------------------- @@ -187,6 +224,8 @@ ClearSameIntegersAndTPA procedure ClearSameIntegersAndTPA(var a: TIntegerArray; var p: TPointArray); +Deletes the indexes in the TIntegerArray a and TPointArray p which are duplicated + SplitTPAEx ---------- @@ -195,6 +234,8 @@ SplitTPAEx function SplitTPAEx(const arr: TPointArray; w, h: Integer): T2DPointArray; +Splits the points with max X and Y distances W and H to their + SplitTPA -------- @@ -203,6 +244,8 @@ SplitTPA function SplitTPA(const arr: TPointArray; Dist: Integer): T2DPointArray; +Splits the points with max distance Dist to their own TPointArrays + FloodFillTPA ------------ @@ -219,6 +262,9 @@ FilterPointsPie procedure FilterPointsPie(var Points: TPointArray; const SD, ED, MinR, MaxR: Extended; Mx, My: Integer); +Removes the points that are in the TPointArray Points that are not within the the degrees SD (Strat Degrees) and + ED (End Degrees) and the radius' MinR (Min Radius) and MaxR (Max Radius) from the origin Mx and My + FilterPointsLine ---------------- @@ -227,6 +273,8 @@ FilterPointsLine procedure FilterPointsLine(var Points: TPointArray; Radial: Extended; Radius, MX, MY: Integer); +Returns the result in the TPointArray Points. Returns the points from the TPointArray Points that are on the line Radial from the center mx, my that is with the radius Radius + FilterPointsDist ---------------- @@ -235,6 +283,9 @@ FilterPointsDist procedure FilterPointsDist(var Points: TPointArray; const MinDist, MaxDist: Extended; Mx, My: Integer); +Removes the points from the TPointArray Points that are not within the radius MinDist (Min Distance) and MaxDist + from the origin Mx and My + GetATPABounds ------------- @@ -243,6 +294,8 @@ GetATPABounds function GetATPABounds(const ATPA: T2DPointArray): TBox; +Returns the boundaries of the T2DPointArray ATPA as a TBox + GetTPABounds ------------ @@ -251,6 +304,8 @@ GetTPABounds function GetTPABounds(const TPA: TPointArray): TBox; +Returns the boundaries of the TPointArray TPA as a TBox + FindTPAinTPA ------------ @@ -259,6 +314,8 @@ FindTPAinTPA function FindTPAinTPA(const SearchTPA, TotalTPA: TPointArray; var Matches: TPointArray): Boolean; +Looks for the TPoints from SearchTPA inside TotalTPA and stores the matches inside the TPointArray Matches + GetSamePointsATPA ----------------- @@ -267,6 +324,8 @@ GetSamePointsATPA function GetSamePointsATPA(const ATPA : T2DPointArray; var Matches : TPointArray) : boolean; +Finds duplicate Points inside the T2DPointArray ATPA and stores the results inside the TPointArray Matches + FindTextTPAinTPA ---------------- @@ -275,6 +334,8 @@ FindTextTPAinTPA function FindTextTPAinTPA(Height : integer;const SearchTPA, TotalTPA: TPointArray; var Matches: TPointArray): Boolean; +Looks for the TPoints from SearchTPA inside TotalTPA with a maximum y distance of Height and stores the matches inside the TPointArray Matches + SortCircleWise -------------- @@ -283,6 +344,8 @@ SortCircleWise procedure SortCircleWise(var tpa: TPointArray; const cx, cy, StartDegree: Integer; SortUp, ClockWise: Boolean); +Sorts the TPointArray tpa from the point cx, cy if Sortup is true. Starting at StartDegree going clockwise if Clockwise is True + LinearSort ---------- @@ -291,6 +354,8 @@ LinearSort procedure LinearSort(var tpa: TPointArray; cx, cy, sd: Integer; SortUp: Boolean); +Sorts the TPointArray tpa from cx, cy if Sortup is true on the degree angle sd + RotatePoint ----------- @@ -299,6 +364,8 @@ RotatePoint function RotatePoint(Const p: TPoint; angle, mx, my: Extended): TPoint; +Rotates the TPoint p around the center mx, my with the angle + ChangeDistPT ------------ @@ -307,6 +374,8 @@ ChangeDistPT function ChangeDistPT(const PT : TPoint; mx,my : integer; newdist : extended) : TPoint; +Returns a TPoint with the distance newdist from the point mx, my based on the position of the TPoint TP + ChangeDistTPA ------------- @@ -315,6 +384,8 @@ ChangeDistTPA function ChangeDistTPA(var TPA : TPointArray; mx,my : integer; newdist : extended) : boolean; +Returns the result in the TPointArray TPA with the distance newdist from mx, my based on the current position TPA + FindGapsTPA ----------- @@ -323,6 +394,8 @@ FindGapsTPA function FindGapsTPA(const TPA: TPointArray; MinPixels: Integer): T2DPointArray; +Finds the possible gaps in the TPointArray TPA and results the gaps as a T2DPointArray. Considers as a gap if the gap length is >= MinPixels + RemoveDistTPointArray --------------------- @@ -331,6 +404,8 @@ RemoveDistTPointArray function RemoveDistTPointArray(x, y, dist: Integer;const ThePoints: TPointArray; RemoveHigher: Boolean): TPointArray; +Finds the possible gaps in the TPointArray TPA and removes the gaps. Considers as a gap if the gap length is >= MinPixels + CombineTPA ---------- @@ -339,6 +414,8 @@ CombineTPA function CombineTPA(const Ar1, Ar2: TPointArray): TPointArray; +Attaches the TPointArray Ar2 onto the end of Ar1 and returns it as the result + ReArrangeandShortenArrayEx -------------------------- @@ -347,6 +424,8 @@ ReArrangeandShortenArrayEx function ReArrangeandShortenArrayEx(const a: TPointArray; w, h: Integer): TPointArray; +Results the TPointArray a with one point per box with side lengths W and H left + ReArrangeandShortenArray ------------------------ @@ -355,6 +434,8 @@ ReArrangeandShortenArray function ReArrangeandShortenArray(const a: TPointArray; Dist: Integer): TPointArray; +Results the TPointArray a with one point per box with side length Dist left + TPAtoATPAEx ----------- @@ -363,6 +444,8 @@ TPAtoATPAEx function TPAtoATPAEx(const TPA: TPointArray; w, h: Integer): T2DPointArray; +Splits the TPA to boxes with sidelengths W and H and results them as a T2DPointArray + TPAtoATPA --------- @@ -371,6 +454,8 @@ TPAtoATPA function TPAtoATPA(const TPA: TPointArray; Dist: Integer): T2DPointArray; +Splits the TPA to boxes with sidelength Dist and results them as a T2DPointArray + CombineIntArray --------------- @@ -379,6 +464,8 @@ CombineIntArray function CombineIntArray(const Ar1, Ar2: TIntegerArray): TIntegerArray; +Attaches the TIntegerArray Ar2 onto the end of Ar1 and returns it as the result + MergeATPA --------- @@ -387,6 +474,8 @@ MergeATPA function MergeATPA(const ATPA : T2DPointArray) : TPointArray; +Combines all the TPointArrays from the T2DPointArray ATPA into the result + AppendTPA --------- @@ -395,6 +484,8 @@ AppendTPA procedure AppendTPA(var TPA: TPointArray; const ToAppend: TPointArray); +Attaches the TPointArray ToAppend onto the end of TPA + TPAFromBox ---------- @@ -403,6 +494,8 @@ TPAFromBox function TPAFromBox(const Box : TBox) : TPointArray; +Create a TPointArray from the top left and the bottom right of the TBox Box + RotatePoints ------------ @@ -411,6 +504,8 @@ RotatePoints function RotatePoints(Const P: TPointArray; A, cx, cy: Extended): TPointArray ; +Rotates the TPointArray P around the center cx, cy with the angle a + FindTPAEdges ------------ @@ -419,6 +514,8 @@ FindTPAEdges function FindTPAEdges(const p: TPointArray): TPointArray; +Returns a TPointArray of the edge points of the TPointArray p + ClearTPAFromTPA --------------- @@ -427,6 +524,8 @@ ClearTPAFromTPA function ClearTPAFromTPA(const arP, ClearPoints: TPointArray): TPointArray; +Removes the points in TPointArray ClearPoints from arP + ReturnPointsNotInTPA -------------------- @@ -435,6 +534,8 @@ ReturnPointsNotInTPA function ReturnPointsNotInTPA(Const TotalTPA: TPointArray; const Box: TBox): TPointArray; +All the points from the TPointArray TotalTPA that are not in the TBox Box are returned in the TPointArray Res + PointInTPA ---------- @@ -443,6 +544,8 @@ PointInTPA function PointInTPA(p: TPoint;const arP: TPointArray): Boolean; +Returns true if the TPoint p is found in the TPointArray arP + ClearDoubleTPA -------------- @@ -451,6 +554,8 @@ ClearDoubleTPA procedure ClearDoubleTPA(var TPA: TPointArray); +Deletes duplicate TPAs int he TPointArray TPA + TPACountSort ------------ @@ -475,6 +580,8 @@ InvertTIA procedure InvertTIA(var tI: TIntegerArray); +Reverses the TIntegerArray tI + SumIntegerArray --------------- @@ -483,6 +590,8 @@ SumIntegerArray function SumIntegerArray(const Ints : TIntegerArray): Integer; +Retuns the sum of all the integers in the TIntegerArray Ints + AverageTIA ---------- @@ -491,6 +600,8 @@ AverageTIA function AverageTIA(const tI: TIntegerArray): Integer; +Gives an average of the sum of the integers in the TIntegerArray tI + AverageExtended --------------- @@ -499,6 +610,8 @@ AverageExtended function AverageExtended(const tE: TExtendedArray): Extended; +Gives an average of the sum of the extendeds in the TExtendedArray tI + SplitTPAExWrap -------------- @@ -507,6 +620,8 @@ SplitTPAExWrap procedure SplitTPAExWrap(const arr: TPointArray; w, h: Integer; var res : T2DPointArray); +Splits the points with max X and Y distances W and H to their and returns the result in the T2DPointArray Res + SplitTPAWrap ------------ @@ -515,6 +630,8 @@ SplitTPAWrap procedure SplitTPAWrap(const arr: TPointArray; Dist: Integer; var res: T2DPointArray); +Splits the points with max distance Dist to their own TPointArrays and returns the result in the T2DPointArray Res + FindGapsTPAWrap --------------- @@ -523,6 +640,8 @@ FindGapsTPAWrap procedure FindGapsTPAWrap(const TPA: TPointArray; MinPixels: Integer; var Res : T2DPointArray); +Finds the possible gaps in the TPointArray TPA and the result is returned in the T2DPointArray Res. Considers as a gap if the gap length is >= MinPixels + RemoveDistTPointArrayWrap ------------------------- @@ -531,6 +650,8 @@ RemoveDistTPointArrayWrap procedure RemoveDistTPointArrayWrap(x, y, dist: Integer;const ThePoints: TPointArray; RemoveHigher: Boolean; var Res : TPointArray); +Finds the possible gaps in the TPointArray TPA and removes the gaps. Considers as a gap if the gap length is >= MinPixels and returns the result in the TPointArray Res + CombineTPAWrap -------------- @@ -539,6 +660,8 @@ CombineTPAWrap procedure CombineTPAWrap(const Ar1, Ar2: TPointArray; var Res : TPointArray); +Attaches the TPointArray Ar2 onto the end of Ar1 and returns the result in the TPointArray Res + ReArrangeandShortenArrayExWrap ------------------------------ @@ -547,6 +670,8 @@ ReArrangeandShortenArrayExWrap procedure ReArrangeandShortenArrayExWrap(const a: TPointArray; w, h: Integer; var Res : TPointArray); +Results the TPointArray a with one point per box with side lengths W and H left and puts the result in Res + ReArrangeandShortenArrayWrap ---------------------------- @@ -555,6 +680,8 @@ ReArrangeandShortenArrayWrap procedure ReArrangeandShortenArrayWrap(const a: TPointArray; Dist: Integer; var Res : TPointArray); +Results the TPointArray a with one point per box with side length Dist left and puts the result in Res + TPAtoATPAExWrap --------------- @@ -563,6 +690,8 @@ TPAtoATPAExWrap procedure TPAtoATPAExWrap(const TPA: TPointArray; w, h: Integer; var Res : T2DPointArray); +Splits the TPA to boxes with sidelengths W and H and results them as a T2DPointArray in Res + TPAtoATPAWrap ------------- @@ -571,6 +700,8 @@ TPAtoATPAWrap procedure TPAtoATPAWrap(const TPA: TPointArray; Dist: Integer; var Res : T2DPointArray); +Splits the TPA to boxes with sidelength Dist and results them as a T2DPointArray in Res + CombineIntArrayWrap ------------------- @@ -579,6 +710,8 @@ CombineIntArrayWrap procedure CombineIntArrayWrap(const Ar1, Ar2: TIntegerArray; var Res : TIntegerArray); +Attaches the TIntegerArray Ar2 onto the end of Ar1 and returns it in the TIntegerArray Res + ReturnPointsNotInTPAWrap ------------------------ @@ -587,6 +720,8 @@ ReturnPointsNotInTPAWrap procedure ReturnPointsNotInTPAWrap(Const TotalTPA: TPointArray; const Box: TBox; var Res : TPointArray); +All the points from the TPointArray TotalTPA that are not in the TBox Box are returned in the TPointArray Res + MergeATPAWrap ------------- @@ -595,6 +730,8 @@ MergeATPAWrap procedure MergeATPAWrap(const ATPA : T2DPointArray; var Res: TPointArray); +Combines all the TPointArrays from the T2DPointArray ATPA into the TPointArray Res + TPAFromBoxWrap -------------- @@ -603,6 +740,8 @@ TPAFromBoxWrap procedure TPAFromBoxWrap(const Box : TBox; var Res : TPointArray); +Create a TPointArray from the top left and the bottom right of the TBox Box and returns the result in Res + RotatePointsWrap ---------------- @@ -611,6 +750,8 @@ RotatePointsWrap procedure RotatePointsWrap(Const P: TPointArray; A, cx, cy: Extended; var Res : TPointArray); +Rotates the TPointArray P around the center cx, cy with the angle a and returns the result in Res + FindTPAEdgesWrap ---------------- @@ -619,6 +760,8 @@ FindTPAEdgesWrap procedure FindTPAEdgesWrap(const p: TPointArray; var Res : TPointArray); +Returns a TPointArray of the edge points of the TPointArray p and returns the result in the TPointArray Res + ClearTPAFromTPAWrap ------------------- @@ -627,6 +770,8 @@ ClearTPAFromTPAWrap procedure ClearTPAFromTPAWrap(const arP, ClearPoints: TPointArray; var Res : TPointArray); +Removes the points in TPointArray ClearPoints from arP and returns the results in Res + SameTPA ------- @@ -635,6 +780,8 @@ SameTPA function SameTPA(const aTPA, bTPA: TPointArray): Boolean; +Returns true if the TPointArray aTPA is the same as bTPA + TPAInATPA --------- @@ -643,6 +790,8 @@ TPAInATPA function TPAInATPA(const TPA: TPointArray;const InATPA: T2DPointArray; var Index: LongInt): Boolean; +Returns true if the TPointArray TPA is found in the T2DPointArray InATPA and stores the index in Index + OffsetTPA --------- @@ -651,6 +800,8 @@ OffsetTPA procedure OffsetTPA(var TPA : TPointArray; const Offset : TPoint); +Offsets all the TPAs int the TPointArray TPA but the TPoint Offset + OffsetATPA ---------- @@ -659,6 +810,8 @@ OffsetATPA procedure OffsetATPA(var ATPA : T2DPointArray; const Offset : TPoint); +Offsets all the TPAs int the T2DPointArray ATPA but the TPoint Offset + CopyTPA ------- @@ -667,6 +820,8 @@ CopyTPA function CopyTPA(const TPA : TPointArray) : TPointArray; +Returns the TPointArray TPA + CopyATPA -------- @@ -675,4 +830,5 @@ CopyATPA function CopyATPA(const ATPA : T2DPointArray) : T2DPointArray; +Returns the T2DPointArray ATPA