Skip to content

Compass Sector

The Compass Sector shows the part of the compass rose around the heading on a fixed 120° arc, with the heading at the top. It takes less room than a full Compass and shows the headings near the current one in more detail. It is found in the Maritime - OpenBridge section of the Perspective Component Palette as Compass Sector.

Compass Sector with a setpoint and a rate-of-turn bar

The parts of the instrument:

  1. Scale — the headings around the current one, with north marked by a grey triangle when it is in view. See Heading and Course.
  2. Heading and course arrows — the filled arrow is the heading (HDG), always at the top; the outlined arrow is the course over ground (COG).
  3. Setpoint — the ordered heading. See Heading Setpoint.
  4. Rate of turn — dots or a bar. See Rate of Turn.

The Compass Sector is one of the maritime instruments. State, priority, setpoints, advice zones and sizing are described in Maritime Instruments — Common Features. This page covers what is specific to the Compass Sector. The straight form is the Compass Flat.

A Compass Sector dropped from the palette shows heading and course 0°:

Compass Sector with default properties

Bind heading to the heading of the vessel and courseOverGround to its course over ground, both in degrees.

The shape of the arc never changes, but the range of headings on it does: the arc covers at least minFOV degrees, and widens by itself so that the course arrow always stays on it. The tickmarks and labels follow the range.

Course 12° from the heading Course 60° from the heading minFOV = 90
Course close to the heading Course far from the heading A wider minimum range

tickmarksInside moves the labels inside the arc:

Compass Sector with the labels inside

Name Description Property Type
heading Heading of the vessel in degrees. Default 0. value
courseOverGround Course over ground in degrees. Default 0. value
minFOV Smallest range of headings shown on the arc, in degrees. Default 30. value
tickmarksInside Place the labels inside the arc. Default false. value

The heading setpoint works as on the Compass; see Compass — Heading Setpoint and Setpoint. Set headingSetpoint to the ordered heading; leave it empty for no setpoint. The Compass Sector decides by itself when the setpoint is reached (autoAtHeadingSetpoint is true, with a deadband of 2°).

Setpoint at 60° Reached A new setpoint being chosen
Compass Sector with a setpoint Compass Sector at its setpoint Compass Sector with a new setpoint

advices is a list of advice zones, with min and max as headings in degrees. A zone is drawn only where it falls inside the range shown:

Compass Sector with a caution zone from 55° to 70°

A zone is triggered when the heading or the heading setpoint is inside it; adviceTrigger narrows that to the heading (value) or the setpoint alone. headingAdvices is the older name of the list. It still works, and when it is not empty it replaces advices, but use advices.

Name Description Property Type
headingSetpoint Ordered heading in degrees. Empty by default: no setpoint. value
autoAtHeadingSetpoint Let the instrument decide when the setpoint is reached. Default true. value
autoAtHeadingSetpointDeadband Degrees the heading may differ from the setpoint and still count as reached. Default 2. Only shown when autoAtHeadingSetpoint is true. value
atHeadingSetpoint Whether the setpoint is reached. Only shown when autoAtHeadingSetpoint is false. value
touching The operator is operating the heading control. Default false. value
hasNewHeadingSetpoint Show a second marker for a setpoint that is being chosen. Default false. value
newHeadingSetpoint The setpoint being chosen. Only shown when hasNewHeadingSetpoint is true. value
animateSetpoint Animate the marker when a new setpoint is confirmed. Default false. value
headingSetpointAtZeroDeadband How close to zero the setpoint must be to be drawn in its “zero” form. Default 0.5. value
headingSetpointOverride Keep the setpoint in its normal colour in the loading and off states. Default false. value
advices Advice zones on the arc, with min and max in degrees. Empty by default. array
adviceTrigger Which reading triggers a zone: both (the heading or the setpoint), value (the heading) or setpoint. Default both. value
adviceEmphasis Apply the design’s emphasis rules between go-to and no-go zones. Default false. value
headingAdvices Deprecated, use advices. Still works: when not empty, it replaces advices. array

The rate of turn works as on the Compass; see Compass — Rate of Turn for rotType, rotPosition, rotMaxValue, rotPortStarboard and the deprecated rotationsPerMinute. The indicator is clipped to the arc:

