Altium Designer Home
...
((PCB Query Functions))_AD
PCB Query((Membership Checks))_AD
Query_Lang-PCBFunctions_MembershipChecks_InRegionRelativeInRegionRelative_AD
This document is no longer available beyond version 21. Information can now be found here: InRegionRelative for version 25
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.
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
- Parent component, coordinate, dimension, and Net objects are not returned.