pipObjectFindFirstRect - spatial_geostan - 2024.00

Spatial+ Reference for Windows, UNIX/Linux, z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > Spatial+
Version
2024.00
Language
English
Product name
Spatial+
Title
Spatial+ Reference for Windows, UNIX/Linux, z/OS
Copyright
2024
First publish date
1994
Last updated
2024-05-07
Published on
2024-05-07T22:16:04.316305

Finds first object's mbr overlapping the search rectangle.

Syntax

intl pipObjectFindFirstRect ( pipObjectFile obj_h, intl xmin, intl ymin, intl

xmax, intl ymax, pstr nameBuffer, intl bufSize );

Arguments

obj_h The handle of the opened object file. Input.

xmin, ymin The lower left corner of the rectangle to search. Input.

xmax, ymax The upper right corner of the rectangle to search. Input. nameBuffer A pointer to a buffer to be filled with the identifier of the

overlapping object. Output.

bufSize The size of the buffer that contains the identifier of the object in which the point is located. If the buffer size is smaller than the identifier, the identifier is truncated. Input.

Return Value

PIP_ERROR PIP_NOT_FOUND PIP_OK

Prerequisites

pipObjectFileOpen.

Alternates

None.

Notes

This function returns the identifier of the first object that overlaps the given rectangle. Use

pipObjectFindNext to retrieve the next object.

If no MBR is found to overlap the input search rectangle, the function returns

PIP_NOT_FOUND.

Note that the test used in this search is an MBR (Minimum Bounding Rectangle) overlap test. It is possible to return a polygon which does not actually intersect the search object, as shown below. Thus, pipObjectFindFirstRect may return a set of points which are not contained within the search rectangle.

Figure 1. Overlapping Minimum Bounding Rectangle