Skip to content

Surge Sway Yaw

The Surge Sway Yaw shows the motion of the vessel in the horizontal plane: surge (fore and aft) on the vertical scale, sway (sideways) on the horizontal scale, and yaw (rotation) on the ring. Each has its own setpoint. It is found in the Maritime - OpenBridge section of the Perspective Component Palette as Surge Sway Yaw (Experimental).

Note: This component is experimental: its properties may change in a later version.

Surge Sway Yaw with values and setpoints

The parts of the instrument:

  1. Surge scale — vertical, positive up (forward). See Values.
  2. Sway scale — horizontal, positive right (starboard).
  3. Yaw ring — 0° at the top, positive clockwise.
  4. Setpoints — a triangular marker for each axis. See Setpoints.

It is a maritime instrument: state, priority, setpoints, tickmarks and sizing work as described in Maritime Instruments — Common Features.

A Surge Sway Yaw dropped from the palette shows no setpoints and no values (shown here at 300 × 300 px):

Surge Sway Yaw with default properties

A new Surge Sway Yaw is only 158 × 172 px, the blue frame below. Make it larger:

Surge Sway Yaw at its default size

type selects whether the actual values are drawn:

input (default) input-output
Setpoints only Setpoints and values
  • input — the three setpoint markers only, on a thin ring with full-length scales. For a control that orders motion, such as a joystick.
  • input-output — also the actual values: a band on the ring with the yaw as an arc from 0°, and four half-scales with the surge and sway as bars from the centre.
Name Description Property Type
type input or input-output. Default input. value

Bind surge and sway in percent of the scale, from -100 to 100, and yaw in degrees, from -180 to 180. Positive surge is forward (up), positive sway is to starboard (right), and positive yaw is clockwise. The values are drawn with type input-output only, but always count for “at setpoint”.

Surge 25 %, sway -10 % and yaw 15°

Name Description Property Type
surge Surge in percent, -100 to 100; positive is forward. Default 0. value
sway Sway in percent, -100 to 100; positive is starboard. Default 0. value
yaw Yaw in degrees, -180 to 180; positive is clockwise. Default 0. value

Each axis has a full set of setpoint properties, which work as described in Setpoint with the name of the axis in them: hasSurgeSetpoint and surgeSetpoint, hasSwaySetpoint and swaySetpoint, hasYawSetpoint and yawSetpoint, and so on. The surge marker is beside the vertical scale, the sway marker above the horizontal scale, and the yaw marker on the ring.

Setpoints 40 %, -20 % and 30° Reached A new yaw setpoint of 60°
Three setpoints Setpoints reached A new setpoint being chosen

Unlike most instruments, the Surge Sway Yaw decides by itself when a setpoint is reached: autoAtSurgeSetpoint, autoAtSwaySetpoint and autoAtYawSetpoint are true by default, with deadbands of 1 %, 1 % and 2°.

touching draws all markers in their focus form, and …SetpointOverride keeps a marker in its colour in the loading and off states:

touching = true state off, yawSetpointOverride = true
Markers in focus form Yaw setpoint kept in colour

The surge properties are listed; the sway and yaw ones are the same with Sway or Yaw in place of Surge.

Name Description Property Type
hasSurgeSetpoint Show the surge setpoint. Default false. value
surgeSetpoint Ordered surge in percent. Only shown when hasSurgeSetpoint is true. value
hasNewSurgeSetpoint Show a second marker for a surge setpoint that is being chosen. Default false. Only shown when hasSurgeSetpoint is true. value
newSurgeSetpoint The surge setpoint being chosen. Only shown when hasNewSurgeSetpoint is true. value
autoAtSurgeSetpoint Let the instrument decide when the setpoint is reached. Default true. value
autoAtSurgeSetpointDeadband How far the value may be from the setpoint and still count as reached. Default 1 (yaw 2). value
atSurgeSetpoint Whether the setpoint is reached, when autoAtSurgeSetpoint is false. Default false. value
surgeSetpointAtZeroDeadband How close to zero the setpoint must be to be drawn in its “zero” form. Default 0.1 (yaw 0.5). value
surgeSetpointOverride Keep the marker in its colour in the loading and off states. Default false. value
touching The operator is operating the control. Default false. value
animateSetpoint Animate the markers when a new setpoint is confirmed. Default false. value

The ring has tickmarks in degrees, turned on with hasPrimaryTickmarkInterval (default interval 45°), hasSecondaryTickmarkInterval (15°) and hasTertiaryTickmarkInterval (5°), as described in Scale. showLabels writes the degrees at the primary tickmarks; the instrument is made smaller to leave room for them.

Ring with tickmarks and labels

Name Description Property Type
hasPrimaryTickmarkInterval Show the primary tickmarks. Default false. value
primaryTickmarkInterval Degrees between them. Default 45. Only shown when hasPrimaryTickmarkInterval is true. value
hasSecondaryTickmarkInterval Show the secondary tickmarks. Default false. value
secondaryTickmarkInterval Degrees between them. Default 15. Only shown when hasSecondaryTickmarkInterval is true. value
hasTertiaryTickmarkInterval Show the tertiary tickmarks. Default false. value
tertiaryTickmarkInterval Degrees between them. Default 5. Only shown when hasTertiaryTickmarkInterval is true. value
showLabels Show the degrees at the primary tickmarks. Default false. value

state and priority work as described in State and Priority. In the off state the values are not drawn.

active loading off
Active Loading Off

Enhanced priority


The Surge Sway Yaw fills the smaller side of its box as a circle, centred in it. With hasFaceDiameter and faceDiameter it has a fixed size instead and is placed at the top left of the box (the blue frame), as described in Size:

Fixed face diameter of 200 px


These work in the same way on every maritime instrument, and are described in Maritime Instruments — Common Features:

The Surge Sway Yaw has no component events of its own.

Example 1 — Dynamic Positioning Overview

Section titled “Example 1 — Dynamic Positioning Overview”
  1. Drop a Surge Sway Yaw (Experimental) into the view and make it about 300 × 300 px.
  2. Set type to input-output.
  3. Bind surge, sway and yaw to [default]DP/SurgeFeedback, [default]DP/SwayFeedback and [default]DP/YawFeedback.
  4. Set hasSurgeSetpoint, hasSwaySetpoint and hasYawSetpoint to true, and bind surgeSetpoint, swaySetpoint and yawSetpoint to the orders of the DP system.
  5. Bind state to if(isGood({[default]DP/SurgeFeedback}), 'active', 'off').

Built on the OpenBridge Design System