API Docs for: 1.0.0
Show:

Kiwi.Geom.IntersectResult Class

Module: Geom
Parent Module: Kiwi

A Lightweight object to hold the results of an Intersection. Used in combination with the STATIC methods on the Intersect class.

Constructor

Kiwi.Geom.IntersectResult

()

Item Index

Methods

Properties

Methods

objType

() String public

The type of object this is.

Returns:

String:

setTo

(
  • x1
  • y1
  • [x2=0]
  • [y2=0]
  • [width=0]
  • [height=0]
)

Sets the coordinates of the points based on the parameters passed.

Parameters:

  • x1 Number
  • y1 Number
  • [x2=0] Number optional
  • [y2=0] Number optional
  • [width=0] Number optional
  • [height=0] Number optional

Properties

height

Number

[CURRENTLY NOT IN USE]

result

Boolean

Holds the result of an Intersection between two geometric items. TRUE means an Intersection did occur and FALSE means not.

Default: false

width

Number

[CURRENTLY NOT IN USE]

x

Number

Holds the x coordinate of the point in which the Intersection occured. Note: This is only set in the case the TWO geometric items are either Lines or Rays (Line like in function) and a Intersection occured.

x1

Number

[CURRENTLY NOT IN USE]

x2

Number

[CURRENTLY NOT IN USE]

y

Number

Holds the y coordinate of the point in which the Intersection occured. Note: This is only set in the case the TWO geometric items are either Lines or Rays (Line like in function) and a Intersection occured.

y1

Number

[CURRENTLY NOT IN USE]

y2

Number

[CURRENTLY NOT IN USE]