Function

From Tygron Support wiki
Jump to navigation Jump to search
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

Main article: Category Value
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.

Function Category:

Currently the Tygron Platform distinguishes the following Categories for Functions:

Category TQL Term Combinable Layer Description
Affordable housing SOCIAL yes Surface Includes various types of flats and social housing.
Agriculture AGRICULTURE no Surface Includes farmhouses, barns, and floating crop fields.
Bridge BRIDGE no Bridge Includes bridges of asphalt roads (various types), bicycle paths, cobblestone roads and train tracks.
Education EDUCATION yes Surface Includes basic educational buildings, emergency classrooms, labs and primary schools.
Gardens GARDEN no Surface Includes standard and fenced gardens.
Healthcare HEALTHCARE yes Surface Includes hospitals, clinics, healthcare farms and healthcare hotels.
Industry INDUSTRY yes Surface Includes small and heavy industry, bio-refineries, silos, warehouses and chimneys.
Intersection INTERSECTION no Surface Includes intersections of asphalt roads (various types), bicycle paths, cobblestone roads and train tracks.
Leisure LEISURE no Surface Includes sports centers, swimming pools, theatres and tennis courts.
Market housing NORMAL yes Surface Includes various types of housing, apartments and shops with houses.
Nature NATURE no Surface Includes trees, orchards and reeds.
Offices OFFICES yes Surface Includes classic, luxurious, old offices and offices with shops.
Other OTHER no Surface Includes miscellaneous items such as cemeteries, trash bins, and windmills.
Parks PARK no Surface Includes city parks, fountains, pocket parks and vegetable gardens.
Roads ROAD no Surface Includes asphalt roads (various types), bicycle paths, cobblestone roads and train tracks.
Senior housing SENIOR yes Surface Includes standard and luxurious senior housing.
Shops and restaurants SHOPPING yes Surface Includes convenience stores, offices with shops and houses with shops.
Squares PAVED_AREA no Surface Includes parking spaces, playgrounds, watersquares and skate parks.
Student housing STUDENT yes Surface Includes affordable student housing, various other student housing types, and student containers.
Top market housing LUXE yes Surface Includes luxury apartments, modern villas, old villas and monumental houses.
Underground UNDERGROUND no Underground Includes culverts, pumps and inlets.


The table above also indicates which Categories can be combined with others within a Function. To add, remove and change Categories of a Function, see the How-to's section.

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