iQueryCallBack::desiredCallBackFrequency()

Description

This method is called by PathEngine at the start of each query to determine how often the abort() method should be polled.

Syntax

int32_t desiredCallBackFrequency();

Return Value

This method must return a value >= 1.
Larger values will result in the abort() method being called less often, and therefore in less overhead for PathEngine calling back into this method, but will then result in less fine control over the maximum time spent in the pathfinding query.

A value of 1 will result in the callback being polled for each corner visited during the search.
A value of 2 will result in the callback being called for every second corner, and so on.