ViewModes

This extension simplifies working with stock rendering pipelines

For correct behavior of SHADED view mode, a FilteringExtension is required to be present when adding this extension

Accessors

viewMode

get viewMode(): ViewMode

Gets the current view mode.

Returns: ViewMode

viewModeOptions

get viewModeOptions(): ViewModeOptions

Gets the current view mode options.

Returns: ViewModeOptions

Methods

on

on<T extends ViewModeEvent>(
    eventType: T,
    listener: (arg: ViewModeEventPayload[T]) => void
): void

Method for subscribing to view mode events.

Parameters

• eventType: ViewModeEvent
• listener: The handler for the events with ViewModeEventPayload arguments

Returns: void

setViewMode

setViewMode(viewMode: ViewMode, options?: ViewModeOptions): void

Sets the provided ViewMode along with the options.

Parameters

• viewMode: ViewMode
• optional options: ViewModeOptions

Returns: void

Typedefs

ViewMode

enum ViewMode {
  DEFAULT,
  SOLID,
  PEN,
  ARCTIC,
  SHADED,
}

Defines the supported view modes.

ViewModeEvent

enum ViewModeEvent {
  Changed = 'view-mode-changed',
}

Defines the supported view modes events.

ViewModeOptions

type ViewModeOptions = PipelineOptions & EdgesPipelineOptions;

A union of available rendering pipeline options.

ViewModeEventPayload

interface ViewModeEventPayload {
  [ViewModeEvent.Changed]: ViewMode;
}

Defines the supported view modes events payloads.