ClipPolyData

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

Methods

createDefaultLocator

Create default locator. Used to create one when none is specified. The locator is used to merge coincident points.

getClipFunction

Get the implicit function used to perform the clipping.

getClippedOutput

Get the output of the filter that contains the clipped pieces. (The output of the filter is the part that is not clipped.) This output is only generated if the GenerateClippedOutput flag is on.

getGenerateClipScalars

Get the flag that controls whether or not to generate scalars on the output. If this flag is off, then no scalars are generated on the output. If this flag is on, then scalars are generated on the output. The scalars are generated by evaluating the implicit function at the points of the output. The default is off.

getGenerateClippedOutput

Get the flag that controls whether or not to generate scalars on the clipped output. If this flag is off, then no scalars are generated on the clipped output. If this flag is on, then scalars are generated on the clipped output. The scalars are generated by evaluating the implicit function at the points of the clipped output. The default is off.

getInsideOut

Get the flag that controls whether or not to reverse the sense of what is inside and what is outside. If this flag is off, then the implicit function is evaluated as is. If this flag is on, then the implicit function is evaluated as if it were multiplied by -1. In other words, what is inside becomes outside and what is outside becomes inside. The default is off.

getLocator

Get the locator used to merge coincident points. By default, an instance of vtkMergePoints is used. (@see createDefaultLocator() method.) To use a different locator, set it with the SetLocator() method. To turn off merging of coincident points, set the locator to null.

getOutputPointsPrecision

Get the output points precision.

getValue

Get the value used to perform clipping when not using an implicit function. The default is 0.0.

requestData

Argument	Type	Required	Description
inData		Yes
outData		Yes

setClipFunction

Set the implicit function used to perform the clipping.

Argument	Type	Required	Description
clipFunction		Yes

setGenerateClipScalars

Set the flag that controls whether or not to generate scalars on the output.

Argument	Type	Required	Description
generateClipScalars		Yes

setGenerateClippedOutput

Set the flag that controls whether or not to generate scalars on the clipped output.

Argument	Type	Required	Description
generateClippedOutput		Yes

setInsideOut

Set the flag that controls whether or not to reverse the sense of what is inside and what is outside.

Argument	Type	Required	Description
insideOut		Yes

setLocator

Set the locator used to merge coincident points. By default, an instance of vtkMergePoints is used. (@see createDefaultLocator() method.) To use a different locator, set it with this method. To turn off merging of coincident points, set the locator to null.

Argument	Type	Required	Description
locator		Yes	The locator to use for merging coincident points.

Returns

Type	Description
Boolean	True if the locator was set successfully, false otherwise.

setOutputPointsPrecision

Set the desired precision for the output types.

Argument	Type	Required	Description
outputPointsPrecision		Yes