PerformanceWatchdogViewModel

new PerformanceWatchdogViewModel(options)

The view model for PerformanceWatchdog.

Name Type Description

options

Object

optional Object with the following properties:

Name	Type	Default	Description
`scene`	Scene		The Scene instance for which to monitor performance.
`lowFrameRateMessage`	String	`'This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.'`	optional The message to display when a low frame rate is detected. The message is interpeted as HTML, so make sure it comes from a trusted source so that your application is not vulnerable to cross-site scripting attacks.

Source: Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js, line 34

Members

dismissMessage :Command

Gets a command that dismisses the low frame rate message. Once it is dismissed, the message will not be redisplayed.

Source: Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js, line 101

lowFrameRateMessage :String

Gets or sets the message to display when a low frame rate is detected. This string will be interpreted as HTML.

Source: Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js, line 47

lowFrameRateMessageDismissed :Boolean

Gets or sets a value indicating whether the low frame rate message has previously been dismissed by the user. If it has been dismissed, the message will not be redisplayed, no matter the frame rate.

Source: Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js, line 54

scene :Scene

Gets the Scene instance for which to monitor performance.

Source: Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js, line 89

showingLowFrameRateMessage :Boolean

Gets or sets a value indicating whether the low frame rate message is currently being displayed.

Source: Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js, line 60