ACAPI_​3D_​SelectSight

Switches to the supplied 3D sight for subsequent operations.

    GSErrCode  ACAPI_3D_SelectSight (
        void*      sightPtr,
        void**     oldSightPtr
    );

 

Parameters

sightPtr
[in] The sight to switch to. If sightPtr parameter is nullptr, then the 3D Window’s sight will be selected.
oldSightPtr
[out] A pointer to the previous sight.

 

Return Values

NoError
The function has completed with success.
APIERR_GENERAL
The passed sightPtr was invalid.

For other common API errors see the API Errors document.

 

Remarks

Subsequent 3D operations (like ACAPI_3D_GetNum will use the selected sight.

You can also pass two special sight IDs:

Sight ID

Meaning

API_PlanSight

The sight of the 3D window (i.e. the 3D information returned for ACAPI_3D_GetNum) will use the element as it is on the floor plan.

API_SymbSight

The sight of an object (in its own 3D window).

 

Requirements

Version: API 4.1 or later
Header: ACAPinc.h

 

See Also

API Functions