direction indicator
The direction indicator module is used to place a 3D North Arrow or Compass Rose in the 3D viewer scaled by the model data and/or user defined parameters.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Z Scale | Number | The factor for vertical scaling. |
| Output | Output Object | Renderable | A renderable object displaying a north arrow or compass rose. |
Properties
| Property | Type | Description |
|---|---|---|
| Visible | Visibility | Controls the visibility of the object. Excluded prevents inclusion in supported exports. Locked makes the object always visible in supported exports. |
| Z Scale | Double | The Z Scale is the vertical exaggeration to be applied to the input field and this is used to determine default sizes and positions. |
| Display Type | Choice: North Arrow, Compass Rose | The Display Type allows the user to select between a north arrow and a compass rose as output. |
| X Center | Double | The X center of the chosen display type object. |
| Y Center | Double | The Y center of the chosen display type object. |
| Z Center | Double | The Z center of the chosen display type object. |
| Height Factor | Double | The Height Factor scales the vertical height of the output object. |
North Arrow Settings
| Property | Type | Description |
|---|---|---|
| Arrow Size | Double | The Arrow Size scales the size in all dimensions of the output object. |
| Arrow Bevel | Double | The Arrow Bevel affects the degree of bevelling on the north arrow. |
| Stem Width | Double | The Stem Width affects the width of the arrow’s stem (shaft). |
| Stem Length | Double | The Stem Length Factor affects the length of the arrow’s stem (shaft). |
| Triangle Base Factor | Double | The Triangle Base Factor affects the width of the arrow’s head. |
| North Color | Color | The North Arrow is a solid color which can be selected using this control. |
Compass Rose Settings
| Property | Type | Description |
|---|---|---|
| Rose Size | Double | The Rose Size scales the output object in all dimensions. |
| North Length | Double | The North Length Factor allows you to exaggerate the length of the north pointing shaft. |
| Sub Cardinal Length | Double | The Sub-Cardinal Length Factor controls the length of the 45 degree shafts relative to the primary shafts. |
| Inner Radius Factor | Double | The Inner Radius Factor controls the radius of the solid core section. |
| Primary Color | Color | The compass rose is made of two colors; the first can be set using this control. |
| Secondary Color | Color | The compass rose is made of two colors; the second can be set using this control. |
Label Settings
| Property | Type | Description |
|---|---|---|
| Label Type | Choice: TrueType Fonts, Line Fonts | The Label Type allows the user to select between two font types. TrueType fonts are standard fonts. Line fonts are low impact fonts which perform better when large numbers of labels are generated. |
| Font Base Scale | Double | The Font Base Scale affects the size of all text objects. |
| Flip Labels | Boolean | Flip Labels makes the text readable from the underside. |
| TrueType Font Style | Font | The TrueType Font Style allows the user to alter the basic look of the font. |
| Font Color | Color | The Font Color allows the user to set the value for the color of the Font. |
| North Label | Cardinal | The North Label sets all values related to the text on the North end of either the compass rose or the north arrow. |
| East Label | Cardinal | The East Label sets all values related to the text on the East end of the compass rose. |
| South Label | Cardinal | The South Label sets all values related to the text on the South end of the compass rose. |
| West Label | Cardinal | The West Label sets all values related to the text on the West end of the compass rose. |
| Sub Cardinal Labels | Sub Cardinal | The Sub Cardinal Labels control sets all values related to the text at the sub cardinal directions of the compass rose. |