Probe

Synopsis

Displays the data and coordinate values of the node or cell that has been picked

Input Ports

in_field	Mesh + Node_Data or Cell_Data
in_pick	pick information from renderer
ui_parent	user interface parent object

Parameters

Data	UIradioBoxLabel	node data / cell data
data component	UIradioBoxLabel	selects data component to probe
Probe Typ	UIradioBoxLabel	selects the probe type
Sphere Subdivision	UIslider	subdivisions of the sphere
Probe Normalize	UItoggle	normalizes probe size
probe scale	UIslider	scale factor for probe
value	UIfield	reports value of data at probe location
Probe Transform Editor	UItoggle	disyplays the transformation editor for the probe

Font	UItext	the text font
Align Horizontal	UIoptionMenu	alignment of text in the horizontal direction
Align Vertical	UIoptionMenu	alignment of text in the vertical direction
Drop Shadow	UItoggle	add drop shadow to the text
Bounds	UItoggle	add bounds to the text
Underline	UItoggle	underline the text
Background	UItoggle	add background to the text
Leadline	UItoggle	add a leadline to the text
Radial	UItoggle	make the text radial
Offset	UItoggle	define the offset for the text
X Offset	UIfield	sets the offset in the X direction
Y Offset	UIfield	sets the offset in the Y direction
Z Offset	UIfield	sets the offset in the Z direction
Stroke Text	UIbutton	make the text into stroke text

Parameters (for stroke text only)

Font Type	UIoptionMenu	font type of the text
Plane	UIoptionMenu	display plane of the text
Orientation	UIoptionMenu	text direction
Angle	UIslider	angle of the text (characters)
Path	UIoptionMenu	text path
Spacing Mode	UIoptionMenu	text spacing mode
Spacing	UIslider	text spacing
Height	UIslider	text size
Expansion	UIslider	text width

Output Ports

out_fld	Mesh + Node_Data
out_obj	output renderable object correponding to the probe
out_anno	output renderable object corresponding to the text describing the coordinate values
out_title	output renderable object correponding to the text describing the data values

Description

When a node or cell is picked, Probe displays the coordinate values at that position and displays the data values on the top portion of the window. Further, a probe is also displayed at the pixel location. For picking, hold the CTRL key down and then click the left mouse button.

Input Ports

in_field

The input field has to be scalar node data or cell data. In the case of vector data, the data values cannot be displayed properly.

in_pick

This input is connected to the viewer module's picked_obj red output port. It informs probe which object has been picked to probe.

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

UIradioBoxLabel. Selects whether node or cell data is to be displayed.

data component

UIradioBoxLabel. Radio buttons to pick which of the input field's components to probe.

Probe type

UIradioBoxLabel. Selects the probe type. There are two types: cross and sphere.

Probe Normalize

UItoggle. If off, the size of the probe is proportional to the data component values at each node. If on, the probe is the probe scale size. The default is on.

probe scale

UIslider. A float slider to adjust the size of the probe. The default is 1.0.

value

UIfield. A float. This is an output parameter only - it displays the value of the data at the probe's location. Where the probe does not fall exactly on a node, the value is interpolated from the values of adjacent nodes.

Probe Transform Editor

UItoggle. If this parameter is turned on, the probe transformation editor appears. It is possible to use this editor to move the probe instead of picking a node or a cell.

For a description of the remaining parameters, refer to the pages of the TextString module.

Output Ports

out_fld

The coordinates of the position of the probe (the position of the pick operation) are converted to Mesh coordinates.The out_fld is a field that stores the data at this position on the mesh as node data.

out_obj

The renderable object corresponding to the probe.

out_anno

The renderable object corresponding to the text object of the coordinate value.

out_title

The renderable object corresponding to the text object of the data value.

Example

File