RenderOptionsService

class wvc.RenderOptionsService()

Index

Constructors

• constructor

Properties

• DefaultConfig
• serviceName

Accessors

• webViewer

Methods

• addEventListener
• dispatchEvent
• getAmbientOcclusionEnabled
• getAmbientOcclusionRadius
• getAntiAliasingEnabled
• getBackgroundColor
• getBloomEnabled
• getBloomIntensity
• getBloomThreshold
• getEyeDomeLightingEnabled
• getHiddenLineOpacity
• getMinimumFramerate
• getReflectionEnabled
• getShadowBlurSamples
• getShadowEnabled
• getShadowInteractive
• getShowBackfaces
• getSilhouetteEnabled
• getSplatRenderingEnabled
• getSplatRenderingPointSizeUnit
• getSplatRenderingSize
• removeEventListener
• resetConfiguration
• setAmbientOcclusionEnabled
• setAmbientOcclusionRadius
• setAntiAliasingEnabled
• setBackgroundColor
• setBloomEnabled
• setBloomIntensity
• setBloomThreshold
• setEyeDomeLightingEnabled
• setHiddenLineOpacity
• setMinimumFramerate
• setReflectionEnabled
• setShadowBlurSamples
• setShadowEnabled
• setShadowInteractive
• setShowBackfaces
• setSilhouetteEnabled
• setSplatRenderingEnabled
• setSplatRenderingPointSizeUnit
• setSplatRenderingSize

Constructors

wvc.RenderOptionsService.constructor()

RenderOptionsService(): RenderOptionsService

Returns: RenderOptionsService

Properties

wvc.RenderOptionsService.DefaultConfig

static readonly

DefaultConfig: RenderOptionsServiceConfiguration

wvc.RenderOptionsService.serviceName

readonly

serviceName: “RenderOptionsService”

Accessors

wvc.RenderOptionsService.webViewer()

get webViewer(): (undefined | IWebViewer)

Returns: (undefined | IWebViewer)

set webViewer(value: (undefined | IWebViewer)): void

Parameters

value: (undefined | IWebViewer)

Returns: void

Methods

wvc.RenderOptionsService.addEventListener()

inherited

addEventListener(type: string, callback: (None | EventListenerOrEventListenerObject), options: (boolean | AddEventListenerOptions)): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options’s capture.

When set to true, options’s capture prevents callback from being invoked when the event’s eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event’s eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event’s eventPhase attribute value is AT_TARGET.

When set to true, options’s passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options’s once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options’s signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target’s event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference

Parameters

type: string

callback: (None | EventListenerOrEventListenerObject)

options: (boolean | AddEventListenerOptions)

Returns: void

wvc.RenderOptionsService.dispatchEvent()

inherited

dispatchEvent(event: Event): boolean

Dispatches a synthetic event event to target and returns true if either event’s cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

Parameters

event: Event

Returns: boolean

wvc.RenderOptionsService.getAmbientOcclusionEnabled()

getAmbientOcclusionEnabled(): boolean

Returns: boolean

wvc.RenderOptionsService.getAmbientOcclusionRadius()

getAmbientOcclusionRadius(): number

Returns: number

wvc.RenderOptionsService.getAntiAliasingEnabled()

getAntiAliasingEnabled(): boolean

Returns: boolean

wvc.RenderOptionsService.getBackgroundColor()

getBackgroundColor(): VerticalGradient

Returns: VerticalGradient

wvc.RenderOptionsService.getBloomEnabled()

getBloomEnabled(): boolean

Returns: boolean

wvc.RenderOptionsService.getBloomIntensity()

getBloomIntensity(): number

Returns: number

wvc.RenderOptionsService.getBloomThreshold()

getBloomThreshold(): number

Returns: number

wvc.RenderOptionsService.getEyeDomeLightingEnabled()

getEyeDomeLightingEnabled(): Promise

Returns: Promise

wvc.RenderOptionsService.getHiddenLineOpacity()

getHiddenLineOpacity(): number

Returns: number

wvc.RenderOptionsService.getMinimumFramerate()

getMinimumFramerate(): Promise

Returns: Promise

wvc.RenderOptionsService.getReflectionEnabled()

getReflectionEnabled(): boolean

Returns: boolean

wvc.RenderOptionsService.getShadowBlurSamples()

getShadowBlurSamples(): number

Returns: number

wvc.RenderOptionsService.getShadowEnabled()

getShadowEnabled(): boolean

Returns: boolean

wvc.RenderOptionsService.getShadowInteractive()

getShadowInteractive(): boolean

Returns: boolean

wvc.RenderOptionsService.getShowBackfaces()

getShowBackfaces(): boolean

Returns: boolean

wvc.RenderOptionsService.getSilhouetteEnabled()

getSilhouetteEnabled(): boolean

