Synopsis
Extracts a cross-section of the lattice from a structured field
Input Ports
|
in_field |
Mesh_Struct + Node_Data |
|
ui_parent |
user interface parent object |
Parameters
|
bounds on/off |
UItoggle |
displays the boundary of the slice |
|
axis |
UIslider |
sets the direction of the slice plane |
|
plane |
UIslider |
defines which slice plane is to be extracted (the number) |
Output Ports
|
out_fld |
Mesh + Node_Data |
|
slice_plane |
output renderable object correponding to the slice plane |
|
boundary |
output renderable object corresponding to the boundary |
Description
Orthogonal_Slicer extracts a cross-sectional slice plane of the lattice from a structured field. The direction of the slice plane is defined using axis. For example, a 3D structured field can be described as a mesh of I x J x K. By setting the axis parameter to 0, it is possible to select a 2D mesh J x K. An I x K mesh can be selected by setting the axis parameter to 1 and a J x K mesh by setting the axis parameter to 2. The plane parameter selects the slice plane to be extracted. By varying values of plane, slice planes at different positions along the direction set by the axis parameter can be extracted.
Input Ports
in_field
The input must contain a structured mesh (mesh type Mesh_Struct,Mesh_Unif, or Mesh_Rect) and Node_Data. The input can be 1D, 2D, or 3D.
ui_parent
A port to connect 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
axis
UIslider. An integer slider. Selects the axis of the slice plane. This parameter takes the values of 0, 1, and 2 in the case of a 3D input field and 0, 1 in the case of a 2D field.
plane
UIslider. An integer slider. Defines the position of the slice plane to be extracted.
Output Ports
out_fld
The output is a field with a new structured mesh of the same type as theinput field. The mesh is the mesh of the slice. It contains the slice's Node_Data.
slice_plane
This is a renderable version of the output field.
boundary
The renderable object corresponding to the boundary of the slice plane.
Example
File
See also