Located in ./GitHub/RailCOMPLETE-DNA-[XX-YY]/[XX-YY]/Lua/LuaTooltipPages
.
Controls the custom tooltips found right above the RC-ShowLayerGroups
button in the ribbon inside RailCOMPLETE.
For each custom tooltip that you want define, you have to:
- Create an XML file for that tooltip,
- add a corresponding image to the image file, and
- create a corresponding tooltip view.
Creating custom tooltip XML files
Open a text editor and add a LuaTooltip element. Save the file as XML in the LuaTooltipPages folder.
Here is an example of a LuaTooltip:
<LuaTooltip Name = "Alignment Info"
TooltipMode = "ClosestAlignment"
Description = "Shows local alignment data (geometry, profile, cant, design speed, Vmax etc). Hover over object to activate."
Icon = "showRelationToolTip">
<Xaml>Lua\\LuaTooltipPages\\TooltipViews\\NO-BN-AlignmentInfo.xaml</Xaml>
</LuaTooltip>
Make sure that the Xaml element corresponds to a tooltip view file (see below).
LuaTooltip attributes
- Name (Mandatory): The name of the custom tooltip.
- TooltipMode (Mandatory): Decides when the tooltip is displayed. It has the following options:
- MouseOver: The tooltip is displayed for a given object whenever the user hovers their cursor over it.
- ClosestAlignment: The cursor position is projected onto the closest alignment, and the tooltip is displayed for that point.
- Select: The tooltip is shown for the (first) selected object.
- TooltipPlacement (Optional): Controls the placement of the tooltip relative to the user’s cursor. It has the following options:
- TopRight (default),
- TopLeft,
- BottomRight, and
- BottomLeft.
- Description (Optional): The descriptive text that will be displayed inside RailCOMPLETE to explain the tooltip to users.
- Icon (Optional): A reference to an icon in the image file. Controls the icon displayed to the left of the tooltip name inside RailCOMPLETE.
- SubTooltipOf (Optional): The name of another custom tooltip. If specified then that tooltip will act as a folder with this tooltip in it.
- TooltipImage (Optional): [Explanation]