Function: Difference between revisions
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 [[ | Functions are the blueprints of [[Building]]s in the [[3D world]]. They describe the purpose and [[Function Value|properties]] of [[Building]]s. A Function also defines which 3D model is placed in the 3D world. A Function is effectively a "type of Building". | ||
The properties associated with a Function are known as [[Function Value]]s | The properties associated with a Function are known as [[Function Value]]s | ||
Each | Each Building in a Project has a Function defining what kind of Building it is. 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. | ||
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 | 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. | ||
The {{software}} contains several hundred Functions. | The {{software}} contains several hundred Functions. | ||
| Line 17: | Line 17: | ||
===Function values=== | ===Function values=== | ||
{{main|Function Value}} | {{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 | 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. | A complete list of all available Function Values can be found on the [[Function Value]]s page. | ||
| Line 23: | Line 23: | ||
===Function Categories=== | ===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.]] | ||
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]] | 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 | 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: ''' | '''Categories: ''' | ||
Revision as of 11:32, 5 October 2022
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 Buildings in the 3D world. They describe the purpose and properties of Buildings. A Function also defines which 3D model is placed in the 3D world. A Function is effectively a "type of Building".
The properties associated with a Function are known as Function Values
Each Building in a Project has a Function defining what kind of Building it is. 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
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
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 | |
| Agriculture | AGRICULTURE | ||
| Bridge | BRIDGE | ||
| Education | EDUCATION | yes | |
| Gardens | GARDEN | ||
| Healthcare | HEALTHCARE | yes | |
| Industry | INDUSTRY | yes | |
| Intersection | INTERSECTION | ||
| Leisure | LEISURE | ||
| Market housing | NORMAL | yes | |
| Nature | NATURE | ||
| Offices | OFFICES | yes | |
| Other | OTHER | ||
| Parks | PARK | ||
| Roads | ROAD | ||
| Senior housing | SENIOR | yes | |
| Shops and restaurants | SHOPPING | yes | |
| Squares | PAVED_AREA | ||
| Student housing | STUDENT | yes | |
| Top market housing | LUXE | yes | |
| Underground | UNDERGROUND |
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.
Regions:
Currently the Tygron Platform distinguishes the following regions:
- Africa
- Asia
- North America
- Northwestern Europe
- Other
How-to's
- 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
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
- Net Cluster • Net Function • Net Line • Net Load • Net Node • Net Setting
- Editor