DetectCollisionToTarget

Returns the distance to the first ground object detected on the path from the current camera position to the target parameter. The target parameter defines the direction and endpoint of this path.

If there is no collision between the viewer and target, 0 is returned.

 

JavaScript

 

DetectCollisionToTarget(

       target)

 

C#

 

double DetectCollisionToTarget (

       IPosition80 target)

 

C++

 

HRESULT DetectCollisionToTarget (

       IPosition80* target,

       double* Distance)

 

Parameters

target

An IPosition80representing the position of the endpoint of the path (that begins at the current camera position) that is being queried for the presence of a ground object.

Return Value

Distance

The distance to the first ground object detected on the path from the current camera position to the target parameter.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.