User's Reference - Vector

### Vector

Category

Interactor

Function

Generates a vector.

Syntax

Available only through the user interface.

Inputs

Name | Type | Default | Description
--- | --- | --- | ---
`data` | object | no default | object from which interactor attributes can be derived
`refresh` | flag | 0 | reset the interactor
`min` | scalar, vector | minimum data value | minimum output value
`max` | scalar, vector | maximum data value | maximum output value
`delta` | scalar, vector | input dependent | increment between successive scalar outputs
`method` | string | input dependent | defines interpretation of delta input
`decimals` | integer | input dependent | number of decimal places to be displayed in output values
`start` | string | "midpoint" | describes how the default output should be calculated
`label` | string | "Vector" | global name applied to interactor stand-ins

Outputs

Name | Type | Description
--- | --- | ---
`output` | vector | interactor output

Functional Details

This interactor allows the user to interactively change vector values. Through inputs to the module (outputs from other tools or values set in its configuration dialog box) the interactor can be "data driven."

If the interactor is not data-driven, its attributes (e.g., `stringdata` or `valuelist`) are taken from its `Set Attributes...` dialog box (accessed from the `Edit` pull-down menu in the Control Panel).

Note: The module's control panel is invoked by double clicking on its icon in the VPE window. Its configuration dialog box is accessed from the `Edit` pull-down menu in the same window.

`data` | is the object from which the interactor can derive any or all of the minimum, maximum, and delta attributes when their corresponding input uses the default value (tab up). Initially, all inputs are default values.
`refresh` | resets the interactor so that the output is computed from the current input. If `refresh` = 0 (the default), the output is recomputed only if the current output does not lie within the range of the current `data`. The default for the output of the interactor is, for each component of the vector, is defined by the start parameter.
`min` and `max` | specify the minimum and maximum values of the interactor's vector output. If set, these values override those implied by `data`. Each component of the vector values corresponds to a component of the interactor output. A specified value of [10 20 30] means that the minimum (or maximum) of the first component is 10, of the second is 20, and of the third is 30. When the specified value is scalar, that value is used for all components. If neither `min` nor `data` is specified, the interactor uses the minimum set in the `Set Attributes...` dialog box. If neither `max` nor `data` is specified, the interactor uses the maximum in the `Set Attributes...` dialog box.
`delta` | specifies a scalar value as a factor for calculating the increment between successive outputs over the specified range. The actual value depends on the interpretation specified by `method` (see below).
`method` | specifies the interpretation of `delta`: "rounded": the increment (`max` - `min`) × `delta` is rounded to a "nice" number. The spacing between successive values will approximate the interval specified by `delta`. (For example, the default value of 0.01 specifies an interval of 1/100 of the specified range.) "relative": the interpretation is the same as for "rounded," but the increment is not rounded. "absolute": `delta` is the absolute value of the interval. (If `delta` has not been specified, its default is 1.) The default value for `method` depends on other input. The default is: "rounded" if `data` is specified or if both `min` and `max` are specified. "absolute" in all other cases.
`decimals` | specifies the number of decimal places displayed in the interactor. If neither `data` nor `delta` is specified, the interactor uses the value in its own `Set Attributes...` dialog box.
`start` | specifies how the default output should be calculated. Can be "minimum", "midpoint" or "maximum" (midpoint sets the value to the midpoint between min and max.)
`label` | is the global label of all instances of the corresponding interactor stand-in. An interactor instance's local label (set from the Control Panel) overrides a global label. If not specified, the global label is set by the user interface.

Example Visual Programs

    PlotTwoLines.net
    UsingClipPlane.net
    UsingCompute.net

An example that uses a data-driven vector interactor is:

    MultipleDataSets.net

See Also

Integer, IntegerList, Scalar, ScalarList, VectorList

[ OpenDX Home at IBM | OpenDX.org ]