combine_vect

Synopsis

combine n scalar components into a single n-vector component

Input Port

in_field	Node_Data
ui_parent	user interface parent object

Parameters

veclen	UIslider	output veclen
vector components	UIoptionBoxLabel	which components to combine

Output Port

out_fld	Node_Data
out_obj	output renderable object

Description

combine_vect takes all the selected data components, which must be scalar, and produces a single output data component that is the specified veclen long. For example, selecting the first and third components of (a, b, c, [e,f,g]) results in the field ([a, c]).

Input

in_field

The input field must contain a Node_Data object. If a mesh is present, it is passed along untouched as a reference in the output field. The field's data components must include at least two scalar components.

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

veclen

UIslider. Sets the number of scalar components to combine and the out_fld's single component veclen. The default is 3. The range is 1 to 4.

vector components

UIoptionBoxLabel. Selects which of the input field's components to combine. If you select vector components, only the first vector subcomponent is extracted. If node data labels are present, they are displayed. The default is the first three components.

Output Port

out_fld

The output field contains a new Node_Data that is a data array of references to the selected components in the original input Node_Data. It has one component with veclen equal to the specified veclen. If a mesh was present, the output field contains a reference to that mesh.

out_obj

If a mesh was present, this is a renderable version of the output field. Otherwise, rendering objects generate an error.

Example

Libraries.Examples.Visualization.Advect
v/dv_examp/advect.v
Libraries.Examples.Visualization.Curl
v/dv_examp/curl.v
Libraries.Examples.Visualization.Glyph_Interp
v/dv_examp/glh_intp.v

File

v/modules.v

See also related modules

combine_vect

extract_component

extract_scalar