TextureMapToPlane

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

Introduction

vtkTextureMapToPlane generate texture coordinates by mapping points to a plane The TCoords DataArray is name 'Texture Coordinates'

Methods

extend

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

getAutomaticPlaneGeneration

Get whether the automatic plane generation is set.

getNormal

Get the normal object.

getNormalByReference

Get the normal object.

getOrigin

Get the origin of the plane.

getOriginByReference

Get the origin of the plane.

getPoint1

Get the point which defines the first axis of the plane.

getPoint1ByReference

Get the point which defines the first axis of the plane.

getPoint2

Get the point which defines the second axis of the plane

getPoint2ByReference

Get the point which defines the second axis of the plane

getSRange

Get the s-coordinate range for texture s-t coordinate pair.

getSRangeByReference

Get the s-coordinate range for texture s-t coordinate pair.

getTRange

Get the t-coordinate range for texture s-t coordinate pair.

getTRangeByReference

Get the t-coordinate range for texture s-t coordinate pair.

newInstance

Method used to create a new instance of vtkTextureMapToPlane

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

requestData

Argument	Type	Required	Description
inData		Yes
outData		Yes

setAutomaticPlaneGeneration

Turn on/off the automatic plane generation.

Argument	Type	Required	Description
automaticPlaneGeneration	Number	Yes

setNormal

Set the normal object.

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

setNormal

Set the normal object.

Argument	Type	Required	Description
normal	Array[Number]	Yes	The normal object coordinates.

setNormalFrom

Set the normal object.

Argument	Type	Required	Description
normal	Array[Number]	Yes	The normal object coordinates.

setOrigin

Set the origin of the plane.

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

setOrigin

Set the origin of the plane.

Argument	Type	Required	Description
origin	Array[Number]	Yes	The origin of the plane.

setOriginFrom

Set the origin of the plane.

Argument	Type	Required	Description
origin	Array[Number]	Yes	The origin of the plane.

setPoint1

Set the point which defines the first axis of the plane.

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

setPoint1

Set the point which defines the first axis of the plane.

Argument	Type	Required	Description
point1	Array[Number]	Yes	The coordinate of the point.

setPoint1From

Set the point which defines the first axis of the plane.

Argument	Type	Required	Description
point1	Array[Number]	Yes	The coordinate of the point.

setPoint2

Set the point which defines the second axis of the plane

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

setPoint2

Set the point which defines the second axis of the plane

Argument	Type	Required	Description
point2	Array[Number]	Yes	The coordinate of the point.

setPoint2From

Set the point which defines the second axis of the plane

Argument	Type	Required	Description
point2	Array[Number]	Yes	The coordinate of the point.

setSRange

Set the s-coordinate range for texture s-t coordinate pair.

Argument	Type	Required	Description
min	Number	Yes	The min of the s-coordinate range
max	Number	Yes	The min of the s-coordinate range.

setSRange

Set the s-coordinate range for texture s-t coordinate pair.

Argument	Type	Required	Description
sRange	Array[Number]	Yes	The s-coordinate range.

setSRangeFrom

Set the s-coordinate range for texture s-t coordinate pair.

Argument	Type	Required	Description
sRange	Array[Number]	Yes	The s-coordinate range.

setTRange

Set the t-coordinate range for texture s-t coordinate pair.

Argument	Type	Required	Description
min	Number	Yes	The min of the t-coordinate range
max	Number	Yes	The min of the t-coordinate range.

setTRange

Set the t-coordinate range for texture s-t coordinate pair.

Argument	Type	Required	Description
tRange	Array[Number]	Yes	The t-coordinate range.

setTRangeFrom

Set the t-coordinate range for texture s-t coordinate pair.

Argument	Type	Required	Description
tRange	Array[Number]	Yes	The t-coordinate range.