API Reference > imodeljs-frontend > Views > ViewState > setupFromFrustum

setupFromFrustum Method

Initialize the origin, extents, and rotation from an existing Frustum This function is commonly used in the implementation of ViewTools as follows:

  1. Obtain the ViewState's initial frustum.
  2. Modify the frustum based on user input.
  3. Update the ViewState to match the modified frustum.

setupFromFrustum(inFrustum: Frustum, opts?: ViewChangeOptions): ViewStatus

Parameter Type Description
inFrustum Frustum  
opts ViewChangeOptions for providing onExtentsError

Returns - ViewStatus

Success if the frustum was successfully updated, or an appropriate error code.

Defined in

Last Updated: 11 June, 2024