Function: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
Line 5: Line 5:


==How do functions relate to the {{software}}==
==How do functions relate to the {{software}}==
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.
Functions are the blueprints of [[Construction]]s in the [[3D world]]. They describe the purpose and [[Function Value|properties]] of [[Construction]]s. A Function also defines which 3D model is placed in the 3D world. A Function is effectively a "type of Construction".


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.
The properties associated with a Function are known as [[Function Value]]s


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]].
Each Construction in a Project has a Function defining what kind of Construction it is. Constructions with the same Function may have different locations, different heights, and different owners. But Constructions with the same Function will have the same set of [[Function Value|properties]] defining their economic, environmental, and spatial effect.


==Function Categories==
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 Construction, 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 divided into function categories. A function category is a more generic definition of what a construction does. For example: the function category "Industry" could contain the functions "Warehouses", "Silo" and "Refinery" among others. 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.


The {{software}} contains several hundred Functions.
===Function values===
{{main|Function Value}}
Functions are composed of a collection of properties called [[Function Value]]s. These form the actual numeric definitions which are applied on a Construction which is set to be of a certain Function. In principle, when such a value of a Construction is required for a calculation, the value set in the Function is used. However, a Construction can have a Function Value overridden for itself. If the Construction in consideration for a calculation has an overridden Function Value, that overridden value will be used instead.
A complete list of all available Function Values can be found on the [[Function Value]]s page.
===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]] Constructions in a Project but filtering on the purposes of the Construction. Rather than creating individual queries for each Function which matches a broad usage for Constructions, a single query for a Function Category can be used.


=== Available Function Categories ===
Functions are always part of at least one Category, but can also be part of multiple functions. An example is a Function for a Construction 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 Construction will be considered wholly of the specified Function, but the Construction will be considered "divided up" between the Categories when querying, for example, their floor size.{{clear}}
* Affordable Housing
 
'''Categories: '''
 
Currently the {{software}} distinguishes the following Function Categories:
* Affordable housing
* Agriculture
* Agriculture
* Education
* Education
Line 25: Line 37:
* Industry
* Industry
* Leisure
* Leisure
* Market Housing
* Market housing
* Nature
* Nature
* Offices
* Offices
* Other
* Other
* Parks
* Parks
* Senior Housing
* Senior housing
* Shops and restaurants
* Shops and restaurants
* Squares
* Squares
* Student Housing
* Student housing
* Top Market Housing
* Top market housing
* Underground
* Underground
* Underground (with topside)
{{clear}}
 


===Regions===
===Regions===
Because the {{software}} features a lot of different functions, they are divided into regions. This helps with selecting the appropriate functions for your project. Depending on the region, some functions may be more appropriate than others. It is possible to switch between regions when selecting a function using the function selection window.
[[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.]]
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:
Currently the {{software}} distinguishes the following Regions:
* Africa
* Africa
Line 48: Line 64:
* Northwestern Europe
* Northwestern Europe
* Other
* Other
<br clear="all">


==Effects of functions on indicators: Function values vs. Function scores==
==Editing Functions==
: ''Main Article: [[Indicators]]
{{Editor location|Function Values}}
All Functions in the {{software}} can be edited, and new Functions can be created based on pre-existing ones. By default, a small list of Functions is available for editing.
[[File:Function_values_screen.jpg|thumb|750px|left|The Function Values window.]]
{{clear}}


Within the {{software}} there are 2 different indicator types available: [[Indicators#Predefined_indicators|predefined indicators]] and [[Indicators#Customized_indicators|customized indicators]]. Function values influence predefined indicators. Function scores influence one of the Customized indicator types, [[Qualitative_Indicator|qualitative indicators]].
===Adding Functions for editing===
The default list of Functions does not include all Functions available in the {{software}}. It is possible to add additional functions to the overview of editable functions. When they are added, their properties can be altered as desired.


==Editing functions==
{{Editor steps|title=add a Function for editing|Click "Add".|Select the desired Function in the Function selection window, and "Apply".|Find the Function in the name column list in the "Function Values" panel.}}


===Adding and removing functions for changing function values===
===Creating new Functions===
It's possible to create new Functions based on existing Functions by duplicating an existing function. The properties of the new Function can then be changed independently of the old Function.


''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 steps|title=create a new Function through duplication|Select a function from the list to use as original.|Press "Duplicate".|Find the duplicate function at the bottom of the list.}}


