Synopsis
extract a scalar data element from a field's vector component
Input Ports
|
in_field |
Node_Data |
|
ui_parent |
user interface parent object |
Parameters
|
data component |
UIradioBoxLabel |
component to extract |
|
vector component |
UIslider |
sub-component of the vector |
Output Ports
|
out_fld |
Node_Data |
|
out_obj |
output renderable object |
Description
extract_scalar extracts a single scalar data element from a vector component of a field with Node_Data. For example, selecting the second vector element of the fourth component of the field (a, b, c, [e, f, g]) returns the field (f).
Input Ports
in_field
The input field need only contain Node_Data. One of its components should be a vector. If a mesh is present, it is passed through unchanged as a reference in the output field.
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. Radio buttons to pick which of the components to display in the vector component selection below. The default is the first (0th) selection. If node data labels are present, they are displayed.
vector component
A selection to pick which vector element of a component to extract.
Output Ports
out_fld
The output is a field with a new Node_Data consisting of the extracted vector element. If a mesh was present in the input field, it is included in the output field as a reference to the original mesh.
out_obj
If a mesh was present, this is a renderable version of the output field. Otherwise, rendering objects generate an error.
Example
Not available.
File
v/modules.v
See also