Glyph3DMapper

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

Methods

buildArrays

extend

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

getBounds

Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].

getBuildTime

Timestamp of the last buildArrays() execution.

getColorArray

Colors computed by buildArrays() by mapping the input scalars through the lookup table. Null when there is no lookup table or no scalars.

getMatrixArray

Per-glyph 4x4 model matrices computed by buildArrays(), packed as 16 floats per input point.

getNormalArray

Per-glyph 3x3 normal matrices computed by buildArrays(), packed as 9 floats per input point.

getOrient

Check whether glyphs are oriented using the orientation array.

getOrientationArray

Gets the name of the array used as orientation values.

getOrientationArrayData

Get orientation as array

getOrientationMode

An orientation array is a vtkDataArray with 3 components. The first component is the angle of rotation along the X axis. The second component is the angle of rotation along the Y axis. The third component is the angle of rotation along the Z axis. Orientation is specified in X,Y,Z order but the rotations are performed in Z,X an Y.

This definition is compliant with SetOrientation method on vtkProp3D.

By using vector or normal there is a degree of freedom or rotation left (underconstrained). With the orientation array, there is no degree of freedom left.

getOrientationModeAsString

Get orientation as string

getPrimitiveCount

getScaleArray

Gets the name of the array used as scale values.

getScaleArrayData

Get scale mode as array

getScaleFactor

Get scale factor to scale object by.

getScaleMode

Get scale mode

getScaleModeAsString

Get scale mode as string

getScaling

Check whether glyphs are scaled using the scale array and scale factor.

newInstance

Method use to create a new instance of vtkGlyph3DMapper

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

setOrient

Turn on/off orienting glyphs with the orientation array.

Argument	Type	Required	Description
orient	Boolean	Yes

setOrientationArray

Sets the name of the array to use as orientation.

Argument	Type	Required	Description
arrayName	String	Yes	Name of the array

setOrientationMode

Orientation mode indicates if the OrientationArray provides the direction vector for the orientation or the rotations around each axes.

Argument	Type	Required	Description
orientationMode	OrientationModes	Yes	The orientation mode.

setOrientationModeToDirection

Set orientation mode to DIRECTION

setOrientationModeToMatrix

Set orientation mode to MATRIX

setOrientationModeToRotation

Set orientation mode to ROTATION

setScaleArray

Sets the name of the array to use as scale values.

Argument	Type	Required	Description
arrayName	String	Yes	Name of the array

setScaleFactor

Specify scale factor to scale object by.

Argument	Type	Required	Description
scaleFactor	Number	Yes	The value of the scale factor.

setScaleMode

Either scale by individual components (SCALE_BY_COMPONENTS) or magnitude (SCALE_BY_MAGNITUDE) of the chosen array to SCALE with or disable scaling using data array all together (SCALE_BY_MAGNITUDE).

Argument	Type	Required	Description
scaleMode	ScaleModes	Yes

setScaleModeToScaleByComponents

Set scale to SCALE_BY_CONSTANT

setScaleModeToScaleByConstant

Set scale to SCALE_BY_CONSTANT

setScaleModeToScaleByMagnitude

Set scale to SCALE_BY_MAGNITUDE

setScaling

Turn on/off scaling glyphs with the scale array and scale factor.

Argument	Type	Required	Description
scaling	Boolean	Yes

setSourceConnection

Convenient method to set the source glyph connection

Argument	Type	Required	Description
outputPort	vtkPipelineConnection	Yes	The output port of the glyph source.