addCPlane()

Create a cut-plane actor.

Usage

cplActor = vis.addCPlane( point1, point2, point3, name, vols = None )

Parameters

point1 (list)
Point 1 information.
point2 (list)
Point 2 information.
point3 (list)
Point 3 information.
name (string)
optional name.
vols (list), (string) or (integer)
volume(s).

Return Value

cplActor (object)
Cut-plane actor.

Errors

vols should include valid volumes or be None.

Description

This routine creates a cut-plane actor from the vols based on the point1, point2 and point3, names it name and adds its actor to Scene Graph. For example,
imp = vis.getVolActor( "impeller" )
impBbox = imp.bndBox( )
xmin = bndBox[0][0]
xmax = bndBox[0][1]
ymin = bndBox[1][0]
ymax = bndBox[1][1]
zmin = bndBox[1][0]
zmax = bndBox[1][1]
ymid = ( impBbox[1][0] + impBbox[1][1] ) / 2
cpl = vis.addCPlane( [xmin, ymid, zmin],
                     [xmax, ymid, zmin],
                     [xmax, ymid, zmax],
                     "mid-plane" )