WarpScalar

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

Introduction

vtkWarpScalar - deform a dataset along its normals by its scalars

vtkWarpScalar displaces every point of its input along a normal by a distance equal to the point scalar times the scale factor. The normal is taken from the input point normals, from the instance normal, or from the z axis when xyPlane is on. The scalars are read from the array selected with setInputArrayToProcess.

Methods

extend

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

getNormal

Get the normal used when the input has no normals, or when useNormal is on.

getNormalByReference

Get the normal used when the input has no normals, or when useNormal is on.

getScaleFactor

Get the amount by which the points are displaced along the normal.

getUseNormal

Get whether the instance normal is used in place of the input normals.

getXyPlane

Get whether the z coordinate is used as the scalar to warp by.

newInstance

Method used to create a new instance of vtkWarpScalar

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

requestData

Argument	Type	Required	Description
inData		Yes
outData		Yes

setNormal

Set the normal used when the input has no normals, or when useNormal is on.

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

setNormal

Set the normal used when the input has no normals, or when useNormal is on.

Argument	Type	Required	Description
normal	Vector3	Yes

setNormalFrom

Set the normal used when the input has no normals, or when useNormal is on.

Argument	Type	Required	Description
normal	Vector3	Yes

setScaleFactor

Set the amount by which the points are displaced along the normal.

Argument	Type	Required	Description
scaleFactor	Number	Yes

setUseNormal

Set whether the instance normal is used in place of the input normals.

Argument	Type	Required	Description
useNormal	Boolean	Yes

setXyPlane

Set whether the z coordinate is used as the scalar to warp by, in which case the points are displaced along the z axis.

Argument	Type	Required	Description
xyPlane	Boolean	Yes