Field operations¶
Typed feature metadata used by the design catalogue. Discover the connected service’s catalogue operation before composing a document; deployment availability and input combinations are validated there. These are feature IDs, not separate HTTP routes.
Combine fields¶
Operation: field.combine. Feature version: 1.
Outputs: result (field).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
field |
Yes |
Required input |
|
|
field |
Yes |
Required input |
|
|
enum |
No |
|
choices: |
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Constant field¶
Operation: field.constant. Feature version: 1.
Outputs: result (field).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
number |
No |
|
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Coordinate field¶
Operation: field.coordinate. Feature version: 1.
Outputs: result (field).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
enum |
No |
|
choices: |
|
length |
No |
|
|
|
length |
No |
|
minimum: 1e-06 |
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Distance to body¶
Operation: field.distance. Feature version: 1.
Outputs: result (field).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
body |
Yes |
Required input |
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Evaluate field at point¶
Operation: field.evaluate. Feature version: 1.
Outputs: result (number).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
field |
Yes |
Required input |
|
|
vector |
No |
|
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Evaluate field gradient¶
Operation: field.gradient. Feature version: 1.
Outputs: result (gradient).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
field |
Yes |
Required input |
|
|
vector |
No |
|
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Field-driven offset¶
Operation: field.offset. Feature version: 1.
Outputs: result (body).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
body |
Yes |
Required input |
|
|
field |
Yes |
Required input |
|
|
length |
No |
|
minimum: 0 |
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Scalar point-map field¶
Operation: field.point_map. Feature version: 1.
Outputs: result (field).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
string |
Yes |
Required input |
|
|
enum |
No |
|
choices: |
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Spatial ramp¶
Operation: field.ramp. Feature version: 1.
Outputs: result (field).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
enum |
No |
|
choices: |
|
length |
No |
|
|
|
length |
No |
|
|
|
number |
No |
|
|
|
number |
No |
|
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Remap field range¶
Operation: field.remap_range. Feature version: 1.
Outputs: result (field).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
field |
Yes |
Required input |
|
|
number |
No |
|
|
|
number |
No |
|
|
|
number |
No |
|
|
|
number |
No |
|
|
|
enum |
No |
|
choices: |
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.
Field-driven thickness¶
Operation: field.thicken. Feature version: 1.
Outputs: result (body).
Input |
Type |
Required |
Default |
Bounds / choices |
|---|---|---|---|---|
|
body |
Yes |
Required input |
|
|
field |
Yes |
Required input |
|
|
length |
No |
|
minimum: 1e-06 |
|
length |
No |
|
minimum: 1e-06 |
Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.