PathEngine home previous: iMeshFederation::getRepresentedRegion_World()next: iMeshFederation::getSourceTileForPosition()
Contents, API Reference, Interfaces, iMeshFederation, getRepresentedRegionsOverlapped

iMeshFederation::getRepresentedRegionsOverlapped()

Description

Queries the set of tile represented regions overlapped by the specific horizontal region.

Syntax

void getRepresentedRegionsOverlapped(const cHorizontalRange& queryRegion, iArrayReceiver<int32_t>& results) const;

Parameters

queryRegion Minimum and maximum bounds of the query region, in X and Y.
results (See Passing Arrays.) Returns the set of ground tiles for which tile represented region overlaps the specified query region. Note that the size of this result set can be determined exactly for a specific query, by calling iMeshFederation::getNumberOfRepresentedRegionsOverlapped(), or a maximum size can be determined more generally for all possible queries on a given mesh federation object, by calling iMeshFederation::size().

Remarks

This method can be used to place dynamic obstacles into individual tiles of a mesh federation.

Update: iMeshFederation::getRepresentedRegionOverlappedRange() should often be preferred, for efficiency reasons, particularly in situations where you want to track and update the set of represented regions overlapped for a large number of moving agents.

C# Mapping

void getRepresentedRegionsOverlapped(PathEngine.HorizontalRange queryRegion, out int[] results);

Java Mapping

void getRepresentedRegionsOverlapped(HorizontalRange queryRegion, Object_OutArgument results);

Documentation for PathEngine release 6.04 - Copyright © 2002-2024 PathEnginenext: iMeshFederation::getSourceTileForPosition()