changeViewedModels Method

Attempt to replace the set of models currently viewed by this viewport, if it is displaying a SpatialView

changeViewedModels(modelIds: Id64Arg): boolean

@returns false if this Viewport is not viewing a SpatialViewState

@note This function only works if the viewport is viewing a SpatialViewState, otherwise it does nothing.

@note This function does not load any models. If any of the supplied modelIds refers to a model that has not been loaded, no graphics will be loaded+displayed in the viewport for that model.

@see replaceViewedModels for a similar function that also ensures the requested models are loaded.

Parameter Type Description
modelIds Id64Arg The Ids of the models to be displayed.

Returns - boolean

false if this Viewport is not viewing a SpatialViewState

Defined in

Last Updated: 21 November, 2024