ARINC661 mapUI configuration

The mapUI configuration file specifies the characteristics of the MapItems for the CDS. This definition is an XML file which is defined in the properties file with the properties named mapUI.

Grammar

See the MapItemsUI configuration Schema.

Structure

The MapItemsUI configuration file has the following structure:

• One constants element which specifies constants that can be used in the file
• paint elements specifying the colors for the fill and stroke of MapItems
• symbol elements specifying the symbols used in MapItems
• property elements specifying the global properties used for all MapItems
• mapItem elements specifying the properties for each MapItem

constants element

The constants element specifies constants that can be reused in the file. There are two types of constants:

• itemStyleConstant elements which will link a name to an ItemStyle value
• symbolTypeConstant elements which will link a name to an Symbol index

For example:

      <constants>
         <symbolTypeConstant value="1" name="Waypoint" />
         <itemStyleConstant value="4" name="TheBlinkingStyle" />
      </constants>
      ...
      <symbol id="Circle_20" deltaX="10" deltaY="10" insetsTop="10" insetsRight="30" insetsBottom="30" insetsLeft="10">
         <path path="a0,0,20,20,0,360 c"/>
      </symbol>
      ...      
      <mapItem arincID="A661_SYMBOL_GENERIC">
         <styleSet regex="TheBlinkingStyle" >
            <property name="blinking" type="blinking" value="DefaultBlinking" />
         </styleSet>
         <symbolRef type="Waypoint" symbol="Circle_20"/>
      </mapItem>

paint elements

The paint elements specify the colors for the fill and stroke of MapItems. There are two kinds of paint:

• A paint referencing a color. The color can be a color index or name as defined in the ARINC661 graphics definition. For example:

           <paint id="1" name="red">
              <color value="red" />
           </paint>
  

• A paint referencing a texture. For example:

              <paint id="2" name="warning">
                 <texture path="warning.png" />
              </paint>  
              <paint id="3" name="warningAnchored">
                 <texture path="warning.png">
                    <anchor width="10" height="10" />
                 </texture>
              </paint>
  

symbol elements

The symbol elements specify symbol shapes which will be shown for MapItem SymbolType properties.

The attributes of this element are:

• id: the only mandatory attribute, specified the id of the Symbol (which is referenced by the SymbolType property)
• deltaX and deltaY: the delta X and delta Y position in 1/100 of mm, of the symbol relative to its reference position (0 by default)
• segmentDX and segmentDY: the delta X and delta Yposition in 1/100 of mm, of the symbol variable part, only used for A661_SYMBOl_TARGET MapItems (0 by default)
• deltaAngle: the angle of the Symbol relative to its specification (0 by default)
• insetsTop, insetsRight, insetsBottom, insetsLeft: defines the touch area for the Symbol

This element has one or several children:

• path which defines a path
• dfSymbol which references a Symbol defined in the ARINC661 symbol definition library

For example:

      <symbol id="navWaypoint" deltaX="10" deltaY="10">
         <path path="a0,0,20,20,0,360 c"/>
      </symbol>
      <symbol id="recWaypoint" deltaX="10">
         <path path="m0,0 0,20 20,20 20,0 c"/>
      </symbol>

Syntax for a path

The syntax for a path is:

• x,y: denotes a segment from the current point to the (x, y) point
• mx,y: denotes a move to the (x, y) point
• c: denotes the closing of the path. may only appear at the end of the path definition
• ax,y,dx,dy,startAngle,angleExtend: denotes an ArcCircle with the center (x, y), the diameter (dx, dy), the start angle startAngle, the angle extent angleExtent, and the radius r
• ax,y,dx,dy,startAngle,angleExtend,(o|c|p): denotes an ArcCircle with the center (x, y), the start angle startAngle, the angle extent angleExtent, and the type of Arc derived from the last letter (Open, Chord, Pie)

property elements

The property elements defined global properties defined for all the MapItems.

mapItem elements

The mapItem elements specify the properties of a MapItem. Each of these elements are referenced by the ARINC ID of thir associated mapItem and contain:

• One or several styleSet elements specifying the properties for each ItemStyle applying to this MapItem
• One or several symbolRef elements specifying the symbols referenced by the SymbolType property for this MapItem^[1]
  Of course, this will only be used for MapItems which have a SymbolType property

There are several types of properties:

• color property which define the color of the MapItem. The color will reference a paint element. For example:

                 <property name="color" type="color" value="white" />
  

• border property which are only used for Legends and define if the Legend has a border. For example:

              <property name="border" type="bool" value="true" />
  

• backgroundIndex property which are only used for Legends and define the background of the Legend. For example:

              <property name="backgroundIndex" type="int" value="red" />
  

• underline property which are only used for Legends and define if the Legend is underlined. For example:

              <property name="underline" type="bool" value="true" />
  

• font property which are only used for Legends and define the Font of the Legend^[2]
  As defined in the ARINC661 graphics definition
  . For example:

              <property name="font" type="font" value="t3" />
  

For example:

         <mapItem arincID="A661_SYMBOL_GENERIC">
            <styleSet regex="0" >
               <property name="color" type="color" value="green" />
            </styleSet>
            <styleSet regex="1">
               <property name="color" type="color" value="white" />
            </styleSet> 
            <symbolRef type="0" symbol="navWaypoint" />
         </mapItem>

Example

The following file is a simple example of a MapItemsUI configuration file:

      <mapItemsUI>
         <paint id="1" name="red">
            <color value="red" />
         </paint>               
         <symbol id="navWaypoint" deltaX="10" deltaY="10">
            <path path="a0,0,20,20,0,360 c"/>
         </symbol>     
         <property name="selectionArea" type="int" value="10" />
         <property name="selectionOnHighlight" type="bool" value="true" />
         <property name="highlightedColor" type="color" value="yellow" />
         <property name="lineStyle" type="lineStyle" value="plain" />
         <property name="legendDeltaX" type="int" value="10" />
         <property name="legendDeltaY" type="int" value="10" />     
         <mapItem arincID="A661_LEGEND">
            <styleSet regex="0">
               <property name="color" type="color" value="yellow" />
               <property name="underline" type="bool" value="false" />
               <property name="font" type="font" value="t3" />
               <property name="border" type="bool" value="false" />
               <property name="backgroundIndex" type="int" value="NULL" />
            </styleSet>
         </mapItem>
         <mapItem arincID="A661_LINE_SEGMENT">
            <styleSet regex="0">
               <property name="color" type="color" value="green" />
            </styleSet>
            <styleSet regex="1">
               <property name="color" type="color" value="white" />
            </styleSet>           
         </mapItem>   
         <mapItem arincID="A661_SYMBOL_GENERIC">
            <styleSet regex="0" >
               <property name="color" type="color" value="green" />
            </styleSet>
            <styleSet regex="1">
               <property name="color" type="color" value="white" />
            </styleSet> 
            <symbolRef type="0" symbol="navWaypoint" />
         </mapItem>
         <mapItem arincID="A661_SYMBOL_GENERIC_INTERACTIVE">
            <styleSet regex="0" >
               <property name="color" type="color" value="green" />
            </styleSet>
            <styleSet regex="1">
               <property name="color" type="color" value="white" />
            </styleSet> 
            <symbolRef type="0" symbol="navWaypoint" />
         </mapItem>   
      </mapItemsUI>