{{Editor location|Function Values}}
===Changing Function Values===
[[File:Function_values_screen.jpg|thumb|750px|left|The function values window.]]<br clear=all>
{{main|Function Value}}
When a Function is added to the list of Functions, its [[Function Values]] can be modified.
{{Editor steps|title=change Function Values |If the desired Function is not yet present in the list, {{inlink|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 [[Category Value|Function Value]]s can also have different values per Category for the same Function.'''
[[File:Function_values_screen_edit_value.jpg|thumb|left|950px|Editing the construction cost for the function "Roads".]]{{clear}}
 
===Changing Categories of Functions===
Functions can be part of multiple Categories at once. By assigning a Function a second Category, and then removing the original Category, a Function's Category can be changed entirely.
 
{{Editor steps|title=add Categories to Functions|If the desired Function is not yet present in the list, {{inlink|Adding Functions for editing|add the Function}} to the list.|Select the Function to which you wish to add a Category.|Select the desired Category using the drop down box at the bottom.|Select "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".}}


====Adding functions for editing====
Remember that each Function should have at least one Category. It is not possible to remove the last Function Category from a Function.
By default, a list of functions is available for editing. It's also possible to edit functions not available by default in the list. 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 name column list in the "Function Values" panel.}}


====Adding a new function by using duplicate====
It is possible to create a new function by duplicating an existing function. The properties of this duplicated function can be changed separately from the original function. A function can be duplicated as often as desired. Adding a duplicate function can be done by following these steps:


{{Editor steps|title=add a duplicate function|Select a function from the list to use as original.|Press "Duplicate".|Find the duplicate function at the bottom of the list.}}


===Function values===
===Function values===
Line 176: Line 202:
; Zoning permit required
; 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.''
: ''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.''
 
-->
===Changing function values===
As described above, each function has a number of properties. Each function property has a value (the so called function value) which can be changed.
{{Editor steps|title=change function values |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|thumb|left|950px|Editing the construction cost for the function "Roads".]]<br clear=all>
 
====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 the effect of functions on qualitative indicators===
{{Editor location|function value attributes}}
{{old references|type=section}}
 
[[File:Custom_function_values_screen_edit_value.jpg|thumb|250px|left|The effect of roads on the transport indicator.]]<br clear=all>
 
Besides the ability to change the standard values associated with a function, each function can also score on one or more [[Qualitative Indicator|qualitative indicators]]. These effects can be edited in the "Function Scores" window.
 
{{Editor steps|title=change the effect of functions on qualitative 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>
 
For each qualitative indicator in the project, two properties exist: The value of the function per m2 (per m2) and the maximum effect of this function on the qualitative indicator (cumulative to max). Each property has its own column in this panel.
 
; Indicator (per surface area)
: ''The effect on the qualitative indicator. This value, is added to the indicator for each surface unit of this function that exists in the [[project detail area]]. You can change this value by changing the numerical value in this field.''
 
; Indicator (cumulative to max)
: ''The maximum effect of this function on the qualitative indicator. No more than this maximum 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.''

Revision as of 13:45, 30 August 2019

Template:Learned

What are functions

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 relate to the Tygron Platform

Functions are the blueprints of Constructions in the 3D world. They describe the purpose and properties of Constructions. A Function also defines which 3D model is placed in the 3D world. A Function is effectively a "type of Construction".

The properties associated with a Function are known as Function Values

Each Construction in a Project has a Function defining what kind of Construction it is. Constructions with the same Function may have different locations, different heights, and different owners. But Constructions 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 Construction, 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

Functions are composed of a collection of properties called Function Values. These form the actual numeric definitions which are applied on a Construction which is set to be of a certain Function. In principle, when such a value of a Construction is required for a calculation, the value set in the Function is used. However, a Construction can have a Function Value overridden for itself. If the Construction in consideration for a calculation has an overridden Function Value, that overridden value will be used instead.

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 Constructions in a Project but filtering on the purposes of the Construction. Rather than creating individual queries for each Function which matches a broad usage for Constructions, 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 Construction 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 Construction will be considered wholly of the specified Function, but the Construction 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:

  • Affordable housing
  • Agriculture
  • Education
  • Gardens
  • Healthcare
  • Industry
  • Leisure
  • Market housing
  • Nature
  • Offices
  • Other
  • Parks
  • Senior housing
  • Shops and restaurants
  • Squares
  • Student housing
  • Top market housing
  • Underground

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

Editing Functions

Editor → Current Situation (Ribbon tab) → Buildings (Ribbon bar) → Edit Function Values (Dropdown)

All Functions in the Tygron Platform can be edited, and new Functions can be created based on pre-existing ones. By default, a small list of Functions is available for editing.

The Function Values window.

Adding Functions for editing

The default list of Functions does not include all Functions available in the Tygron Platform. It is possible to add additional functions to the overview of editable functions. When they are added, their properties can be altered as desired.

How to add a Function for editing:
  1. Click "Add".
  2. Select the desired Function in the Function selection window, and "Apply".
  3. Find the Function in the name column list in the "Function Values" panel.

Creating new Functions

It's possible to create new Functions based on existing Functions by duplicating an existing function. The properties of the new Function can then be changed independently of the old Function.

How to create a new Function through duplication:
  1. Select a function from the list to use as original.
  2. Press "Duplicate".
  3. Find the duplicate function at the bottom of the list.

Changing Function Values

Main article: Function Value

When a Function is added to the list of Functions, its Function Values can be modified.

How to change Function Values:
  1. If the desired Function is not yet present in the list, add the Function to the list.
  2. Find the column with the property you wish to change.
  3. Change the value in the row of the function and the column of the property.

Note: When a Function has multiple Categories, some Function Values can also have different values per Category for the same Function.

Editing the construction cost for the function "Roads".

Changing Categories of Functions

Functions can be part of multiple Categories at once. By assigning a Function a second Category, and then removing the original Category, a Function's Category can be changed entirely.

How to add Categories to Functions:
  1. If the desired Function is not yet present in the list, add the Function to the list.
  2. Select the Function to which you wish to add a Category.
  3. Select the desired Category using the drop down box at the bottom.
  4. Select "Add Category".
How to remove Categories from Functions:
  1. Ensure the Function, from which you wish to remove a Category, has at least two Categories.
  2. Select the Category of the Function you wish to remove.
  3. Press "Delete Category".

Remember that each Function should have at least one Category. It is not possible to remove the last Function Category from a Function.