Documentation / paraview-settings-reference.md
Core 11629ae · View or edit Markdown on GitHub ↗

Shared function and ParaView settings signatures

Guide · Dollar syntax

All type constraints below are taken directly from declarations. required, defaults, enum values and array lengths are authoritative; cross-field rules still require the planner. Examples are type templates, requiring semantically suitable values.

Appearance#

Camera#

Registered value functions#

boundsCentre#

Centre of six-component VTK bounds.

Result contract: {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3}.

{
  "$value": "boundsCentre",
  "args": {
    "bounds": [
      1,
      1,
      1,
      1,
      1,
      1
    ]
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

boundsCentre3D#

Centre of min/max bounds.

Result contract: {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3}.

{
  "$value": "boundsCentre3D",
  "args": {
    "bounds": {
      "min": [
        1,
        1,
        1
      ],
      "max": [
        1,
        1,
        1
      ]
    }
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

boundsExtend#

Extend min/max bounds by before/after vectors.

Result contract: {"type":"object","properties":{"min":{"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3,"required":true},"max":{"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3,"required":true}}}.

{
  "$value": "boundsExtend",
  "args": {
    "bounds": {
      "min": [
        1,
        1,
        1
      ],
      "max": [
        1,
        1,
        1
      ]
    }
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

boundsFrame#

Frame bounds with margins, a floor and an aspect ratio.

Result contract: {"type":"object","properties":{"min":{"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3,"required":true},"max":{"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3,"required":true}}}.

{
  "$value": "boundsFrame",
  "args": {
    "bounds": {
      "min": [
        1,
        1,
        1
      ],
      "max": [
        1,
        1,
        1
      ]
    },
    "floor": 1
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

boundsSize#

Axis extents of min/max bounds.

Result contract: {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3}.

{
  "$value": "boundsSize",
  "args": {
    "bounds": {
      "min": [
        1,
        1,
        1
      ],
      "max": [
        1,
        1,
        1
      ]
    }
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

boundsUnion#

Union of a nonempty list of min/max bounds.

Result contract: {"type":"object","properties":{"min":{"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3,"required":true},"max":{"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3,"required":true}}}.

{
  "$value": "boundsUnion",
  "args": {
    "bounds": [
      {
        "min": [
          1,
          1,
          1
        ],
        "max": [
          1,
          1,
          1
        ]
      }
    ]
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

directionVector#

Resolve a direction declaration to an XYZ vector.

Result contract: {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3}.

{
  "$value": "directionVector",
  "args": {
    "direction": "REPLACE_WITH_VALUE"
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

fitCamera#

Fit a camera to bounds.

Result contract: {"type":"object","properties":{"direction":{"type":"union","title":"direction","summary":"An axis token, a vector, or an azimuth and elevation about an up axis","options":[{"type":"string","title":"axis token such as 'x+' or 'z-'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},{"type":"object","title":"direction object","properties":{"axis":{"type":"string","summary":"Axis token such as 'x+'"},"azimuth":{"type":"number","minimum":-360,"maximum":360,"summary":"Degrees about the up axis from the reference axis"},"elevation":{"type":"number","minimum":-180,"maximum":180,"summary":"Degrees tilted from the plane perpendicular to up"},"vector":{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},"up":{"type":"union","title":"up direction","options":[{"type":"string","title":"axis token such as 'z+'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3}]}}}],"default":[1,0,0]},"up":{"type":"union","title":"direction","summary":"An axis token, a vector, or an azimuth and elevation about an up axis","options":[{"type":"string","title":"axis token such as 'x+' or 'z-'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},{"type":"object","title":"direction object","properties":{"axis":{"type":"string","summary":"Axis token such as 'x+'"},"azimuth":{"type":"number","minimum":-360,"maximum":360,"summary":"Degrees about the up axis from the reference axis"},"elevation":{"type":"number","minimum":-180,"maximum":180,"summary":"Degrees tilted from the plane perpendicular to up"},"vector":{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},"up":{"type":"union","title":"up direction","options":[{"type":"string","title":"axis token such as 'z+'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3}]}}}],"default":[0,0,1]},"focalPoint":{"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3},"parallel":{"type":"boolean","default":true},"scale":{"type":"number","minimum":0,"exclusiveMinimum":true},"distance":{"type":"number","minimum":0,"exclusiveMinimum":true},"bounds":{"type":"array","items":{"type":"number"},"minItems":6,"maxItems":6},"padding":{"type":"number","minimum":0,"default":0.1}}}.

{
  "$value": "fitCamera",
  "args": {
    "bounds": {
      "min": [
        1,
        1,
        1
      ],
      "max": [
        1,
        1,
        1
      ]
    }
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

foamRegions#

Convert tyres/body //patch selectors to internalMesh and patch/name reader regions.

Result contract: {"type":"array","items":{"type":"string"}}.

{
  "$value": "foamRegions",
  "args": {
    "groups": {
      "tyres": [
        "REPLACE_WITH_VALUE"
      ],
      "body": [
        "REPLACE_WITH_VALUE"
      ]
    }
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

orbitCameras#

Produce camera declarations around bounds.

Result contract: {"type":"array","items":{"type":"object","properties":{"direction":{"type":"union","title":"direction","summary":"An axis token, a vector, or an azimuth and elevation about an up axis","options":[{"type":"string","title":"axis token such as 'x+' or 'z-'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},{"type":"object","title":"direction object","properties":{"axis":{"type":"string","summary":"Axis token such as 'x+'"},"azimuth":{"type":"number","minimum":-360,"maximum":360,"summary":"Degrees about the up axis from the reference axis"},"elevation":{"type":"number","minimum":-180,"maximum":180,"summary":"Degrees tilted from the plane perpendicular to up"},"vector":{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},"up":{"type":"union","title":"up direction","options":[{"type":"string","title":"axis token such as 'z+'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3}]}}}],"default":[1,0,0]},"up":{"type":"union","title":"direction","summary":"An axis token, a vector, or an azimuth and elevation about an up axis","options":[{"type":"string","title":"axis token such as 'x+' or 'z-'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},{"type":"object","title":"direction object","properties":{"axis":{"type":"string","summary":"Axis token such as 'x+'"},"azimuth":{"type":"number","minimum":-360,"maximum":360,"summary":"Degrees about the up axis from the reference axis"},"elevation":{"type":"number","minimum":-180,"maximum":180,"summary":"Degrees tilted from the plane perpendicular to up"},"vector":{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},"up":{"type":"union","title":"up direction","options":[{"type":"string","title":"axis token such as 'z+'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3}]}}}],"default":[0,0,1]},"focalPoint":{"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3},"parallel":{"type":"boolean","default":true},"scale":{"type":"number","minimum":0,"exclusiveMinimum":true},"distance":{"type":"number","minimum":0,"exclusiveMinimum":true},"bounds":{"type":"array","items":{"type":"number"},"minItems":6,"maxItems":6},"padding":{"type":"number","minimum":0,"default":0.1}}}}.

{
  "$value": "orbitCameras",
  "args": {
    "bounds": {
      "min": [
        1,
        1,
        1
      ],
      "max": [
        1,
        1,
        1
      ]
    }
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

rangeCentre#

Midpoint of a two-number range.

Result contract: {"type":"number"}.

{
  "$value": "rangeCentre",
  "args": {
    "range": [
      1,
      1
    ]
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

sinDegrees#

Sine of an angle in degrees.

Result contract: {"type":"number"}.

{
  "$value": "sinDegrees",
  "args": {
    "angle": 1
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

slicePositions#

Produce scalar slice positions along one bounds axis.

Result contract: {"type":"array","items":{"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3}}.

{
  "$value": "slicePositions",
  "args": {
    "bounds": {
      "min": [
        1,
        1,
        1
      ],
      "max": [
        1,
        1,
        1
      ]
    },
    "axis": "x"
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.

vectorLength#

Euclidean length of an XYZ vector.

Result contract: {"type":"number"}.

{
  "$value": "vectorLength",
  "args": {
    "vector": [
      1,
      1,
      1
    ]
  }
}

Use $call instead of $value when arguments contain graph runtime expressions.