Function: Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
No edit summary
 
(114 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{learned|what functions are|how functions relate to the Tygron Engine|where functions are used|how to change existing functions|how to create your own functions}}
[[File:Api_current_situation_building.png|thumb|right|400px|[[Function]] related to [[Buildings]] and [[Function Overrides]]]]
Functions are the blueprints for [[Building]]s in your projects. They describe the purpose and basic [[Function Value|properties]] of [[Building]]s. A Function also references which model sets and colors are used in the 2D and 3D visualization. A Function is effectively a "type of Building".


==What are functions==
The properties associated with a Function are known as [[Function Value]]s
A function is the purpose of a type of building. The term function comes from urban planning jargon, when dealing with zoning plans.


==How do functions related to the Tygron Engine==
A Building in a Project is always based on one Function. Buildings with the same Function may have different locations, different heights, and different owners. But Buildings with the same Function will have the same set of [[Function Value|properties]] defining their economic, environmental, and spatial effect.
Functions are the blueprints of constructions in the [[3D world]]. They describe the purpose and properties of a [[constructions|construction]]. A function also defines which 3D model is placed in the 3D world.


When looking at a project, especially one that is generated with real world data, many constructions may be present. Some constructions may also share the same function. However, the constructions will be in different locations, and may be shaped and sized differently. They have the same functions, and as such the same properties, but the actual object can (and may well) exist in various forms.
Additionally, Functions can also be used as definitions for [[action]]s. When a Function is used as an Action, the Action will be the creation of a new Building, the Function of which is the Function which is used as Action. Some properties of the Function, such as the minimum, maximum, and default amount of floors, also affect how a [[Stakeholder]] can enact their action.


