Skip to content

Roll

The Roll shows the roll (heel) of the vessel: a vessel seen from the fore tilts with the roll, and a needle shows the angle on an arc scale at the bottom. It is found in the Maritime - OpenBridge section of the Perspective Component Palette as Roll.

Roll at 8° with an average band and caution zones from 20°

The parts of the instrument:

  1. Vessel and needle — the vessel tilts with the roll, and the needle shows it on the scale. See Roll.
  2. Average band — the range the roll has moved within lately.
  3. Caution zones — beyond the largest recommended roll. See Roll Advice.
  4. Scale — an arc of ±45° by default.

The Roll works like the Pitch, turned a quarter round. The average band, the arc, the zoom, the vessel image and the readout are described there and link from this page. For a small symbol of the roll, see the Roll Indicator.

A Roll dropped from the palette shows a roll of 0° (shown here at 300 × 300 px; a new Roll is 509 × 509 px):

Roll with default properties

Bind roll to the roll of the vessel in degrees. A positive value turns the vessel and the needle clockwise, a negative value counter-clockwise:

-15 0 15
Roll of -15° Roll of 0° Roll of 15°

type selects whether the scale is drawn once, at the bottom, or also mirrored at the top:

single-scale (default) dual-scale
Scale at the bottom Scale at bottom and top

minAvgRoll and maxAvgRoll draw the average band, as described in Average Band:

Average band from -6° to 10°

Name Description Property Type
roll Roll in degrees; positive turns the drawing clockwise. Default 0. value
type single-scale or dual-scale. Default single-scale. value
minAvgRoll Lower end of the average band, in degrees. Default 0. value
maxAvgRoll Upper end of the average band, in degrees. Default 0. value

Set hasMaxRollAdvice to true and maxRollAdvice to the largest recommended roll: hatched caution zones are drawn on both sides from there out to 45°, or to the end of the arc. As on the Pitch (see Pitch Advice), they are drawn in the caution colour only when triggerRollAdvice is true:

Advice at 20° triggerRollAdvice = true
Caution zones from 20° Triggered caution zones
Name Description Property Type
hasMaxRollAdvice Show the caution zones. Default false. value
maxRollAdvice Largest recommended roll in degrees. Only shown when hasMaxRollAdvice is true. value
triggerRollAdvice Draw the caution zones in the caution colour. Default false. value

arcAngle and zoomToFitArc work as described in Arc and Zoom. Here the arc is ±20°, enlarged to fill the box (the blue frame):

Arc of ±20° enlarged to fill the box

Name Description Property Type
arcAngle Reach of the scale to each side, in degrees. Default 45. value
zoomToFitArc Enlarge the arc to fill the box. Default false. value

vesselImageFore selects the vessel in the centre, from the same list as the Pitch’s vessel image. The Roll shows the vessel from the fore, so use a fore view:

psv-fore (default) cargo-fore
Supply vessel Cargo vessel
tanker-fore car-ferry-fore
Tanker Car ferry

The other views from ahead or astern are cargo-wind-fore, psv-aft, car-ferry-aft, drone-generic-front, drone-medium-front, drone-small-front and rov-front.

scaleForeImage enlarges the vessel image: 2 draws it twice the size.

scaleForeImage = 1 (default) scaleForeImage = 2
Vessel at normal size Vessel twice the size
Name Description Property Type
vesselImageFore Vessel drawn in the centre. Default psv-fore. value
vesselImageForeSrc Your own vessel image instead of vesselImageFore. See Custom Vessel Image. object
scaleForeImage Size factor for the vessel image. Default 1. value

hasReadout, label, unit and fractionDigits show the roll as a number in place of the vessel, as described in Readout. label and unit are empty for a new Roll; here they are Roll and DEG:

Roll with a readout

Name Description Property Type
hasReadout Show the roll as a number instead of the vessel. Default false. value
label Text under the number. Default Roll. value
unit Unit after the label. Default DEG. value
fractionDigits Number of decimals. Default 0. value

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

  • Priority — priority.
  • Size — the Roll fills the smaller side of its box as a circle; it has no faceDiameter.
  • Style and Events — style.

The Roll has no state property.

The Roll has no component events of its own.

  1. Drop a Roll into the view and make it about 300 × 300 px.
  2. Bind roll to [default]Motion/Roll, and minAvgRoll and maxAvgRoll to the lowest and highest roll of the last minute.
  3. Set hasMaxRollAdvice to true and maxRollAdvice to 20.
  4. Bind triggerRollAdvice to the expression abs({[default]Motion/Roll}) > 20.
  5. Set vesselImageFore to cargo-fore for a cargo vessel such as MS Nordkapp.

Built on the OpenBridge Design System