Returns: boolean

wvc.RenderOptionsService.getSplatRenderingEnabled()

getSplatRenderingEnabled(): boolean

Returns: boolean

wvc.RenderOptionsService.getSplatRenderingPointSizeUnit()

getSplatRenderingPointSizeUnit(): (“Screen Pixels” | “CSS Pixels” | “World” | “Proportion Of Screen Width” | “Proportion Of Screen Height” | “Proportion Of Bounding Diagonal”)

Returns: (“Screen Pixels” | “CSS Pixels” | “World” | “Proportion Of Screen Width” | “Proportion Of Screen Height” | “Proportion Of Bounding Diagonal”)

wvc.RenderOptionsService.getSplatRenderingSize()

getSplatRenderingSize(): number

Returns: number

wvc.RenderOptionsService.removeEventListener()

inherited

removeEventListener(type: string, callback: (None | EventListenerOrEventListenerObject), options: (boolean | EventListenerOptions)): void

Removes the event listener in target’s event listener list with the same type, callback, and options.

MDN Reference

Parameters

type: string

callback: (None | EventListenerOrEventListenerObject)

options: (boolean | EventListenerOptions)

Returns: void

wvc.RenderOptionsService.resetConfiguration()

resetConfiguration(obj: object): Promise

Parameters

obj: object

Returns: Promise

wvc.RenderOptionsService.setAmbientOcclusionEnabled()

setAmbientOcclusionEnabled(enabled: boolean): Promise

Parameters

enabled: boolean

Returns: Promise

wvc.RenderOptionsService.setAmbientOcclusionRadius()

setAmbientOcclusionRadius(radius: number): Promise

Parameters

radius: number

Returns: Promise

wvc.RenderOptionsService.setAntiAliasingEnabled()

setAntiAliasingEnabled(enabled: boolean): Promise

Parameters

enabled: boolean

Returns: Promise

wvc.RenderOptionsService.setBackgroundColor()

setBackgroundColor(color: VerticalGradient): Promise

Parameters

color: VerticalGradient

Returns: Promise

wvc.RenderOptionsService.setBloomEnabled()

setBloomEnabled(enabled: boolean): void

Parameters

enabled: boolean

Returns: void

wvc.RenderOptionsService.setBloomIntensity()

setBloomIntensity(intensity: number): void

Parameters

intensity: number

Returns: void

wvc.RenderOptionsService.setBloomThreshold()

setBloomThreshold(threshold: number): void

Parameters

threshold: number

Returns: void

wvc.RenderOptionsService.setEyeDomeLightingEnabled()

setEyeDomeLightingEnabled(enabled: boolean): Promise

Parameters

enabled: boolean

Returns: Promise

wvc.RenderOptionsService.setHiddenLineOpacity()

setHiddenLineOpacity(opacity: number): void

Parameters

opacity: number

Returns: void

wvc.RenderOptionsService.setMinimumFramerate()

setMinimumFramerate(value: number): Promise

Parameters

value: number

Returns: Promise

wvc.RenderOptionsService.setReflectionEnabled()

setReflectionEnabled(enabled: boolean): void

Parameters

enabled: boolean

Returns: void

wvc.RenderOptionsService.setShadowBlurSamples()

setShadowBlurSamples(samples: number): void

Parameters

samples: number

Returns: void

wvc.RenderOptionsService.setShadowEnabled()

setShadowEnabled(enabled: boolean): Promise

Parameters

enabled: boolean

Returns: Promise

wvc.RenderOptionsService.setShadowInteractive()

setShadowInteractive(interactive: boolean): void

Parameters

interactive: boolean

Returns: void

wvc.RenderOptionsService.setShowBackfaces()

setShowBackfaces(show: boolean): Promise

Parameters

show: boolean

Returns: Promise

wvc.RenderOptionsService.setSilhouetteEnabled()

setSilhouetteEnabled(enabled: boolean): void

Parameters

enabled: boolean

Returns: void

wvc.RenderOptionsService.setSplatRenderingEnabled()

setSplatRenderingEnabled(enabled: boolean): Promise

Parameters

enabled: boolean

Returns: Promise

wvc.RenderOptionsService.setSplatRenderingPointSizeUnit()

setSplatRenderingPointSizeUnit(unit: (“Screen Pixels” | “CSS Pixels” | “World” | “Proportion Of Screen Width” | “Proportion Of Screen Height” | “Proportion Of Bounding Diagonal”)): Promise

Parameters

unit: (“Screen Pixels” | “CSS Pixels” | “World” | “Proportion Of Screen Width” | “Proportion Of Screen Height” | “Proportion Of Bounding Diagonal”)

Returns: Promise

wvc.RenderOptionsService.setSplatRenderingSize()

setSplatRenderingSize(size: number): Promise

Parameters

size: number

Returns: Promise