Setting up a Viewport component for Unified Selection

As described in the Viewport selection handling section, selection in a Viewport component and Unified Selection are synchronized in a two-way manner:

• When an element in the Viewport is selected, it (or anything that comes from it after applying active selection scope) is added to unified selection.
• When an ECInstance is added to unified selection, all BisCore.Elements that represent that ECInstances are added to the Viewport's hilite set.

Reference

The Reference section in Unified Selection page describes the core APIs used in Unified Selection workflows.

The @itwin/presentation-components package delivers viewWithUnifiedSelection HOC to make setting up Viewport components to work with Unified Selection easier. The HOC takes a ViewportComponent and returns a new Viewport component that synchronizes with Unified Selection.

Example

The below example shows how to create a Viewport component and hook it into Unified Selection. The latter part is achieved by using viewWithUnifiedSelection HOC.

// use `viewWithUnifiedSelection` HOC to create an enhanced `ViewportComponent` that synchronizes with unified selection
const UnifiedSelectionViewport = viewWithUnifiedSelection(ViewportComponent);
// besides the above line, the component may be used just like the general `ViewportComponent` from `@itwin/imodel-components-react`
function MyViewport(props: { imodel: IModelConnection; initialViewState: ViewState }) {
  return <UnifiedSelectionViewport imodel={imodel} viewState={props.initialViewState} />;
}

Last Updated: 07 April, 2023