FPSMonitor

Source (.js)Source (.d.ts)

Introduction

vtkFPSMonitor is a DOM overlay reporting the mean and current frame rate of a render window, a rolling graph of the last frames and the render window statistics.

Methods

extend

Method used to decorate a given object (publicAPI+model) with vtkFPSMonitor characteristics.

Argument	Type	Required	Description
publicAPI		Yes	object on which methods will be bounds (public)
model		Yes	object on which data structure will be bounds (protected)
initialValues	IFPSMonitorInitialValues	No	(default: {})

getAddOnStats

Extra key/value pairs merged into the render window statistics listing.

getFpsMonitorContainer

Root element of the monitor.

newInstance

Method used to create a new instance of vtkFPSMonitor.

Argument	Type	Required	Description
initialValues	IFPSMonitorInitialValues	No	for pre-setting some of its content

render

Redraw the title, the statistics listing and the graph.

resize

No-op kept for API symmetry with the other UI widgets.

setAddOnStats

Merge extra statistics into the ones reported by the render window.

Argument	Type	Required	Description
addOn		Yes

setContainer

Attach the monitor to the given DOM element, detaching it from any previously set one.

Argument	Type	Required	Description
el		Yes

setMonitorVisibility

Argument	Type	Required	Description
title	Boolean	No	(default: true)
graph	Boolean	No	(default: true)
info	Boolean	No	(default: true)

setOrientation

Any mode other than 'horizontal' selects the vertical layout.

Argument	Type	Required	Description
mode	String	No	(default: 'horizontal')

setRenderWindow

Listen to the animation events of the render window interactor to sample the frame rate. Passing null unsubscribes.

Argument	Type	Required	Description
rw		Yes

update

Alias of render().