MBS Tools Plugin Documentation

MBS Tools Plugin Documentation Christian Schmitz September 6, 2021 2 0.1 Introduction This is the PDF version of the documentation for the Xojo Plug-in from Monkeybread Software Germany. Plugin part: MBS Tools Plugin 0.2 Content • 1 List of all topics 3 • 2 List of all classes 71 • 3 List of all modules 75 • 4 All items in this plugin 77 • 18 List of Questions in the FAQ 701 • 19 The FAQ 711 Chapter 1 List of Topics • 5 Clipper 113 – 5.1.1 class ClipperEngineMBS 113 ∗ 5.1.5 AddPath(path as ClipperPathMBS, PolyType as ClipperMBS.PolyType, Closed as Boolean) as Boolean 113 ∗ 5.1.6 AddPath(path as ClipperPathMBS, PolyType as Integer, Closed as Boolean) as Boolean 114 ∗ 5.1.7 AddPaths(paths as ClipperPathsMBS, PolyType as ClipperMBS.PolyType, Closed as Boolean) as Boolean 115 ∗ 5.1.8 AddPaths(paths as ClipperPathsMBS, PolyType as Integer, Closed as Boolean) as Boolean 115 ∗ 5.1.9 Clear 116 ∗ 5.1.10 Constructor(initOptions as integer = 0) 116 ∗ 5.1.11 Execute(clipType as ClipperMBS.ClipType, byref solution as ClipperPathsMBS, fill- Type as ClipperMBS.PolyFillType) as Boolean 116 ∗ 5.1.12 Execute(clipType as ClipperMBS.ClipType, byref solution as ClipperPathsMBS, subj- FillType as ClipperMBS.PolyFillType, clipFillType as ClipperMBS.PolyFillType) as Boolean 117 ∗ 5.1.13 Execute(clipType as ClipperMBS.ClipType, byref solution as ClipperPolyTreeMBS, fillType as ClipperMBS.PolyFillType) as Boolean 117 ∗ 5.1.14 Execute(clipType as ClipperMBS.ClipType, byref solution as ClipperPolyTreeMBS, subjFillType as ClipperMBS.PolyFillType, clipFillType as ClipperMBS.PolyFillType) as Boolean 118 ∗ 5.1.15 Execute(clipType as Integer, byref solution as ClipperPathsMBS, fillType as Integer) as Boolean 119 ∗ 5.1.16 Execute(clipType as Integer, byref solution as ClipperPathsMBS, subjFillType as In- teger, clipFillType as Integer) as Boolean 120 ∗ 5.1.17 Execute(clipType as Integer, byref solution as ClipperPolyTreeMBS, fillType as Inte- ger) as Boolean 121 3 4 CHAPTER 1. LIST OF TOPICS ∗ 5.1.18 Execute(clipType as Integer, byref solution as ClipperPolyTreeMBS, subjFillType as Integer, clipFillType as Integer) as Boolean 121 ∗ 5.1.19 GetBounds(byref left as integer, byref top as integer, byref right as integer, byref bottom as integer) 122 ∗ 5.1.21 BoundsBottom as Integer 122 ∗ 5.1.22 BoundsLeft as Integer 122 ∗ 5.1.23 BoundsRight as Integer 122 ∗ 5.1.24 BoundsTop as Integer 123 ∗ 5.1.25 Handle as Integer 123 ∗ 5.1.26 Owner as Variant 123 ∗ 5.1.27 PreserveCollinear as Boolean 123 ∗ 5.1.28 ReverseSolution as Boolean 124 ∗ 5.1.29 StrictlySimple as Boolean 124 ∗ 5.1.30 Tag as Variant 125 – 5.3.1 module ClipperMBS 127 ∗ 5.3.7 Area(path as ClipperPathMBS) as double 127 ∗ 5.3.8 CleanPolygon(InPoly as ClipperPathMBS, byref OutPolys as ClipperPathsMBS, distance as double = 1.415) 128 ∗ 5.3.9 CleanPolygon(Poly as ClipperPathMBS, distance as double = 1.415) 128 ∗ 5.3.10 CleanPolygons(InPoly as ClipperPathsMBS, byref OutPolys as ClipperPathsMBS, distance as double = 1.415) 129 ∗ 5.3.11 CleanPolygons(Poly as ClipperPathsMBS, distance as double = 1.415) 129 ∗ 5.3.12 ClosedPathsFromPolyTree(polytree as ClipperPolyTreeMBS, byref paths as Clipper- PathsMBS) 130 ∗ 5.3.13 EllipsePoints(Left as Double, Top as Double, Right as Double, Bottom as Double) as ClipperPathMBS 130 ∗ 5.3.14 MinkowskiDiff(poly1 as ClipperPathMBS, poly2 as ClipperPathMBS, byref solution as ClipperPathsMBS) 130 ∗ 5.3.15 MinkowskiSum(pattern as ClipperPathMBS, path as ClipperPathMBS, byref solution as ClipperPathsMBS, pathIsClosed as boolean) 131 ∗ 5.3.16 MinkowskiSum(pattern as ClipperPathMBS, paths as ClipperPathsMBS, byref solution as ClipperPathsMBS, pathIsClosed as boolean) 131 ∗ 5.3.17 OpenPathsFromPolyTree(polytree as ClipperPolyTreeMBS, byref paths as Clipper- PathsMBS) 131 ∗ 5.3.18 Orientation(path as ClipperPathMBS) as boolean 131 ∗ 5.3.19 PointInPolygon(path as ClipperPathMBS, pt as ClipperPointMBS) as Integer 132 ∗ 5.3.20 PolyTreeToPaths(polytree as ClipperPolyTreeMBS, byref paths as ClipperPathsMBS) 132 ∗ 5.3.21 ReversePath(path as ClipperPathMBS) 133 ∗ 5.3.22 ReversePaths(paths as ClipperPathsMBS) 133 ∗ 5.3.23 SimplifyPolygon(InPoly as ClipperPathMBS, byref OutPolys as ClipperPathsMBS, fillType as ClipperMBS.PolyFillType = ClipperMBS.PolyFillType.EvenOdd) 133 ∗ 5.3.24 SimplifyPolygon(InPoly as ClipperPathMBS, byref OutPolys as ClipperPathsMBS, fillType as Integer) 133 5 ∗ 5.3.25 SimplifyPolygons(InPolys as ClipperPathsMBS, byref OutPolys as ClipperPathsMBS, fillType as ClipperMBS.PolyFillType = ClipperMBS.PolyFillType.EvenOdd) 134 ∗ 5.3.26 SimplifyPolygons(InPolys as ClipperPathsMBS, byref OutPolys as ClipperPathsMBS, fillType as Integer) 134 ∗ 5.3.27 SimplifyPolygons(Polys as ClipperPathsMBS, fillType as ClipperMBS.PolyFillType = ClipperMBS.PolyFillType.EvenOdd) 135 ∗ 5.3.28 SimplifyPolygons(Polys as ClipperPathsMBS, fillType as Integer) 136 ∗ 5.3.29 TranslatePath(path as ClipperPathMBS, delta as ClipperPointMBS) as ClipperPathMBS 136 ∗ 5.3.30 TranslatePath(path as ClipperPathMBS, x as Int64, y as Int64) as ClipperPathMBS 136 ∗ 5.3.31 Version as string 137 ∗ 5.3.33 hiRange = & h3FFFFFFFFFFFFFFF 137 ∗ 5.3.34 loRange = & h3FFFFFFF 137 – 5.4.1 class ClipperOffsetMBS 138 ∗ 5.4.5 AddPath(path as ClipperPathMBS, joinType as ClipperMBS.JoinType, endType as ClipperMBS.EndType) 138 ∗ 5.4.6 AddPath(path as ClipperPathMBS, joinType as Integer, endType as Integer) 139 ∗ 5.4.7 AddPaths(paths as ClipperPathsMBS, joinType as ClipperMBS.JoinType, endType as ClipperMBS.EndType) 139 ∗ 5.4.8 AddPaths(paths as ClipperPathsMBS, joinType as Integer, endType as Integer) 139 ∗ 5.4.9 Clear 140 ∗ 5.4.10 Constructor(miterLimit as double = 2.0, roundPrecision as double = 0.25) 140 ∗ 5.4.11 Execute(byref Paths as ClipperPathsMBS, delta as double) 140 ∗ 5.4.12 Execute(byref PolyTree as ClipperPolyTreeMBS, delta as double) 140 ∗ 5.4.14 ArcTolerance as Double 141 ∗ 5.4.15 Handle as Integer 142 ∗ 5.4.16 MiterLimit as Double 142 ∗ 5.4.17 Owner as Variant 142 ∗ 5.4.18 Tag as Variant 142 – 5.5.1 class ClipperPathMBS 144 ∗ 5.5.3 Append(item as ClipperPointMBS) 144 ∗ 5.5.4 Append(X as Int64, Y as Int64) 144 ∗ 5.5.5 Area as double 144 ∗ 5.5.6 Clear 145 ∗ 5.5.7 Constructor 145 ∗ 5.5.8 Constructor(otherPath as ClipperPathMBS) 145 ∗ 5.5.9 Constructor(points() as ClipperPointMBS) 145 ∗ 5.5.10 Equal(otherPath as ClipperPathMBS) as boolean 146 ∗ 5.5.11 Insert(Index as Integer, item as ClipperPointMBS) 146 ∗ 5.5.12 Orientation as boolean 146 ∗ 5.5.13 PointInPolygon(pt as ClipperPointMBS) as Integer 147 6 CHAPTER 1. LIST OF TOPICS ∗ 5.5.14 Remove(index as integer) 148 ∗ 5.5.15 ReversePath 148 ∗ 5.5.16 TranslatePath(delta as ClipperPointMBS) as ClipperPathMBS 148 ∗ 5.5.17 TranslatePath(x as Int64, y as Int64) as ClipperPathMBS 148 ∗ 5.5.18 Values as ClipperPointMBS() 148 ∗ 5.5.19 ValuesToArray(dest() as ClipperPointMBS) 149 ∗ 5.5.21 Count as Integer 149 ∗ 5.5.22 Empty as Boolean 149 ∗ 5.5.23 Handle as Integer 149 ∗ 5.5.24 Owner as Variant 149 ∗ 5.5.25 Tag as Variant 150 ∗ 5.5.26 Value(Index as Integer) as ClipperPointMBS 150 – 5.6.1 class ClipperPathsMBS 151 ∗ 5.6.3 Append(item as ClipperPathMBS) 151 ∗ 5.6.4 Clear 151 ∗ 5.6.5 Constructor 151 ∗ 5.6.6 Constructor(otherPaths as ClipperPathsMBS) 152 ∗ 5.6.7 Equal(otherPaths as ClipperPathsMBS) as boolean 152 ∗ 5.6.8 Insert(Index as Integer, item as ClipperPathMBS) 152 ∗ 5.6.9 Remove(index as integer) 152 ∗ 5.6.10 Reverse 152 ∗ 5.6.11 Values as ClipperPathMBS() 152 ∗ 5.6.12 ValuesToArray(dest() as ClipperPathMBS) 153 ∗ 5.6.14 Count as Integer 153 ∗ 5.6.15 Empty as Boolean 153 ∗ 5.6.16 Handle as Integer 153 ∗ 5.6.17 Owner as Variant 153 ∗ 5.6.18 Tag as Variant 154 ∗ 5.6.19 Value(Index as Integer) as ClipperPathMBS 154 – 5.7.1 class ClipperPointMBS 155 ∗ 5.7.3 Constructor(x as Int64 = 0, y as Int64 = 0) 155 ∗ 5.7.4 Equal(other as ClipperPointMBS) as boolean 155 ∗ 5.7.5 Point(x as Int64 = 0, y as Int64 = 0) as ClipperPointMBS 155 ∗ 5.7.7 X as Int64 155 ∗ 5.7.8 Y as Int64 156 – 5.8.1 class ClipperPolyNodeMBS 157 ∗ 5.8.3 Constructor 157 ∗ 5.8.5 ChildCount as Integer 157 ∗ 5.8.6 Childs as ClipperPolyNodesMBS 157 ∗ 5.8.7 Contour as ClipperPathMBS 158 ∗ 5.8.8 Handle as Integer 158 7 ∗ 5.8.9 IsHole as Boolean 158 ∗ 5.8.10 IsOpen as Boolean 158 ∗ 5.8.11 NextNode as ClipperPolyNodeMBS 159 ∗ 5.8.12 Owner as Variant 159 ∗ 5.8.13 ParentNode as ClipperPolyNodeMBS 159 ∗ 5.8.14 Tag as Variant 159 – 5.9.1 class ClipperPolyNodesMBS 160 ∗ 5.9.3 Append(item as ClipperPolyNodeMBS) 160 ∗ 5.9.4 Clear 160 ∗ 5.9.5 Constructor 160 ∗ 5.9.6 Constructor(otherPolyNodes as ClipperPolyNodesMBS) 160 ∗ 5.9.7 Equal(otherPolyNodes as ClipperPolyNodesMBS) as boolean 161 ∗ 5.9.8 Insert(Index as Integer, item as ClipperPolyNodeMBS) 161 ∗ 5.9.9 Remove(index as integer) 161 ∗ 5.9.10 Values as ClipperPolyNodeMBS() 161 ∗ 5.9.12 Count as Integer 161 ∗ 5.9.13 Empty as Boolean 161 ∗ 5.9.14 Handle as Integer 162 ∗ 5.9.15 Owner as Variant 162 ∗ 5.9.16 Tag as Variant 162 ∗ 5.9.17 Value(Index as Integer) as ClipperPolyNodeMBS 162 – 5.10.1 class ClipperPolyTreeMBS 163 ∗ 5.10.3 Clear 163 ∗ 5.10.4 Constructor 164 ∗ 5.10.5 Constructor(otherPolyNodes as ClipperPolyTreeMBS) 164 ∗ 5.10.7 First as ClipperPolyNodeMBS 164 ∗ 5.10.8 Total as Integer 164 8 CHAPTER 1. LIST OF TOPICS • 6 CUPS 165 – 6.1.1 class CUPSDestinationMBS 165 ∗ 6.1.5 Options as CUPSOptionMBS() 166 ∗ 6.1.7 Instance as String 166 ∗ 6.1.8 isDefault as Boolean 166 ∗ 6.1.9 Name as String 166 – 6.3.1 class CUPSJobMBS 169 ∗ 6.3.3 CompletedDateTime as DateTime 170 ∗ 6.3.4 CompletedTime as Date 170 ∗ 6.3.5 CreationDateTime as DateTime 170 ∗ 6.3.6 CreationTime as Date 171 ∗ 6.3.7

Load more