Cabal Common Library Doc 2DCollision - Revision history

Svengali: formatting

2013-09-15T23:17:00Z

formatting

Svengali: Preparation for v1.6

2012-06-14T20:23:31Z

Preparation for v1.6

Svengali at 22:45, 29 May 2012

2012-05-29T22:45:15Z

Svengali: Profiling added

2012-03-16T11:29:19Z

Profiling added

Svengali: New doc for CCL1.5.1

2012-03-15T23:59:25Z

New doc for CCL1.5.1

New page

== Overview ==
This is the main class for the 2D helpers with its members. Scripts can instantiate a copy, e.g.
{{CodeEx|codeex=this.myHelper = new Cabal_Common_2DCollision();}}

== Properties ==
=== internalVersion ===
Number. Property to give OXPs a chance to check the required lib min. version easily. This number will be raised with every release.
{{CodeEx|codeex=var a = this.myHelper.internalVersion;
a -> {{CCL_Int}}}}

== Methods ==
All methods are ignoring the z-coordinate .-)

=== boundingBox() ===
{{CodeEx|codeex=boundingBox: function( minmax, pos )}}
Checks if point is inside the bounding box.

'''Parameters:'''
:;minmax:Array. 4 positions in a.x,a.y,b.x,b.y
:;pos:Vector. Position to be checked.

'''Returns:'''
:;inside:Boolean. True if inside.

=== pointInPoly() ===
{{CodeEx|codeex=pointInPoly: function( nvert, vertx, verty, pos, con )}}
Checks if a point is inside a polygon.

'''Parameters:'''
:;nvert:Number of vertices in the polygon.
:;vertx, verty:Arrays containing the x- and y-coordinates of the polygon's vertices.
:;pos:Vector. x- and y-coordinate of the test point.
:;con:Boolean. Concave shapes may need to set it.

'''Returns:'''
:;inside:Boolean. True if inside.

=== pointOnLine() ===
{{CodeEx|codeex=pointOnLine: function( pa, pb, pos )}}
Checks if point is on a specified line with a tolerance of 0.4.
This method has a problem with vertical lines. If it needs to be more accurate use .pointOnLineB().

'''Parameters:'''
:;pa:Vector. Starting point of the line.
:;pb:Vector. End point of the line.
:;pos:Vector. Position to be checked.

'''Returns:'''
:;online:Boolean. True if on line (within tolerance).

=== pointOnLineB() ===
{{CodeEx|codeex=pointOnLineB: function( p1,p2,p3,tol )}}
Checks if point is on a specified line.
Based on Paul Bourkes explanation ([http://paulbourke.net/geometry/pointline/]).

'''Parameters:'''
:;p1:Vector. Starting point of the line.
:;p2:Vector. End point of the line.
:;p3:Vector. Position to be checked.
:;tol:Number. Tolerance. Default 0.01.

'''Returns:'''
:;online:Boolean. True if on line (within tolerance).

[[Category:OXPDoc]]

@@ Line 1: / Line 1: @@
 == Overview ==
 This is the main class for the 2D helpers with its members and part of the [[Cabal_Common_Library]].  Scripts can instantiate a copy, e.g.
-{{CodeEx|codeex=this.myHelper = new worldScripts.Cabal_Common_Functions.Cabal_Common_2DCollision();}}
+  this.myHelper = new worldScripts.Cabal_Common_Functions.Cabal_Common_2DCollision();
 Versions before v1.6 have used <code>this.myHelper = new Cabal_Common_2DCollision();</code>
 == Properties ==
 === internalVersion ===
 Number. Property to give OXPs a chance to check the required lib min. version easily. This number will be raised with every release.
-{{CodeEx|codeex=var a = this.myHelper.internalVersion;
+  var a = this.myHelper.internalVersion;
-a -> {{CCL_Int}}}}
 == Methods ==

@@ Line 14: / Line 14: @@
 === boundingBox() ===
 {{CodeEx|codeex=boundingBox: function( minmax, pos )}}
 Checks if point is inside the bounding box.
@@ Line 26: / Line 27: @@
 === pointInPoly() ===
 {{CodeEx|codeex=pointInPoly: function( nvert, vertx, verty, pos, con )}}
 Checks if a point is inside a polygon.
@@ Line 40: / Line 42: @@
 === pointOnLine() ===
 {{CodeEx|codeex=pointOnLine: function( pa, pb, pos )}}
 Checks if point is on a specified line with a tolerance of 0.4.
 This method has a problem with vertical lines. If it needs to be more accurate use .pointOnLineB().
@@ Line 54: / Line 57: @@
 === pointOnLineB() ===
 {{CodeEx|codeex=pointOnLineB: function( p1,p2,p3,tol )}}
 Checks if point is on a specified line.
 Based on Paul Bourkes explanation ([http://paulbourke.net/geometry/pointline/]).