cut_plane

Synopsis

The cut_plane macro includes cut and cutting plane.

Input Port

in_field	Mesh [+ Node_Data] [+Cell_Data]
ui_parent	user interface parent object

Output Port

out_fld	Mesh	the mesh with part cut away
out_plane	Plane_Mesh	the cutting plane
out_obj_cut	DefaultObject	renderable output of the cut field
out_obj_plane	DefaultObject	renderable output of the plane

Description

cut_plane is a macro that includes the cut macro and an FPlane cutting plane object. It cuts away the part of a field above or below the arbitrarily-oriented cutting plane, revealing the internal structure.

Note: The cut_plane module does not generate vertex normals by default.

Input

in_field

The input field to cut. You can specify any 2D or 3D mesh with any primitive type of node data and/or cell data.

ui_parent

A port for connecting to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. (This default connection is not drawn.)

Parameters

map components

UIoptionBoxLabel. Select which node data component(s) will be mapped onto the resulting mesh

map cell data

UIoptionBoxLabel. Select which cell data component(s) will be mapped onto the resulting mesh.

Above

UItoggle. Selects whether the part of the mesh above (1) or below (0) the cutting plane is removed. Above is in the positive Z direction of the cutting plane.

plane distance

UIslider. The plane at which the field is cut can be offset from the plane described by the internal plane object, which is what is transformed by the Plane Transform Editor. The offset is in the direction of the Z axis of the cutting plane. Note that if you offset the cutting plane from the plane object, the plane object output still shows the position of the plane object, not the actual cutting plane.

Plane Transform Editor

UIbutton. This button brings up the plane transform editor panel, which you can use to transform the cutting plane to any arbitrary orientation.

Output Port

out_fld

Mesh[+Node_Data] [+Cell_Data]. The mesh with the part above or below the cutting plane removed. It may have node and/or cell data from the part of the input field.

out_plane

Plane_Mesh. A mesh containing the cutting plane. This is simply a rectangle spanning the minimum and maximum of the first two dimensions of the field. It is transformed to lie at the correct spatial location.

out_obj_cut

Renderable object corresponding to out_fld.

out_obj_plane

Renderable object corresponding to out_plane.

Example

Not available

File

v/modules.v

See also related modules

cut

plane_crop

slice

slice_plane

FPlane