slice_plane
Synopsis
The slice_plane module extracts a 2D slice from a field with an arbitrarily positioned slice plane.
Input Port
in_field
|
Mesh [+Node_Data] [+Cell_Data]
|
ui_parent
|
user interface parent object
|
Parameters
map components
|
UIoptionBoxLabel
|
node data components to output
|
map cell data
|
UIoptionBoxLabel
|
cell data components to output
|
plane distance
|
UIslider
|
moves slicing plane parallel to itself
|
Output Port
out_fld
|
Mesh [+Node_Data] [+Cell_Data]
|
out_plane
|
Plane_Mesh
|
out_obj_slice
|
output renderable object of slice
|
out_obj_plane
|
output renderable object of slicing plane
|
Description
slice_plane is a macro that contains the slice macro and a slicing plane object. It extracts a 2D or 1D slice from a 3D or a 2D field at a given distance from the plane. See the documentation for the slice macro for details.
Input
in_field
Mesh. The field to slice, which can be any 3D or 2D mesh.
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. Option buttons to pick which components of in_field's node data to map to the output field. The default is the first (0th) component. If node data labels are present, they are displayed.
map cell data
UIoptionBoxLabel. Option buttons to pick which components of in_field's cell data to map to the output field. The default is the first (0th) component. If cell data labels are present, they are displayed.
plane distance
UIslider. A float slider that moves the plane through the field perpendicular to the plane's current orientation. Though the Plane Transformation panel has X, Y, and Z transformation controls, it is usually easier to use plane's controls to orient and size the plane, but use this plane distance control to move the plane. slice generates output whenever the slice plane moves.
The default distance is 0.0. The minimum range is the (absolute value of maximum coordinate - minimum coordinate) * -0.5. The maximum range is the (absolute value of the maximum coordinate - minimum coordinate) * 0.5.
Output Port
out_fld
The output field contains a new, subsetted 2D (or 1D) mesh and a new node and/or cell data.
out_plane
Plane_Mesh. A 2D mesh representing the plane used to do the slicing.
out_obj_slice
Renderable object corresponding to out_fld.
out_obj_plane
Renderable object corresponding to out_plane. This may be fed to the viewer and transformed to transform the slicing plane.
Example
Not available
File
v/modules.v
See also related modules
