OverlayNodes() function - MapBasic - 2023

MapInfo MapBasic Reference

Product type
Software
Portfolio
Locate
Product family
MapInfo
Product
MapInfo > MapBasic
Version
2023
Language
English
Product name
MapBasic
Title
MapInfo MapBasic Reference
First publish date
1985
Last updated
2023-09-12
Published on
2023-09-12T16:32:32.686312

Purpose

Returns an object based on an existing object, with new nodes added at points where the object intersects a second object. You can call this function from the MapBasic window in MapInfo Pro.

Syntax

OverlayNodes( input_object, overlay_object ) 

input_object is an object whose nodes will be included in the output object; it may not be a point or text object.

overlay_object is an object that will be intersected with input_object; it may not be a point or text object.

Return Value

A region object or a polyline object.

Description

The OverlayNodes() function returns an object that contains all the nodes in input_object plus nodes at all locations where the input_object intersects with the overlay_object.

If the input_object is a closed object (region, rectangle, rounded rectangle, or ellipse), OverlayNodes() returns a region object. If input_object is a linear object (line, polyline, or arc), OverlayNodes() returns a polyline.

The object returned retains all styles (color, etc.) of the original input_object.

To determine whether the OverlayNodes() function added any nodes to the input_object, use the ObjectInfo() function to count the number of nodes (OBJ_INFO_NPNTS). Even if two objects do intersect, the OverlayNodes() function does not add any nodes if input_object already has nodes at the points of intersection.

See Also:

IntersectNodes() function, Objects Overlay statement