VECQueryRadius()

Description

VECQueryRadius() is used to find a list of shapes for which some portion of the shape is within a given radius of a given point.

Call Signature

int ptr VECQueryRadius ( int/string filespec, int segment_num, Vertex ptr location, double radius [, int ptr search_list [, int list_count] ] )

Return Value

int ptr

An array of integers which are the shape numbers of the shapes matching the search criteria.

Arguments

int/string filespec:

This can either be the handle returned by DBOpen(), or the name of an open file.

int segment_num:

The vector layer (segment) number being accessed.

Vertex ptr location:

The point to search from.

double radius:

The radius out to search for objects.

[ int ptr search_list ]:

An optional array of integer shape id's to restrict this search to. If not provided, all shapes are tested.

[ int list_count ]:

An optional count of the number of shape id's in the search_list. If not provided, it is assumed that the entire search_list array should be used.

Remarks

The number of matching shapes can be established by taking the f$len() of the returned pointer.

The returned array of shape id's should be freed with EFree() when it is no longer needed.

Note: This search ignores the Z component.

See also

GDB file functions