ClipClosedSurface

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

Introduction

vtkClipClosedSurface

Methods

extend

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

getActivePlaneColor

Get the color used for the active plane's cut face when it differs from the other cut faces.

getActivePlaneColorByReference

Get the color used for the active plane's cut face when it differs from the other cut faces.

getActivePlaneId

Get the id of the active clipping plane.

getBaseColor

Get the color used for the faces generated to close the surface.

getBaseColorByReference

Get the color used for the faces generated to close the surface.

getClipColor

Get the color used for the region of a cut face that is on the active plane.

getClipColorByReference

Get the color used for the region of a cut face that is on the active plane.

getClippingPlanes

Get the planes used to clip the input data.

getGenerateFaces

Get whether faces are generated to close the clipped surface.

getGenerateOutline

Get whether an outline is generated at the cut edges.

getPassPointData

Get whether point data is passed through to the output.

getScalarMode

Get the scalar mode used to color the output.

getTolerance

Get the tolerance used to determine when a point is on the clipping plane.

getTriangulatePolys

Get whether generated triangles are further triangulated.

getTriangulationErrorDisplay

Get whether an error is displayed when triangulation fails.

newInstance

Method use to create a new instance of vtkClipClosedSurface

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

requestData

Argument	Type	Required	Description
inData	any	Yes
outData	any	Yes

setActivePlaneColor

Set the color used for the active plane's cut face when it differs from the other cut faces.

Argument	Type	Required	Description
x		Yes
y		Yes
z		Yes

setActivePlaneColorFrom

Set the color used for the active plane's cut face when it differs from the other cut faces.

Argument	Type	Required	Description
activePlaneColor		Yes

setActivePlaneId

Set the id of the active clipping plane.

Argument	Type	Required	Description
activePlaneId		Yes

setBaseColor

Set the color used for the faces generated to close the surface.

Argument	Type	Required	Description
x		Yes
y		Yes
z		Yes

setBaseColorFrom

Set the color used for the faces generated to close the surface.

Argument	Type	Required	Description
baseColor		Yes

setClipColor

Set the color used for the region of a cut face that is on the active plane.

Argument	Type	Required	Description
x		Yes
y		Yes
z		Yes

setClipColorFrom

Set the color used for the region of a cut face that is on the active plane.

Argument	Type	Required	Description
clipColor		Yes

setClippingPlanes

Set the planes used to clip the input data.

Argument	Type	Required	Description
clippingPlanes		Yes

setGenerateFaces

Set whether faces are generated to close the clipped surface.

Argument	Type	Required	Description
generateFaces		Yes

setGenerateOutline

Set whether an outline is generated at the cut edges.

Argument	Type	Required	Description
generateOutline		Yes

setPassPointData

Set whether point data is passed through to the output.

Argument	Type	Required	Description
passPointData		Yes

setScalarMode

Set the scalar mode used to color the output.

Argument	Type	Required	Description
scalarMode		Yes

setScalarModeToColors

Set scalarMode to COLORS.

setScalarModeToLabels

Set scalarMode to LABELS.

setScalarModeToNone

Set scalarMode to NONE.

setTolerance

Set the tolerance used to determine when a point is on the clipping plane.

Argument	Type	Required	Description
tolerance		Yes

setTriangulatePolys

Set whether generated triangles are further triangulated.

Argument	Type	Required	Description
triangulatePolys		Yes

setTriangulationErrorDisplay

Set whether an error is displayed when triangulation fails.

Argument	Type	Required	Description
triangulationErrorDisplay		Yes