Setting: Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{stub|todo=
* Article intro is very short. Where to adjust? Implications of settings being an item rather than a client application property, etc.
* A number of settings are missing descriptions.
* Currently just a list of settings and very brief descriptions. Settings should have their own page for organizing relations to other data and functionalities.
}}
Setting is an item that stores configuration properties of your project.
Setting is an item that stores configuration properties of your project.


===List of available settings===
===List of available settings===
{|
{|class="wikitable"
! Name
! Name
! Default value
! Default value
! Description  
! Description  
|-
|-
| ACTIVE_SCENARIO
| <span id="ACTIVE_SCENARIO">ACTIVE_SCENARIO</span>
| 0
| 0
| Stores the id of the active [[scenario]].
| Stores the id of the active [[scenario]].
|-
|-
| AREA_GROUPS
| <span id="AREA_GROUPS"> AREA_GROUPS</span>
|  
|  
| Used to store Area attribute filters
| Used to store Area attribute filters
|-
|-
| AUTO_CALCULATION
| <span id="AUTO_CALCULATION">AUTO_CALCULATION</span>
| true
| true
| Whether changes made to the project automatically trigger a recalculation of a project.
| Whether changes made to the project automatically trigger a recalculation of a project.
|-
|-
| BASE_PANELS
| <span id="BASE_PANELS">BASE_PANELS </span>
| HOVER_PANEL NAVIGATION_PANEL TOPBAR_PANEL LEFT_MENU_PANEL FEEDBACK_PANEL
| HOVER_PANEL NAVIGATION_PANEL TOPBAR_PANEL LEFT_MENU_PANEL FEEDBACK_PANEL
| Panels that are considered base panels in the {{user interface}}
| Panels that are considered base panels in the [[Viewer ]]interface.
|-
|-
| CAMERA_SPEED
| <span id="CAMERA_SPEED">CAMERA_SPEED </span>
| NORMAL
| NORMAL
|  
| Camera Speed (SLOW, NORMAL)
|-
|-
| CURRENCY
| <span id="CURRENCY">CURRENCY </span>
| EURO
| EURO
| Currency that is used in your [[project]].
| Currency that is used in your [[project]].
|-
|-
| CUSTOM_DATA_SERVICE
| <span id="CUSTOM_DATA_SERVICE">CUSTOM_DATA_SERVICE </span>
|  
|  
|  My own CSW service
|  My own [[CSW]] service
|-
|-
| DECIMALS
| <span id="DECIMALS">DECIMALS</span>
| 6
| 6
|  
| Decimal accuracy used in attributes and function values
|-
|-
| DEFAULT_GROUNDPRICE_M2
| <span id="DEFAULT_GROUNDPRICE_M2">DEFAULT_GROUNDPRICE_M2</span>
| 400
| 400
|  
| Default price of one m2 ground in euro
|-
|-
| DEFAULT_GROUND_LOWER_PRICE_M3
| <span id="DEFAULT_GROUND_LOWER_PRICE_M3" >DEFAULT_GROUND_LOWER_PRICE_M3</span>
| 50
| 50
|  
| Default price in EUR to lower one m3 ground
|-
|-
| DEFAULT_GROUND_RAISE_PRICE_M3
| <span id="DEFAULT_GROUND_RAISE_PRICE_M3" >DEFAULT_GROUND_RAISE_PRICE_M3</span>
| 50
| 50
|  
| Default price in EUR to raise one m3 ground
|-
|-
| DETAILED
| <span id="DETAILED" >DETAILED</span>
| true
| true
|  
| High detail project.
|-
|-
| EXPORT_CRS
| <span id="EXPORT_CRS" >EXPORT_CRS</span>
| EPSG:3857
| EPSG:3857
|  
| The default export CRS for your project for situations in the {{software}} where it currently cannot be selected.
|-
|-
| GRID_CELL_SIZE_M
| <span id="GRID_CELL_SIZE_M">GRID_CELL_SIZE_M</span>
| 2
| 2
|  
| Grid cell size in meters, default is 2
|-
|-
| IMPORT_CRS
| <span id="IMPORT_CRS" >IMPORT_CRS</span>
|
|  
|  
| The last selected import CRS, selected automatically for files imported into your project in the {{software}}
|-
|-
| IMPORT_CRS_FORCE_XY
| <span id="IMPORT_CRS_FORCE_XY" >IMPORT_CRS_FORCE_XY</span>
| true
| true
|  
| The last selected import "force xy" (=longitude first) option, selected automatically for files imported into your project in the {{software}}
|-
|-
| LIMIT_MAP
| <span id="LIMIT_MAP" >LIMIT_MAP</span>
| MULTIPOLYGON EMPTY
| MULTIPOLYGON EMPTY
|  
| The geometry that is used to limit the data obtained during [[New_Project_Wizard|''New Project generation'']].
|-
|-
| MAP_SIZE_M
| <span id="MAP_SIZE_M" >MAP_SIZE_M</span>
| 0 0
| 0 0
|  
| Map size in X and Y in meters, default 0 (no map)
|-
|-
| MAX_TOTAL_GRIDCELLS
| <span id="MAX_TOTAL_GRIDCELLS" >MAX_TOTAL_GRIDCELLS</span>
| 0
| 0
| Used to communicate the maximum amount of [[grid cell]]s that your [[project]] can support.
| Used to communicate the maximum amount of [[grid cell]]s that your [[project]] can support.
|-
|-
| MEASUREMENT_SYSTEM_TYPE
| <span id="MEASUREMENT_SYSTEM_TYPE" >MEASUREMENT_SYSTEM_TYPE</span>
| SI
| SI
|  
| The [[unit system]] used in the [[{{software|client}}]] for this project.
|-
|-
| MIN_CELL_M
| <span id="MIN_CELL_M" >MIN_CELL_M</span>
| 0
| 0
|  
| Minimum cell size in meters
|-
|-
| MODEL_STYLE
| <span id="MODEL_STYLE" >MODEL_STYLE</span>
| TEXTURED
| TEXTURED
|  
| The [[Building style|model style]] of the [[building]]'s in the [[3D Visualization]].
|-
|-
| PROJECT_NAME
| <span id="PROJECT_NAME" >PROJECT_NAME</span>
| Project Name
| Project Name
| The Project's name
| The Project's name
|-
|-
| RECALCULATION_REQUIRED
| <span id="RECALCULATION_REQUIRED" >RECALCULATION_REQUIRED</span>
| false
| false
| A setting that is set by the {{software}} to indicate this project required a recalculation.
| A setting that is set by the {{software}} to indicate this project required a recalculation.
|-
|-
| RECENT_CRSS
| <span id="RECENT_CRSS" >RECENT_CRSS</span>
| EPSG:3857 EPSG:28992
| EPSG:3857 EPSG:28992
|  
| A list of CRS's that have been used while [[editor|editing]] your project. Shows in the "recently used" part of the ''crs selection panel''.
|-
|-
| REGION
| <span id="REGION" >REGION</span>
| NORTHWESTERN_EUROPE
| NORTHWESTERN_EUROPE
|  
| Stores the [[Function#Regions|Region]] your project is situated in. Can be overwritten using this setting.
|-
|-
| RESERVED_LAND
| <span id="RESERVED_LAND" >RESERVED_LAND</span>
| MULTIPOLYGON EMPTY
| MULTIPOLYGON EMPTY
|  
| Setting that stores the geometries of [[plot]]s that are currently in transition of [[ownership]].
|-
|-
| SATELLITE_BRIGHTNESS
| <span id="SATELLITE_BRIGHTNESS" >SATELLITE_BRIGHTNESS</span>
| -1
| -1
|  
|  
|-
|-
| SATELLITE_COLOR
| <span id="SATELLITE_COLOR" >SATELLITE_COLOR</span>
|  
|  
|  
|  
|-
|-
| SATELLITE_FILE_NAME
| <span id="SATELLITE_FILE_NAME" >SATELLITE_FILE_NAME</span>
| default
| default
|  
|  
|-
|-
| SCHEDULED_UPDATE
| <span id="SCHEDULED_UPDATE" >SCHEDULED_UPDATE</span>
|  
|  
|  
|  
|-
|-
| SCHEDULED_UPDATE_MAIL
| <span id="SCHEDULED_UPDATE_MAIL" >SCHEDULED_UPDATE_MAIL</span>
|  
|  
|  
|  
|-
|-
| SCHEDULED_UPDATE_SMS
| <span id="SCHEDULED_UPDATE_SMS" >SCHEDULED_UPDATE_SMS</span>
|  
|  
|  
|  
|-
|-
| SDK_ACCESS
| <span id="SDK_ACCESS" >SDK_ACCESS</span>
| false
| false
|  
| Currently not used
|-
|-
| SECTOR_SIZE_M
| <span id="SECTOR_SIZE_M" >SECTOR_SIZE_M</span>
| 500
| 500
|  
| The width and height of a [[Height sector]] in meters.
|-
|-
| SHOW_ACTION_LOG
| <span id="SHOW_ACTION_LOG"> SHOW_ACTION_LOG</span>
| true
| true
|  
|  
|-
|-
| SHOW_BUILDING_AND_MEASURE_POPUP
| <span id="SHOW_BUILDING_AND_MEASURE_POPUP">SHOW_BUILDING_AND_MEASURE_POPUP</span>
| false
| false
|  
|  
|-
|-
| SHOW_WATER_POPUP
| <span id="SHOW_WATER_POPUP">SHOW_WATER_POPUP </span>
| false
| false
|  
|  
|-
|-
| SKY_TYPE
| <span id="SKY_TYPE">SKY_TYPE </span>
| DEFAULT
| DEFAULT
|  
| Determines the type of sky box used in the [[3D Visualization]]. Configurable in the [[Environment]] panel.
|-
|-
| SOLAR_PANEL_POSITION
| <span id="SOLAR_PANEL_POSITION">SOLAR_PANEL_POSITION </span>
| 0.0 -0.5 -1.0
| 0.0 -0.5 -1.0
|  
|  
|-
|-
| STATE
| <span id="STATE">STATE </span>
| NOTHING
| NOTHING
|  
|  
|-
|-
| SUN_DATES
| <span id="SUN_DATES"> SUN_DATES</span>
|
|  
|  
| Dates stored as long values representing times in UTC milliseconds from the epoch. Used by [[Sun angle]].
|-
|-
| SUPER_USER_MESSAGE
| <span id="SUPER_USER_MESSAGE">SUPER_USER_MESSAGE</span>
|  
|  
|  
|  
|-
|-
| SURROUNDING_MAP_EXTEND_M
| <span id="SURROUNDING_MAP_EXTEND_M" >SURROUNDING_MAP_EXTEND_M</span>
| 0 0
| 0 0
|  
|  
|-
|-
| TIMESTAMP_FORMAT
| <span id="TIMESTAMP_FORMAT" >TIMESTAMP_FORMAT</span>
| dd/MM HH:mm:ss
| dd/MM HH:mm:ss
|  
|  
|-
|-
| TIME_ZONE
| <span id="TIME_ZONE">TIME_ZONE</span>
|  
| Etc/UTC
|  
| Automatically set based on the project's location when [[New Project Wizard|creating a new project]].
|-
|-
| TRAFFIC_VISUAL_MULTIPLIER
| <span id="TRAFFIC_VISUAL_MULTIPLIER" >TRAFFIC_VISUAL_MULTIPLIER</span>
| 4.0
| 4.0
|  
| Multiplier used by the traffic visualization system, to make it seem busier.
|-
|-
| WATER_HEIGHT
| <span id="WATER_HEIGHT" >WATER_HEIGHT</span>
| -20000.0
| -20000.0
|  
|  
|-
|-
| WATER_TYPE
| <span id="WATER_TYPE" >WATER_TYPE</span>
| CANAL
| CANAL
|  
| Used in the visualization system of water in the [[3D Visualization]]. Configurable using [[Environment#Water Type|Water Type]] in the [[Environment]] editor panel.
|-
|-
| WEB_ALLOW_LOGIC_EVENT
| <span id="WEB_ALLOW_LOGIC_EVENT" >WEB_ALLOW_LOGIC_EVENT</span>
| true
| true
|  
|  
|-
|-
| WEB_ALLOW_PARTICIPANT_EVENT
| <span id="WEB_ALLOW_PARTICIPANT_EVENT" >WEB_ALLOW_PARTICIPANT_EVENT</span>
| true
| true
|  
|  
|-
|-
| WEB_ALLOW_QUERIES
| <span id="WEB_ALLOW_QUERIES">WEB_ALLOW_QUERIES</span>
| false
| false
|  
|  
|-
|-
| WEB_BASE_MAP
| <span id="WEB_BASE_MAP">WEB_BASE_MAP</span>
| SATELLITE
| SATELLITE
|  
|  
|-
|-
| WEB_FRONT_PANEL
| <span id="WEB_FRONT_PANEL">WEB_FRONT_PANEL</span>
| -1
| -1
|  
|  
|-
|-
| WEB_MAP_CUSTOM_PANEL
| <span id="WEB_MAP_CUSTOM_PANEL">WEB_MAP_CUSTOM_PANEL</span>
| -1
| -1
|  
|  
|-
|-
| WIND_DIRECTION
| <span id="WIND_DIRECTION" >WIND_DIRECTION</span>
| 135
| 135
|  
|  
|-
|-
| WIND_SPEED_M_PER_S
| <span id="WIND_SPEED_M_PER_S">WIND_SPEED_M_PER_S</span>
| 5.0
| 5.0
|  
|  
|-
|-
| WIZARD_TIME_MINUTES
| <span id="WIZARD_TIME_MINUTES">WIZARD_TIME_MINUTES </span>
| -1
| -1
|  
|  
|-
|-
| WORLD_REFERENCE_POINT
| <span id="WORLD_REFERENCE_POINT">WORLD_REFERENCE_POINT </span>
| 0 0
| 0 0
|  
|  
|-
| <span id="ITERATIONS">ITERATIONS </span>
| 1
| Amount of times the [[Simulation Core]] steps are executed each update.
|}
|}




{{article end}}
{{article end}}

Latest revision as of 07:35, 15 November 2024

This article is a stub. The following information should be added:
  • Article intro is very short. Where to adjust? Implications of settings being an item rather than a client application property, etc.
  • A number of settings are missing descriptions.
  • Currently just a list of settings and very brief descriptions. Settings should have their own page for organizing relations to other data and functionalities.

Setting is an item that stores configuration properties of your project.

List of available settings

Name Default value Description
ACTIVE_SCENARIO 0 Stores the id of the active scenario.
AREA_GROUPS Used to store Area attribute filters
AUTO_CALCULATION true Whether changes made to the project automatically trigger a recalculation of a project.
BASE_PANELS HOVER_PANEL NAVIGATION_PANEL TOPBAR_PANEL LEFT_MENU_PANEL FEEDBACK_PANEL Panels that are considered base panels in the Viewer interface.
CAMERA_SPEED NORMAL Camera Speed (SLOW, NORMAL)
CURRENCY EURO Currency that is used in your project.
CUSTOM_DATA_SERVICE My own CSW service
DECIMALS 6 Decimal accuracy used in attributes and function values
DEFAULT_GROUNDPRICE_M2 400 Default price of one m2 ground in euro
DEFAULT_GROUND_LOWER_PRICE_M3 50 Default price in EUR to lower one m3 ground
DEFAULT_GROUND_RAISE_PRICE_M3 50 Default price in EUR to raise one m3 ground
DETAILED true High detail project.
EXPORT_CRS EPSG:3857 The default export CRS for your project for situations in the Tygron Platform where it currently cannot be selected.
GRID_CELL_SIZE_M 2 Grid cell size in meters, default is 2
IMPORT_CRS The last selected import CRS, selected automatically for files imported into your project in the Tygron Platform
IMPORT_CRS_FORCE_XY true The last selected import "force xy" (=longitude first) option, selected automatically for files imported into your project in the Tygron Platform
LIMIT_MAP MULTIPOLYGON EMPTY The geometry that is used to limit the data obtained during New Project generation.
MAP_SIZE_M 0 0 Map size in X and Y in meters, default 0 (no map)
MAX_TOTAL_GRIDCELLS 0 Used to communicate the maximum amount of grid cells that your project can support.
MEASUREMENT_SYSTEM_TYPE SI The unit system used in the Tygron Client for this project.
MIN_CELL_M 0 Minimum cell size in meters
MODEL_STYLE TEXTURED The model style of the building's in the 3D Visualization.
PROJECT_NAME Project Name The Project's name
RECALCULATION_REQUIRED false A setting that is set by the Tygron Platform to indicate this project required a recalculation.
RECENT_CRSS EPSG:3857 EPSG:28992 A list of CRS's that have been used while editing your project. Shows in the "recently used" part of the crs selection panel.
REGION NORTHWESTERN_EUROPE Stores the Region your project is situated in. Can be overwritten using this setting.
RESERVED_LAND MULTIPOLYGON EMPTY Setting that stores the geometries of plots that are currently in transition of ownership.
SATELLITE_BRIGHTNESS -1
SATELLITE_COLOR
SATELLITE_FILE_NAME default
SCHEDULED_UPDATE
SCHEDULED_UPDATE_MAIL
SCHEDULED_UPDATE_SMS
SDK_ACCESS false Currently not used
SECTOR_SIZE_M 500 The width and height of a Height sector in meters.
SHOW_ACTION_LOG true
SHOW_BUILDING_AND_MEASURE_POPUP false
SHOW_WATER_POPUP false
SKY_TYPE DEFAULT Determines the type of sky box used in the 3D Visualization. Configurable in the Environment panel.
SOLAR_PANEL_POSITION 0.0 -0.5 -1.0
STATE NOTHING
SUN_DATES Dates stored as long values representing times in UTC milliseconds from the epoch. Used by Sun angle.
SUPER_USER_MESSAGE
SURROUNDING_MAP_EXTEND_M 0 0
TIMESTAMP_FORMAT dd/MM HH:mm:ss
TIME_ZONE Etc/UTC Automatically set based on the project's location when creating a new project.
TRAFFIC_VISUAL_MULTIPLIER 4.0 Multiplier used by the traffic visualization system, to make it seem busier.
WATER_HEIGHT -20000.0
WATER_TYPE CANAL Used in the visualization system of water in the 3D Visualization. Configurable using Water Type in the Environment editor panel.
WEB_ALLOW_LOGIC_EVENT true
WEB_ALLOW_PARTICIPANT_EVENT true
WEB_ALLOW_QUERIES false
WEB_BASE_MAP SATELLITE
WEB_FRONT_PANEL -1
WEB_MAP_CUSTOM_PANEL -1
WIND_DIRECTION 135
WIND_SPEED_M_PER_S 5.0
WIZARD_TIME_MINUTES -1
WORLD_REFERENCE_POINT 0 0
ITERATIONS 1 Amount of times the Simulation Core steps are executed each update.


Retrieved from "https://previewsupport.tygron.com/w/index.php?title=Setting&oldid=61206"