AbstractManipulator

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

Introduction

vtkAbstractManipulator.

Methods

extend

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

getNormal

Get the normal of the line

getOrigin

Get the origin of the line

getUseCameraFocalPoint

Get the value of useCameraFocalPoint

getUseCameraNormal

Get the value of useCameraNormal

handleEvent

Processes a vtkRenderWindowInteractor event into 3D world positional info.

Returns an object containing:

• worldCoords: a 3D coordinate corresponding to the 2D event.
• worldDelta: a 3D position delta between the current and the previous call to handleEvent.
• worldDirection: a 3D directional vector. Only on select manipulators.

worldCoords can be null if the pointer event enters an invalid manipulator region. For example, the PickerManipulator returns null when the pointer event is off of the picked geometry.

worldDelta only makes sense between two calls of handleEvent. In a queue of handleEvent calls, the i-th call returns the delta between the i-th worldCoords and the (i-1)-th worldCoords. Thus, calling handleEvent is necessary for maintaining a valid worldDelta even when the return value is ignored.

There are three cases where worldDelta needs to handle null events:

1. the first call to handleEvent, since there is no previously cached event position. worldDelta is set to [0, 0, 0].
2. if the current handleEvent call returns a null worldCoords. worldDelta is set to [0, 0, 0].
3. if the previous handleEvent call returned a null worldCoords. In this case, worldDelta is the delta between the current worldCoords and the previous non-null worldCoords, referring to the previous 2 cases when applicable.

Argument	Type	Required	Description
callData		Yes
glRenderWindow		Yes

newInstance

Method use to create a new instance of vtkAbstractManipulator

setHandleNormal

Set the handle normal (see setHandleNormal).

Argument	Type	Required	Description
x	Number	Yes	The x coordinate.
y	Number	Yes	The y coordinate.
z	Number	Yes	The z coordinate.

setHandleNormal

Set the handle normal. This normal is used after the userNormal and before the widgetNormal. This normal is automatically set by any state having a manipulatorMixin, and can be overridden in the widget code.

Argument	Type	Required	Description
normal	Vector3	Yes	The normal coordinate.

setHandleNormalFrom

Set the handle normal (see setHandleNormal).

Argument	Type	Required	Description
normal	Vector3	Yes	The normal coordinate.

setHandleOrigin

Set the handle origin (see setHandleOrigin).

Argument	Type	Required	Description
x	Number	Yes	The x coordinate of the origin point.
y	Number	Yes	The y coordinate of the origin point.
z	Number	Yes	The z coordinate of the origin point.

setHandleOrigin

Set the handle origin. This origin is used after the userOrigin and before the widgetOrigin. This origin is automatically set by any state having a manipulatorMixin, and can be overridden in the widget code.

Argument	Type	Required	Description
origin	Vector3	Yes	The coordinate of the origin point.

setHandleOriginFrom

Set the handle origin (see setHandleOrigin).

Argument	Type	Required	Description
origin	Vector3	Yes	The coordinate of the origin point.

setUseCameraFocalPoint

Set the value of useCameraFocalPoint

Argument	Type	Required	Description
useCameraFocalPoint		Yes	if true, the focal point of the camera will be used if userOrigin is not set.

setUseCameraNormal

Set the value of useCameraNormal

Argument	Type	Required	Description
useCameraNormal		Yes	if true, the normal of the camera will be used if userNormal is not set.

setUserNormal

Set the user normal (see setUserNormal).

Argument	Type	Required	Description
x	Number	Yes	The x coordinate.
y	Number	Yes	The y coordinate.
z	Number	Yes	The z coordinate.

setUserNormal

Set the user normal. This normal take precedence on the handleNormal and the widgetNormal. This normal should not be set within the widget internal code.

Argument	Type	Required	Description
normal	Vector3	Yes	The normal coordinate.

setUserNormalFrom

Set the user normal (see setUserNormal).

Argument	Type	Required	Description
normal	Vector3	Yes	The normal coordinate.

setUserOrigin

Set the user origin (see setUserOrigin).

Argument	Type	Required	Description
x	Number	Yes	The x coordinate of the origin point.
y	Number	Yes	The y coordinate of the origin point.
z	Number	Yes	The z coordinate of the origin point.

setUserOrigin

Set the user origin. This origin take precedence on the handleOrigin and the widgetOrigin. This origin should not be set within the widget internal code.

Argument	Type	Required	Description
origin	Vector3	Yes	The coordinate of the origin point.

setUserOriginFrom

Set the user origin (see setUserOrigin).

Argument	Type	Required	Description
origin	Vector3	Yes	The coordinate of the origin point.

setWidgetNormal

Set the widget normal (see setWidgetNormal).

Argument	Type	Required	Description
x	Number	Yes	The x coordinate.
y	Number	Yes	The y coordinate.
z	Number	Yes	The z coordinate.

setWidgetNormal

Set the widget normal. This normal is used if no other normals are set. It can be used to define a normal global to the whole widget.

Argument	Type	Required	Description
normal	Vector3	Yes	The normal coordinate.

setWidgetNormalFrom

Set the widget normal (see setWidgetNormal).

Argument	Type	Required	Description
normal	Vector3	Yes	The normal coordinate.

setWidgetOrigin

Set the widget origin (see setWidgetOrigin).

Argument	Type	Required	Description
x	Number	Yes	The x coordinate of the origin point.
y	Number	Yes	The y coordinate of the origin point.
z	Number	Yes	The z coordinate of the origin point.

setWidgetOrigin

Set the widget origin. This origin is used if no other origins are set. It can be used to define an origin global to the whole widget.

Argument	Type	Required	Description
origin	Vector3	Yes	The coordinate of the origin point.

setWidgetOriginFrom

Set the widget origin (see setWidgetOrigin).

Argument	Type	Required	Description
origin	Vector3	Yes	The coordinate of the origin point.