RenderWindowViewNode

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

Introduction

vtkRenderWindowViewNode is intended to be a superclass for all api specific RenderWindows. It is intended to define a common API that can be invoked upon an api specific render window and provide some common method implementations. If your application requires communicating with an api specific view try to limit such interactions to methods defined in this class.

Methods

createSelector

Not implemented by this class, api specific subclasses provide it.

displayToLocalDisplay

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes

displayToNormalizedDisplay

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes

displayToWorld

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes
renderer	vtkRenderer	Yes	The vtkRenderer instance.

extend

Method used to decorate a given object (publicAPI+model) with vtkRenderWindowViewNode 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	IRenderWindowViewNodeInitialValues	No	(default: {})

getAspectRatio

Get the ratio between the width and the height of the render window.

getAspectRatioForRenderer

Get the ratio between the width and the height of the renderer viewport.

Argument	Type	Required	Description
renderer	vtkRenderer	Yes	The vtkRenderer instance.

getComputedDevicePixelRatio

Get the ratio between the size of the render window and the size of its container.

getContainerSize

Not implemented by this class, api specific subclasses provide it.

getPixelData

Not implemented by this class, api specific subclasses provide it.

Argument	Type	Required	Description
x1	Number	Yes
y1	Number	Yes
x2	Number	Yes
y2	Number	Yes

getSelector

Get the hardware selector of the render window, when a subclass created one.

getSize

Get the size of the render window.

getSizeByReference

Get the size of the render window without copying it.

getViewNodeFactory

Returns null, api specific subclasses provide their own factory.

getViewportCenter

Get the center of the viewport.

Argument	Type	Required	Description
viewport	vtkRenderer	Yes	The viewport vtk element.

getViewportSize

Get the size of the viewport, in pixels.

Argument	Type	Required	Description
viewport	vtkRenderer	Yes	The viewport vtk element.

isInViewport

Check if a point is in the viewport.

Argument	Type	Required	Description
x	Number	Yes	The x coordinate.
y	Number	Yes	The y coordinate.
viewport	vtkRenderer	Yes	The viewport vtk element.

newInstance

Method used to create a new instance of vtkRenderWindowViewNode.

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

normalizedDisplayToDisplay

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes

normalizedDisplayToViewport

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes
renderer	vtkRenderer	Yes	The vtkRenderer instance.

normalizedViewportToViewport

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes
renderer	vtkRenderer	Yes	The vtkRenderer instance.

viewToWorld

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes
renderer	vtkRenderer	Yes	The vtkRenderer instance.

viewportToNormalizedDisplay

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes
renderer	vtkRenderer	Yes	The vtkRenderer instance.

viewportToNormalizedViewport

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes
renderer	vtkRenderer	Yes	The vtkRenderer instance.

worldToDisplay

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes
renderer	vtkRenderer	Yes	The vtkRenderer instance.

worldToView

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes
renderer	vtkRenderer	Yes	The vtkRenderer instance.