abeLayerTouch

abeLayerTouch(
o_abeLayer1 
o_abeLayer2 
o_abeOutputLayer 
[ ?queue g_queue ] 
[ ?includeCorners g_includeCorners ]
[ ?islandBased g_islandBased ]
)
=> t / nil

Description

Adds the ABE layer1 shapes that touch (completely overlap, partially overlap, or abut) an ABE layer2 shape to the ABE output layer.

Arguments

o_abeLayer1	ID of ABE layer1.
o_abeLayer2	ID of ABE layer2.
o_abeOutputLayer	ID of the ABE output layer.
?queue g_queue	Adds the function to the queue if set to t, rather than running it immediately. Functions in the queue are not run until abeRunQueue is issued.
?includeCorners g_includeCorners
	Includes shapes that touch only at corners. The default is nil, which means corner-only touching shapes are not included.
?islandBased g_islandBased
	Includes all the full islands that are touching the ABE layer1.

Values Returned

t	The function was run or queued successfully.
nil	The function was not successful because ABE is not initialized or there was an argument error.

Examples

Adds shapes from the a1 ABE layer that completely overlap, partially overlap, or abut an a2 ABE layer shape to the result ABE layer.

abeLayerTouch( a1 a2 result )

When ?islandBased is specified, it includes entire islands to the outputLayer ABE layer where m1layer ABE layer islands are touching the m2layer ABE layer. The shapes with green outlines and diagonal stripes are the resulting shapes from the ABE layer.

Related Topics

abeRunQueue

Support for Multithreading in ABE Functions

Return to top