All Cadcorp SIS API Methods

ScanGeometry Method

Description

Finds Items which satisfy a condition with the current open Item.

Syntax

Public Function ScanGeometry( _
   ByVal list As String, _
   ByVal geomTest As Integer, _
   ByVal geomMode As Integer, _
   ByVal filter As String, _
   ByVal locus As String _
) As Long

Parameters

list

The Named List in which to store any items found.

 

geomTest

The geometry test to use. See Geometry Tests for details.

SIS_GT_EQUAL

SIS_GT_DISJOINT

SIS_GT_INTERSECT

SIS_GT_TOUCH

SIS_GT_CROSS

SIS_GT_CROSSBY

SIS_GT_WITHIN

SIS_GT_CONTAIN

SIS_GT_OVERLAP

 

geomMode

The geometry mode to use. See Geometry Tests for details.

SIS_GM_ORIGIN

SIS_GM_EXTENTS

SIS_GM_GEOMETRY

 

filter

Optionally specifies a named Filter which Items must pass to be included in the scan.

 

locus

Optionally specifies a named Spatial Filter which Items must pass to be included in the scan.

Return Type

The number of items found, i.e. the number of items placed in the Named List.

Remarks

Only hittable or editable items are scanned.

Available: GEO D OD OM SISpy

Groups:

• Spatial Searching Methods
• Named List Methods

Example

NItems = sis.ScanGeometry ("Points", SIS_GT_CONTAIN, SIS_GM_GEOMETRY, _
 "PointsOnly", "Talbot")

Finds all items that are contained within the current open item that pass the filter PointsOnly and fall within the Talbot Spatial Filter, and places them in the named list Points.