StartShadowVisibilityQuery
Initializes a shadow visibility query for a selected position and shadow effect. After this initialization, subsequent calls can be made to QueryPointVisibility to calculate shadow visibility or to QueryVisibilityDistance to return the point where the shadow is blocked. The query can be based on the shadow effect of selected objects (selection Shadow) or of all the project’s objects (global shadow). Shadows are displayed using the ICommand80.Execute method (set the CommandID parameter to 2118 for a global shadow and to 2119 for a selection shadow).
Note: The selection of objects for a selection shadow can only be performed through the user interface since it is not currently supported by the API.
|
JavaScript |
|
|
|
|
StartShadowVisibilityQuery( QuerySpherePosition, QuerySphereRadius, Type) |
|||
|
C# |
|
|
|
|
void StartShadowVisibilityQuery( IPosition80 QuerySpherePosition, double QuerySphereRadius, ShadowType Type) |
|||
|
C++ |
|
|
|
|
HRESULT StartShadowVisibilityQuery( IPosition80* QuerySpherePosition, double QuerySphereRadius, ShadowType Type) |
|||
Parameters
QuerySperePosition
The center point of the sphere that defines the region in which the shadow analysis is performed.
QuerySphereRadius
The radius of the sphere that defines the region in which the shadow analysis is performed.
Type
An enum that defines what shadow effect should be considered in the query. The following are the possible values:
· STP_NONE = 0
No shadow
· STP_GLOBAL = 1
Global shadow cast by all of the project’s objects
· STP_SELECTION = 2
Shadow effect of selected objects
Exceptions
HRESULT can return any of the values listed in the HRESULT Return Values list.