Functions are also used as definitions for [[actions]]. When defining actions, each function can be found under their related category (or categories). A function, as an action, means placing a construction in the world, with the specified function. For more information on adding functions as actions to stakeholders, see the [[actions#Changing actions and menus|editing section of actions]].
The {{software}} contains several hundred Functions.


==Types of functions==
===Function values===
Functions are also divided into function categories. A function category a more generic definition of what a construction does. For example: A function could be "Warehouses", with its category being "Industry". Functions can also be part of multiple categories. (An example of this is an apartment building with shops on the ground floor, which is both a type of housing and shops.) When selecting functions, a function can usually be found under any of the function's categories.
{{main|Function Value}}
[[File:Function_value_table.png|thumb|left|[[Function Values Table]] in the [[editor]].]]
Functions are composed of a collection of properties called [[Function Value]]s. These form the actual numeric definitions which are applied on a Building which is set to be of a certain Function. In principle, when such a value of a Building is required for a calculation, the value set in the Function is used.


A complete list of all available Function Values can be found on the [[Function Value]]s page.
{{clear}}
===Function Categories===
[[File:Function-selector.jpg|300px|thumb|left|The function selection window. This will appear whenever you need to a select a function.]]
[[File:Function-selector.jpg|300px|thumb|left|The function selection window. This will appear whenever you need to a select a function.]]
When selecting a function, often it must be a function for either a regular building, a road, or a landmark. In these cases, only the functions (and function categories) appropriate to be selected type  of construction will be available. For example: when selecting a function for a road, only functions with the road category will be available.<br clear="all">
Functions are divided into Function Categories. Where a Function itself may be "Old Warehouses", such a Function may belong to a Function Category "Industry". This categorization helps when trying to select a specific Function among the full collection of Functions. It also makes it easier to [[TQL|query]] Buildings in a Project but filtering on the purposes of the Building. Rather than creating individual queries for each Function which matches a broad usage for Buildings, a single query for a Function Category can be used.
 
Functions are always part of at least one Category, but can also be part of multiple functions. An example is a Function for a Building with shops at a bottom floor, but residences on floors above it. Or flats which contain a mix of both social and luxury housing. In these cases, the Function's Categories each have a respective weight. The Building will be considered wholly of the specified Function, but the Building will be considered "divided up" between the Categories when querying, for example, their floor size.{{clear}}
 
'''Categories: '''
 
Currently the {{software}} distinguishes the following Function Categories:
{|class=wikitable
! Category
! TQL Term
! Combinable
! Description
|-
| Affordable housing
| SOCIAL
| yes
| Affordable housing contains actions related to affordable housing: Flats (various types), Old social housing (various types), Social housing (various types), etc.
|-
| Agriculture
| AGRICULTURE
|
| Agriculture contains actions related to agriculture: Floating crops, Farms, Corn Fields etc.
|-
| Bridge
| BRIDGE
|
|
|-
| Education
| EDUCATION
| yes
| Education contains actions related to educational buildings: Basis educational buildings, emergency classrooms, labs, primary schools etc.
|-
| Gardens
| GARDEN
|
| Gardens contains actions related to gardens: Simple Garden, Normal Garden, Fenced Garden, etc.
|-
| Healthcare
| HEALTHCARE
| yes
| Healthcare contains actions related to healthcare: Healthcare farm, Healthcare hotel, Hospital, etc.
|-
| Industry
| INDUSTRY
| yes
| Industry contains actions related to industrial buildings: Biorefinery, Silo's, Warehouses, Chimney, etc.
|-
| Intersection
| INTERSECTION
|
|
|-
| Leisure
| LEISURE
|
| Leisure contains actions related to leisure buildings: Sports center, Swimming Pool, Theatre, Tennis Court, etc.
|-
| Market housing
| NORMAL
| yes
| Market Housing contains actions related to market housing: different types of housing, apartments, shops with houses, etc.
|-
| Nature
| NATURE
|
| Nature contains actions related to nature: Trees, Orchard, Reeds.
|-
| Offices
| OFFICES
| yes
| Offices contains actions related to Offices: Classic Offices, Luxurious Offices, Old Offices, Offices with shops, etc.
|-
| Other
| OTHER
|
| Other contains assorted actions: Cemetery,  Trash bins, Windmill and a few others.
|-
| Parks
| PARK
|
| Parks contains actions related to Parks: City Park, Fountain, Pocket Park, Vegetable garden, etc.
|-
| Roads
| ROAD
|
| Roads contains actions related to infrastructure and roads: Asphalt roads (various types), Bicycle path, Cobblestone roads, Train tracks, etc.
|-
| Senior housing
| SENIOR
| yes
| Senior Housing contains actions related to senior housing: Senior Housing (Standard) and Senior Housing (Luxurious).
|-
| Shops and restaurants
| SHOPPING
| yes
| Shops and restaurants contains actions related to shops and restaurants: Chip shop, Convenience store, Office with shops, Houses with Shops, etc.
|-
| Squares
| PAVED_AREA
|
| Squares contains actions related to public Squares: Parking Spaces, Playground, Watersquare, Skate park etc.
|-
| Student housing
| STUDENT
| yes
| Student Housing contains actions related to student housing: Cheap student housing, Student Housing (various types), Student Containers, etc.
|-
| Top market housing
| LUXE
| yes
| Top Market Housing contains actions related to luxurious housing: Luxury Apartments, Modern Villa, Old Villa, Monumental House, etc.
|-
| Underground
| UNDERGROUND
|
| Underground contains an action related to underground: Drainage Culvert.
|}


===Regions===
===Regions===
The Tygron Engine features many different functions. To help you with selecting the appropriate functions for your project, the available functions are filtered by region. Depending on the region, some function may be more appropriate than others. It is possible to switch between regions when selecting a function using the function selector.
[[File:Region_selection.jpg|framed|left|The region selector, to filter the available functions.]]
[[File:Region_selection.jpg|framed|left|The region selector, to filter the available functions.]]
Currently the engine distinguishes the following Regions:
To further help with finding the appropriate Function, they are also divided into regions. Based on the location of the Project, the region for the Project is set automatically. Some Functions are only available in certain regions. This is based on what region of the world the Function would be most appropriate for.
 
When selecting a Function, it is possible to change the region of the Project to gain access to the Functions of other regions. It is possible to Mix Functions of various regions freely.{{clear}}
 
'''Regions: '''
 
Currently the {{software}} distinguishes the following regions:
* Africa
* Africa
* Asia
* Asia
Line 26: Line 153:
* Northwestern Europe
* Northwestern Europe
* Other
* Other
<!--===Example use===
Each [[constructions|construction]] in the [[3D World]] can have an effect on indicators, for example the livability. Let's take the project [[Bedrijventerrein]] as an example. The construction 'Warehouses 3h' has the function 'Warehouses', is of the [[function category]] Industry, and is 27.600m2 in size. The effect of this function on the livability is -7. You can clearly see the negative effect (large red area) of this construction in the livability overlay.
* Function Type: Warehouses
* Floors: 3 (3h)
* Size: 27.600m2
* Function Category: Industry
* Local physical livability: -7
* Surrounding livability: -1.3
* Livability in the zone Harbor Area: -0.6
<gallery mode="nolines">
File:effects_functions_livability_before.jpg| Before changing the Function Value, the livability overlay turns red.
</gallery>
We change the value (and thus the effect) of this construction on the livability from -7 to +5. You can clearly see the positive effect (a lot greener area) of this construction in the livability overlay.
* Function Type: Warehouses
* Floors: 3 (3h)
* Size: 27.600m2
* Function Category: Industry
* Local physical livability: +5
* Surrounding livability: +0.1
* Livability in the zone Harbor Area: +0.5
<gallery mode="nolines">
File:effects_functions_livability_after.jpg| After changing the Function Value, the livability overlay turns green.
</gallery>
--><br clear="all">
==Changing function values==
''This section deals with changing the values of the function itself. For changing the function of a construction, see [[Constructions#How to change constructions|constructions]].''
{{Editor ribbon|header=Indicators|bar=Function Values}}
[[File:Function_values_screen.jpg|framed|none|The function values editing screen.]]
===Adding functions for editing===
By default, functions are not yet available for editing. To edit them, they must first be added to the "Function Values" panel. When they are added, their properties can be altered as desired. Adding functions can be done by following these steps:
{{Editor steps|title=add a function for editing|Click "Add".|Select the desired function in the [[function selection]] window.|Find the function in the list in the "Function Values" panel.}}
===Adding new functions===
It is possible to create new functions by duplicating existing functions. The properties of these duplicated functions can be changed separately from the original function. A function can be duplicated as often as desired. Adding new functions can be done by following these steps:
{{Editor steps|title=add a new function|Select a function from the list to use as template.|Press "Duplicate".|Find the duplicated function at the bottom of the list.}}
===Changing functions===
There are multiple ways existing functions can be changed.
=====Changing categories of functions=====
It is possible to supplement the category of a function with one or more additional categories. This means it's possible to create buildings which, for example, are part house and part shop. This can be done by following these steps:
{{Editor steps|title=add categories to functions|If the desired function is not yet present in the list, [[#Adding functions for editing|add the function]] to the list.|Select the function of which you wish to change or add a category.|Select the desired category using the drop down box at the bottom.|Press "Add category".}}
{{Editor steps|title=remove categories from functions|Ensure the function, from which you wish to remove a category, has at least two categories.|Select the category of the function you wish to remove.|Press "Delete category".}}
If you wish to change the category of a function from one category to another, first add the category you wish to have assigned to the function, and then remove the category you do not wish to have assigned to the function. You can not remove the last category of a function. Each function must have at least one category.
====Changing properties====
Each function has a number of properties which can be changed.
{{Editor steps|title=change the properties of functions|If the desired function is not yet present in the list, [[#Adding functions for editing|add the function]] to the list.|Find the column with the property you wish to change.|Change the value in the row of the function and the column of the property.}}
'''Note: When a function has multiple categories, some properties can also have different values per category for the same function.'''
[[File:Function_values_screen_edit_value.jpg|framed|left|Editing the construction time of warehouses.]]<br clear=all>
The following properties can be changed directly, by changing the value in the column (Generally to a different numeric value, unless otherwise specified):
; Name
: ''The name of the function. This is displayed in the legend in the [[interface]] to indicate what kind of building something is, and as the name for [[actions]] which place constructions with this function in the world.'' This value does not need to be a numeric value. Instead, you can use letters, numbers and certain symbols.''
; Environment effect
: ''The effect of a building with this function on the livability of the area. This is used in combination with the [[Livability (Indicator)|livability indicator]] and [[Livability (Overlay)|livability overlay]]. A higher value is better.''
; Traffic Flow
: ''When [[units]] make use of this function as a road, a greater value for traffic flow means more vehicles will be on the road at the same time.''
; Traffic Speed
: ''When [[units]] make use of this function as a road, a greater value for traffic speed means vehicles will travel across the road faster.''
; Traffic Lanes
: ''When [[units]] make use of this function as a road, this is the amount of lanes the vehicles will use.''
; Heat effect (°C)
: ''The amount of ambient heat caused by this function. Lower is better. (Advanced mode only)''
; Safe zone Distance
: ''The required safety distance for this function in the event of flooding. (Currently not used)''
; Water storage per floor space
: ''The amount of water a building with this function can store. This is used in combination with the [[Water Storage (Indicator)|water storage indicator]]. Water storage achieved this way is counted as "innovative" water storage.''
; Green per floor space
: ''The amount of m² of green per m² of a building with this function. A value of "1.0" means the function is entirely green. "0.4" means 40% of the area drawn is green.''
; Construction time in months
: ''The amount of time it takes to construct a building with this function. This is only used in [[timeline]] projects.''
; Default floor height
: ''The default height for a single floor of this building. A higher value means each floor of the building will be taller.''
; Min floors
: ''The minimum amount of floors a building with this function must have. Some functions, such as apartments or skyscrapers, could be built with just 1 floor, but that would not make sense logically given the type of building. A participant can vary the amount of floors from this value upwards (including this value), up to the "Maximum amount of floors". This value cannot be higher than the "Maximum amount of floors".''
; Default  floors
: ''The default amount of floors when a participant wishes to build this building. A participant is free to set the amount of floors of the building to any value between "minimum amount of floors" and "maximum amount of floors", using a slider. When the option is presented, the slider starts at this value. This value should be higher than or equal to the "Minimum amount of floors", and lower than or equal to the "Maximum amount of floors".''
; Maximum  floors
: ''The maximum amount of floors a building with this function can have, Some functions, such as roads or parks, are only 1 floor high. Buildings such as townhouses are usually not any taller than 3 or 4 floors. A participant can vary the amount of floors from this value downwards (including this value), down to the "Minimum amount of floors". This value cannot be lower than the "Minimum amount of floors".
; Demolish time in months
: ''The amount of time it takes to demolish a building with this function. This is only used in [[timeline]] projects.''
; Zoning permit required
: ''Whether constructing a building with this function needs to be approved by the municipality. If set to "1.0", the municipality can deny the construction of a building with this function. If set to "0.0", the building is automatically approved when the acting stakeholder [[ownership|owns]] the land and construct the building in the proper zone.''
; Slanting roof height
: ''The height of the center of the roof for this function. A higher value or a less wide construction means the angle of the roof is greater.''
; Floor space per unit
: ''How much floor space constitutes a single unit. This is used to calculate the "amount" of a building by floor space. For example, if the amount of floor space per house is 150m², a social housing construction with 680m² of floor space will be 4 houses.''
; Heat flow M² / year
: ''The amount of usable heat produced or required by this function. (Currently not used)''
; Parkinglots per floor space
: ''The amount of parking spaces this function provides by surface area. If a negative number is used, this function increases the demand for parking spaces.''
; Construction cost per floor space
: ''The costs to create a building with this function. This is the amount a stakeholder will have to pay per m² to construct a building with this function.''
; Demolish costs per floor space
: ''The costs to demolish a building with this function. This is the amount a stakeholder will have to pay per m² to remove a building with this function. Note that for not vacant buildings, a stakeholder will also have to pay the "Buyout costs".''
; Buyout costs per floor space
: ''The costs to vacate a building with this function. This is the amount a stakeholder will have to pay per m² to remove a building with this function if the building is not vacant, in addition to the "Demolish costs".''
; Sell price per floor space
: ''The amount of money received per m² when a building with this function is created. When a building is constructed, the stakeholder receives this money automatically.''
====Changing effects on custom indicators====
{{Editor ribbon|header=Indicators|bar=Function Scores}}
Besides the ability to change the standard values associated with a function, each function can also score on one or more [[qualitative indicator]]s. These effects can be edited in the "Function Scores" window.
{{Editor steps|title=change the effect of functions on custom indicators|If the desired function is not yet present in the list, [[#Adding functions for editing|add the function]] to the list of function values.| Find the column with the indicator for which you wish to change the effects.| Change the value in the row of the function and the column of the property value.}}<br clear=all>
[[File:Custom_function_values_screen_edit_value.jpg|framed|left|Changing the effect of convenience stores on the economy indicator.]]<br clear=all>


For each custom indicator in the project, two properties exist. Each property has its own column in this panel.
{{article end
|howtos=
* [[How to add Functions for editing]]
* [[How to create Functions]]
* [[How to change Function Values for a Function]]
* [[How to add an Attribute to a Function]]
* [[How to change Attributes for a Function]]
* [[How to add a Category to a Function]]
* [[How to remove a Category from a Function]]
* [[How to change the Category of a Function]]
* [[How to adjust Building Costs]]
|seealso=
*[[Function Override]]
*[[Function Values Table]]
}}


; Indicator
{{Template:Editor_current_situation_nav}}
: ''The effect on the custom indicator. For each 100m² of a function that exists in the [[project detail area]], this value is added to the indicator. You can change this value by changing the numerical value in this field.''


; Indicator (cumulative to max)
[[Category:Items]]
: ''The maximum effect of this function on the custom indicator. No more then this value can be achieved with this function alone. If the total effect would exceed this value, the effect is capped at this value, and constructing more of the same function does not have any more effect. You can change this value by changing the numerical value in this field.''

Latest revision as of 14:08, 29 February 2024

Function related to Buildings and Function Overrides

Functions are the blueprints for Buildings in your projects. They describe the purpose and basic properties of Buildings. A Function also references which model sets and colors are used in the 2D and 3D visualization. A Function is effectively a "type of Building".

The properties associated with a Function are known as Function Values

A Building in a Project is always based on one Function. Buildings with the same Function may have different locations, different heights, and different owners. But Buildings with the same Function will have the same set of properties defining their economic, environmental, and spatial effect.

Additionally, Functions can also be used as definitions for actions. When a Function is used as an Action, the Action will be the creation of a new Building, the Function of which is the Function which is used as Action. Some properties of the Function, such as the minimum, maximum, and default amount of floors, also affect how a Stakeholder can enact their action.

The Tygron Platform contains several hundred Functions.

Function values

Main article: Function Value
Function Values Table in the editor.

Functions are composed of a collection of properties called Function Values. These form the actual numeric definitions which are applied on a Building which is set to be of a certain Function. In principle, when such a value of a Building is required for a calculation, the value set in the Function is used.

A complete list of all available Function Values can be found on the Function Values page.

Function Categories

The function selection window. This will appear whenever you need to a select a function.

Functions are divided into Function Categories. Where a Function itself may be "Old Warehouses", such a Function may belong to a Function Category "Industry". This categorization helps when trying to select a specific Function among the full collection of Functions. It also makes it easier to query Buildings in a Project but filtering on the purposes of the Building. Rather than creating individual queries for each Function which matches a broad usage for Buildings, a single query for a Function Category can be used.

Functions are always part of at least one Category, but can also be part of multiple functions. An example is a Function for a Building with shops at a bottom floor, but residences on floors above it. Or flats which contain a mix of both social and luxury housing. In these cases, the Function's Categories each have a respective weight. The Building will be considered wholly of the specified Function, but the Building will be considered "divided up" between the Categories when querying, for example, their floor size.

Categories:

Currently the Tygron Platform distinguishes the following Function Categories:

Category TQL Term Combinable Description
Affordable housing SOCIAL yes Affordable housing contains actions related to affordable housing: Flats (various types), Old social housing (various types), Social housing (various types), etc.
Agriculture AGRICULTURE Agriculture contains actions related to agriculture: Floating crops, Farms, Corn Fields etc.
Bridge BRIDGE
Education EDUCATION yes Education contains actions related to educational buildings: Basis educational buildings, emergency classrooms, labs, primary schools etc.
Gardens GARDEN Gardens contains actions related to gardens: Simple Garden, Normal Garden, Fenced Garden, etc.
Healthcare HEALTHCARE yes Healthcare contains actions related to healthcare: Healthcare farm, Healthcare hotel, Hospital, etc.
Industry INDUSTRY yes Industry contains actions related to industrial buildings: Biorefinery, Silo's, Warehouses, Chimney, etc.
Intersection INTERSECTION
Leisure LEISURE Leisure contains actions related to leisure buildings: Sports center, Swimming Pool, Theatre, Tennis Court, etc.
Market housing NORMAL yes Market Housing contains actions related to market housing: different types of housing, apartments, shops with houses, etc.
Nature NATURE Nature contains actions related to nature: Trees, Orchard, Reeds.
Offices OFFICES yes Offices contains actions related to Offices: Classic Offices, Luxurious Offices, Old Offices, Offices with shops, etc.
Other OTHER Other contains assorted actions: Cemetery, Trash bins, Windmill and a few others.
Parks PARK Parks contains actions related to Parks: City Park, Fountain, Pocket Park, Vegetable garden, etc.
Roads ROAD Roads contains actions related to infrastructure and roads: Asphalt roads (various types), Bicycle path, Cobblestone roads, Train tracks, etc.
Senior housing SENIOR yes Senior Housing contains actions related to senior housing: Senior Housing (Standard) and Senior Housing (Luxurious).
Shops and restaurants SHOPPING yes Shops and restaurants contains actions related to shops and restaurants: Chip shop, Convenience store, Office with shops, Houses with Shops, etc.
Squares PAVED_AREA Squares contains actions related to public Squares: Parking Spaces, Playground, Watersquare, Skate park etc.
Student housing STUDENT yes Student Housing contains actions related to student housing: Cheap student housing, Student Housing (various types), Student Containers, etc.
Top market housing LUXE yes Top Market Housing contains actions related to luxurious housing: Luxury Apartments, Modern Villa, Old Villa, Monumental House, etc.
Underground UNDERGROUND Underground contains an action related to underground: Drainage Culvert.

Regions

The region selector, to filter the available functions.

To further help with finding the appropriate Function, they are also divided into regions. Based on the location of the Project, the region for the Project is set automatically. Some Functions are only available in certain regions. This is based on what region of the world the Function would be most appropriate for.

When selecting a Function, it is possible to change the region of the Project to gain access to the Functions of other regions. It is possible to Mix Functions of various regions freely.

Regions:

Currently the Tygron Platform distinguishes the following regions:

  • Africa
  • Asia
  • North America
  • Northwestern Europe
  • Other

How-to's

See also

Editor ribbon icon current.pngCurrent Situation
Current Situation
Buildings • Terrains • Administrative • Areas • Networks • Overlays • Indicators • Panels • Globals •  Queries • Geo Import
Buildings
Function • Function Override • Traffic Units
Terrain
Height sector • Elevation model • Elevation GeoTIFF • Elevation Grid Overlay • Ground Price • Terrain Type • Terrain Type Override
Administrative
Neighborhood • Zone • Permission Popup • Plot • Zip Code
Geo Import
Source • GeoShare
Network
Net Cluster • Net Function • Net Line • Net Load • Net Node • Net Setting
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community
Retrieved from "https://previewsupport.tygron.com/w/index.php?title=Function&oldid=59834"