OrientationMarkerWidget

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

Introduction

vtkOrientationMarkerWidget is a 2D widget for manipulating a marker prop

Methods

computeViewport

Get the computed viewport size. The format is [left, bottom, right, top].

delete

Dereference any internal object and remove any subscription. It gives custom class to properly detach themselves from the DOM or any external dependency that could prevent their deletion when the GC runs.

extend

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

getActor

getEnabled

Get wheter the orientation marker is enabled.

getInteractiveRenderer

An instance of this class will spawn its own renderer, by default non interactive. This behavior is configurable through the interactiveRenderer property when initializing the instance.

Returns

Type	Description
	true if the renderer was created as interactive, false otherwise.

getInteractor

Get the render window interactor associated with the widget.

getMaxPixelSize

Get the maximum side length, in pixels, for the orientation marker widget viewport.

getMinPixelSize

Get the minimum side length, in pixels, for the orientation marker widget viewport.

getParentRenderer

Gets the parent renderer, if any.

getRenderer

Get the renderer associated with the widget.

getViewportCorner

Get the viewport corner.

getViewportSize

Get the viewport size.

newInstance

Method used to create a new instance of vtkOrientationMarkerWidget

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

setActor

Get the actor associated with the widget.

Argument	Type	Required	Description
actor	vtkActor	Yes	The actor instance.

setEnabled

Set the widget enabled status, i.e. to show the widget or not.

Argument	Type	Required	Description
enabled	Boolean	Yes

setInteractor

Set the render window interactor associated with the widget.

Argument	Type	Required	Description
interactor	vtkRenderWindowInteractor	Yes

setMaxPixelSize

Set the maximum side length, in pixels, for the orientation marker widget viewport.

Argument	Type	Required	Description
pixelSize	Number	Yes

setMinPixelSize

Set the minimum side length, in pixels, for the orientation marker widget viewport.

Argument	Type	Required	Description
pixelSize	Number	Yes

setParentRenderer

Sets the parent renderer

Argument	Type	Required	Description
ren	vtkRenderer	Yes	The parent renderer

setViewportCorner

Set which corner to put the widget's viewport.

Argument	Type	Required	Description
viewportCorner	Corners	Yes

setViewportSize

Set the viewport size. The sizeFactor should be between 0.0 and 1.0. It says how much of the main render window to color.

Argument	Type	Required	Description
sizeFactor	Number	Yes

updateMarkerOrientation

Manually updates the marker's orientation.

updateViewport

Updates the orientation widget viewport size.