Bounds

Synopsis

generate a bounding box of a 3D structured field

Input Port

in_field	Mesh_Struct
ui_panel	user interface parent object

Parameters

data component	UIradioBoxLabel	selects which component to output
Hull	UItoggle	display hull
Edges	UItoggle	display edges
Faces	UItoggle	display faces
Imin	UItoggle	display first dimension minimum
Imax	UItoggle	display first dimension maximum
Jmin	UItoggle	display second dimension minimum
Jmax	UItoggle	display second dimension maximum
Kmin	UItoggle	display third dimension minimum
Kmax	UItoggle	display third dimension maximum
Data	UItoggle	output selected Data Component

Output Port

out_fld	Mesh [+ Node_Data]
out_obj	output renderable object

Description

bounds generates lines and/or surfaces that indicate the bounding box of a 3D structured field. This is useful when you need to see the shape of an object and the structure of its mesh. For example, isosurface can produce a fairly cryptic shape floating without context in space, but when combined with bounds, you see the isosurface within its surrounding mesh.

Input

in_field

The input field must contain any type of structured mesh (mesh type Mesh_Struct, Mesh_Unif or Mesh_Rect). Node_Data can be present, but is only used if you switch on Data.

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

data component

UIradioBoxLabel. Selects which of the input field's components to send to the output, if Data is also turned on. The default is the first (0th) component. If node data labels are present, they are displayed.

Hull

UItoggle. When on, draws a wireframe around the perimeter extents of the mesh. The default is on.

Edges

UItoggle. When on, causes the Imin/Imax, Jmin/Jmax, Kmin/Kmax controls to produce a wireframe representation of the mesh grid at that plane. The default is off.

Faces

UItoggle. When on, causes the Imin/Imax, Jmin/Jmax, Kmin/Kmax controls to produce a solid face representing the location of that plane extent. The default is off.

Imin
Imax
Jmin
Jmax
Kmin
Kmax

UItoggle. When on, each of these switches displays the grid (Edges turned on) or plane (Faces turned on) on one of the six faces of the hull. Imin/Imax draw a mesh or face showing the 2D slice of field objects with the minimum/maximum index value in the first dimension. Jmin/Jmax draw a mesh or face showing the 2D slice of field objects with the minimum/maximum index in the second dimension. Kmin/Kmax control the third dimension. The default for all is off.

data

UItoggle. When on, makes bounds copy the selected component's Node_Data values at node points along the output mesh to the output field. Because the data is present, the bounds lines can be colored by the interpolated data values of the selected Node_Data component. Otherwise, the lines display as white in the renderer. The default is off.

Output Port

out_fld

The output field contains a new unstructured Mesh object with cell type Polyline (Edges selected) and/or Quad (Faces set) representing the bounds. If Data was selected, the output field also contains a Node_Data that is the selected component's values at nodes on the output mesh.

out_obj

This is a renderable version of the output field.

Example

Libraries.Examples.Vizualization.Crop
Libraries.Examples.Visualization.Advect
v/dv_examp/crop.v

File

v/modules.v

See also related modules

external_edges

external_faces