InRegionRelative

Now reading version 16.0. For the latest, read: InRegionRelative for version 21

Parent page: PCB Query Functions - Membership Checks

Summary

Returns all objects that reside within the area specified by the Query.

Syntax

InRegionRelative(X1 : Number ,Y1 : Number ,X2 : Number ,Y2 : Number) : Boolean/Boolean_String

X1,Y1 and X2,Y2 specify coordinates in the PCB (Library) file. The left and right boundaries of the region are specified by the X1 and X2 parameters, while the lower and upper boundaries of the region are specified by the Y1 and Y2 parameters.

All coordinates are referenced to the user origin (PCB files) or component insertion point (PCB Library files), rather than to the absolute origin, and at present, all coordinates always use units of mils. (1 mil = 0.001 inch).

Example Usage

InRegionRelative(-700,-400,1300,1600)
InRegionRelative(-700,-400,1300,1600) = True
InRegionRelative(-700,-400,1300,1600) = 'True'

Returns objects residing within the rectangular region bounded by X1 = -700 and X2 = 1300, and by Y1 = -400 and Y2 = 1600; those coordinates are referenced to the user origin (or component insertion point).

Tips

  1. Parent component, coordinate, dimension, and Net objects are not returned.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Note

The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.