rotType rotPosition = innerCircle (default) rotPosition = scale
dots (default) Dots on the inner circle Dots on the scale
bar Bar on the inner circle Bar on the scale

With rotPortStarboard the bar is green for a turn to starboard and red for a turn to port:

Rate-of-turn bar in the starboard colour

The Compass Sector has no rotArcExtent: a full bar reaches the end of the arc.

Note: The rate-of-turn indicator cannot be turned off. As on the Compass, a new Compass Sector uses the deprecated rotationsPerMinute of 0 until hasRateOfTurnDegreesPerMinute is set, so its dots stand still until you bind the rate of turn.

Name Description Property Type
rotType dots or bar. Default dots; auto leaves the choice to the component. value
rotPosition innerCircle or scale. Default innerCircle. value
hasRateOfTurnDegreesPerMinute Use rateOfTurnDegreesPerMinute. Default false. value
rateOfTurnDegreesPerMinute Rate of turn in degrees per minute; positive is starboard. Only shown when hasRateOfTurnDegreesPerMinute is true. value
rotDotAnimationFactor How much faster than the real rate the dots move. Default 18. value
rotMaxValue Rate of turn, in degrees per minute, at which the bar is full. Default 60. Only shown when rotType is bar. value
rotAtZeroDeadband Rate of turn below which the bar is shown as zero. Default 0.05. Only shown when rotType is bar. value
rotPortStarboard Colour the bar by the direction of the turn. Default false. value
rotationsPerMinute Deprecated. Used when hasRateOfTurnDegreesPerMinute is false. Default 0. value

Set hasReadout to true to show the heading as a number under the top of the arc. label and unit are written under the number:

hasReadout = true label and unit cleared
Compass Sector with a readout, label and unit Readout, number only

Note: A new Compass Sector has label HDG and unit DEG; clear them to show the number only. The readout is drawn over the arrows and the dots on the inner circle: use rotPosition scale with a readout.

Name Description Property Type
hasReadout Show the heading as a number. Default false. value
label Text under the number. Default HDG. Only shown when hasReadout is true. value
unit Unit after the label. Default DEG. Only shown when hasReadout is true. value
fractionDigits Number of decimals. Default 0. Only shown when hasReadout is true. value

state and priority work as described in State and Priority. In the images the setpoint is at 60°:

active loading off
Active Loading Off

With priority enhanced, priorityElements selects which parts get the enhanced colour: a list of hdg, cog and rot. A new Compass Sector lists hdg. The setpoint is drawn in the enhanced colour whatever the list holds. The property is only shown when priority is enhanced.

priority = enhanced, priorityElements empty priorityElements = ["hdg"] (the default)
Enhanced, nothing listed Heading in the enhanced colour
Name Description Property Type
priorityElements Parts drawn in the enhanced colour: hdg, cog, rot. Default ["hdg"]. Only shown when priority is enhanced. array

The arc grows with the component’s box and is centred near the top of it, leaving room under it for the inner circle and the readout. Set zoomToFitArc to true to enlarge the arc so that it fills the width of the box; the inner circle, with the rate-of-turn dots, is then left out. The blue frame is the component’s box:

zoomToFitArc = false zoomToFitArc = true
Arc at its normal size Arc enlarged
Name Description Property Type
zoomToFitArc Enlarge the arc to fill the box. Default false. value

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

The Compass Sector has no component events of its own.

Example 1 — Heading Sector for an Autopilot

Section titled “Example 1 — Heading Sector for an Autopilot”
  1. Drop a Compass Sector into the view and make it 400 × 280.
  2. Bind heading to [default]Nav/Heading and courseOverGround to [default]Nav/COG.
  3. Bind headingSetpoint to [default]Autopilot/HeadingOrder.
  4. Set hasRateOfTurnDegreesPerMinute to true, bind rateOfTurnDegreesPerMinute to [default]Nav/ROT, set rotType to bar and rotPosition to scale.
  5. Set hasReadout to true, label to HDG and unit to DEG.

Built on the OpenBridge Design System