AbstractMapper

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

Introduction

vtkAbstractMapper is an abstract class to specify interface between data and graphics primitives or software rendering techniques. Subclasses of vtkAbstractMapper can be used for rendering 2D data, geometry, or volumetric data.

Methods

addClippingPlane

Added plane needs to be a vtkPlane object.

Argument	Type	Required	Description
plane	vtkPlane	Yes

extend

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

getClippingPlaneInCoords

Get the ith clipping plane transformed from world coordinates into the target coordinate system defined by the provided world-to-coordinates matrix.

Argument	Type	Required	Description
worldToCoords	mat4	Yes
i	Number	Yes
hnormal	Array[Number]	No

getClippingPlaneInDataCoords

Get the ith clipping plane as a homogeneous plane equation. Use getNumberOfClippingPlanes() to get the number of planes. This API expects a coordinates-to-world matrix and preserves the legacy behavior used by existing data-coordinate callers.

Argument	Type	Required	Description
propMatrix	mat4	Yes
i	Number	Yes
hnormal	Array[Number]	Yes

getClippingPlanes

Get all clipping planes.

getClippingPlanesMTime

Get the modified time of the clipping planes list.

getNumberOfClippingPlanes

Get number of clipping planes.

removeAllClippingPlanes

Remove all clipping planes.

removeClippingPlane

Remove clipping plane.

Argument	Type	Required	Description
plane	vtkPlane	Yes

setClippingPlanes

Set clipping planes.

Argument	Type	Required	Description
planes	Array[vtkPlane]	Yes

update