MouseModeAPI.setSelectTimeAlongTrackMode

 

long setSelectTimeAlongTrackMode(string ck, bool isSynchronous)

This method sets the state of the SDM such that a mouse click on the track with CARIS Key ck provides the time along that track at the location of the click.

The client using isSynchronous = TRUE must test for completion of the operation (as described in the discussion Synchronous vs. Asynchronous Response). When isSynchronousOpComplete returns TRUE, the client must call getTime to obtain the selected time.

The client using isSynchronous = FALSE, must have previously identified itself to the MouseModeAPI object and exposed the method receiveTime (see Synchronous vs. Asynchronous Response), to which the selected time is supplied as an argument.

Migration note for v2.5 developers: this method corresponds to getPointAlongTrack in v2.5, when used  synchronously.