# ViewModes
This extension simplifies working with stock rendering pipelines
WARNING
For correct behavior of SHADED view mode, a FilteringExtension is required to be present when adding this extension
# Accessors
| viewMode | viewModeOptions |
|---|
# Methods
| on | setViewMode |
|---|
# Typedefs
| ViewMode | ViewModeEvent | ViewModeOptions | ViewModeEventPayload |
|---|
# Accessors
# viewMode
get viewMode(): ViewMode
1
Gets the current view mode
Returns: ViewMode
# viewModeOptions
get viewModeOptions(): ViewModeOptions
1
Gets the current view mode options
Returns: ViewModeOptions
# Methods
# on
on<T extends ViewModeEvent>(
eventType: T,
listener: (arg: ViewModeEventPayload[T]) => void
)
1
2
3
4
2
3
4
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)
1
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
}
1
2
3
4
5
6
7
2
3
4
5
6
7
Defines the supported view modes
# ViewModeEvent
enum ViewModeEvent {
Changed = 'view-mode-changed'
}
1
2
3
2
3
Defines the supported view modes events
# ViewModeOptions
type ViewModeOptions = PipelineOptions & EdgesPipelineOptions
1
A union of available rendering pipeline options
# ViewModeEventPayload
interface ViewModeEventPayload {
[ViewModeEvent.Changed]: ViewMode
}
1
2
3
2
3
Defines the supported view modes events payloads