Attribute: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(157 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{learned|what an attribute is|how the concept of attributes relates to the Tygron Engine|how to add or remove attributes|how to edit attributes }}
[[File:Attribute editing panel.jpg|thumb|right|The [[right panel]] allows you to add new attributes. The top half allows you to edit existing attributes, the bottom half allows you to add new attributes.]]
A number of components, such as [[neighborhood]]s, [[area]]s, [[building]]s and [[zone]]s, have adjustable attributes. These attributes are used:
* to provide meaningful information
* as parameters in calculations
* to provide (visual) information to distinguish themselves among peers


==What is an Attribute?==
Attributes can be defined and redefined by a user. Some attributes are predefined by the {{software}} and already exist as default properties of a component. Some components can even inherit properties from other type of components, such as a [[Building]] that inherits attributes from it's referenced [[Function]].
An attribute is a characteristic of a particular component in the 3D world. The Engine parts where attributes are applied to are: [[Neighborhoods|neighborhoods]] , [[Areas|Areas]] , [[Constructions|constructions]] and [[Zones|zones]]  


It contains information about this particular component which can be used in [[Excel|Excel]] calculations.  
In general the {{software}} allows users to inspect, adjust and reset existing attributes of these components and define and remove new ones.
///////


==Attributes in relation to the Tygron Engine==
The group of components than can store attributes is called ''Attribute Items''. The current list of ''Attribute Items'' is:
In the Tygron Engine, zoning is an important element that can be used to guide the decision making process of the [[stakeholders]]. The stakeholder municipality has the responsibility to ensure the zoning plan is adhered to; each time a construction is planned by any of the stakeholders, the municipality has to verify if the plan complies with the zoning plan, prior to approval of the planned construction. To facilitate negotiations and bottom up participation, the municipality also has the power to change zoning plans. With this power, the municipality can offer other stakeholders approval for permits as trade off for complying with non zoning related objectives, such as less urban heat stress or more water storage in an area.
* [[Area]]s
[[File:zoning14.jpg|thumb|left|200px|Zoning implemented in the Tygron Engine ([[Bedrijventerrein]])]]<br clear=all>
* [[Building]]s
* [[Functions]] and their overrides
* [[Indicator]]s
* [[Neighborhood]]s
* [[Net load]]s
* [[Net line]]s
* [[Net line#Net line definitions|Net function]]s
* [[Overlay]]s
* [[Panel]]s
* [[Terrain]]s
* [[Weather]]s
* [[Zone]]s


When a [[function]] has been added to a zone in the Tygron Engine, they are added to the so called 'Zoning Plan'. This means stakeholders are allowed to create this construction inside this zone. They will still need permission from the Municipality to create this construction! When a function has not been added to the 'Zoning Plan' this means stakeholders are not allowed to create this type of constructions inside this zone. The municipality can still make an exception when the permission has been requested.
Note that although [[Global]]s seem to behave similarly to attributes, they are not part of any specific ''Attribute Item'' in a project. Instead they are individual components part of the project.


==How to add and remove attributes==
==Attribute values==
An attribute always consists of a name and a value. The name of an attribute is usually written in capital letters, and uses underscores in place of spaces. Values must be numbers (positive, negative, or decimal).


When a new project is created with an empty map, the [[3D World]] is divided into 4 default zones. When the area is relatively small, this could be acceptable. However, it may be desirable to change the default zoning. Projects which have been generated with [[wizard|GIS]] data will have zones based on the available data.
''Note that not there are some [[TQL_name|restrictions for attribute names]].''


{{Editor ribbon|header=3D World|bar=Zoning}}
Some components have properties which are also reflected in attributes. Properties such as the color of the component are present both as a dedicated property and as an attribute. Changing either the property or the attribute automatically updates the other.
[[File:zoning-left.jpg|framed|left|The left panel allows you to add, remove and select zones]]
: To add new zones to the 3D world, open the Zoning panel in the editor. In the left panel, select "Add". A new zone will appear in the list of zones. Please note that this is still an "empty" zone, since no actual area is assigned yet.
: To remove a zone from the list, select the zone that you wish to remove, and select "Remove".


{{Editor steps|title=add zones to the 3D world|Open the Zoning panel|Select "Add".}}
Attributes are unique to each component; sharing an attribute name between components does not link their values.
{{Editor steps|title=remove zones from the 3D world|Open the Zoning panel|Select the zone you wish to remove.|Select "Remove"}}<br clear=all>


==Editing attributes==
{{Editor ribbon|header=3D World|bar=Zoning|left panel=Zone}}
[[File:zoning-right.jpg|framed|left|The right panel allows you to edit the properties of zones.]]
When a zone has been selected in the left panel, the properties of that zone can be edited in the right panel.


====Name====
[[File:zoning-right-name.jpg|framed|right|The field for the "Name".]]
: ''The "Name" field is where the name of a zone can be changed. The name of a zone can be seen on the zoning [[overlay]]. By entering a new name in the "Name" field, the zone can be given a more identifying name.''<br clear=right>


====Color====
===Attribute arrays===
[[File:zoning-right-color.jpg|framed|right|The selector for the "Color".]]
{{main|Attribute array}}
:''The color selector allows the zone color to be edited. The zone Color can be seen in the zoning [[overlay]]. The zone color is used for assigning different colors to different zones, to help users to distinguish the defined zones. By selecting the "Color" field, a new panel opens, in which a new identification color for the highlighted zone can be selected. ''<br clear=right>
Attributes are most commonly a single value, but can also be an array of values.


====Add new Attribute with Name====
===Attribute values during a session===
[[File:zoning-right-description.jpg|framed|right|The field for the "Description".]]
Attributes can be read during a session. Primarily, it is possible to read attributes of components using [[TQL]]. By requesting the value of an attribute of a component using TQL, the value of that attribute can be used in, for example, [[Excel]] calculations.
:''The description field is for describing the selected zone. Here a short text describing the zone can be entered.''<br clear=right>


====Add new Attribute with Value====
It is possible that, when requesting the value of an attribute of a component, that attribute does not exist for that component. In this case, the value of that attribute is deemed to be "0".
[[File:zoning-right-floors.jpg|framed|right|The field for the "Floors".]]
: ''The floors field allows the maximum amount of floors to be set for the zone. This is commonly used to influence the skyline, population density and other urban planning issues. In a densely populated big city, having higher buildings helps creating living and working spaces for the inhabitants. In rural areas or outskirts, preservation of a more natural skyline might be desired.''<br clear=right>


====Reset variables====
''Note that this means that an attribute value of 0 can mean that the proper value of the attribute is 0, or that the attribute does not exist.
[[File:zoning-right-functions.jpg|framed|right|The list of function categories that can be allowed.]]
 
: ''Adding an allowed function category to a zone enables stakeholders to plan constructions of that category function inside the zone. To add a function category to a zone, check the checkbox next to the desired category. To disallow a function category, make sure the checkbox next to the desired category is unchecked.''<br clear=right>
Attributes can be changed during a session via [[Event]]s (e.g., AREA_SET_ATTRIBUTE) or [[TQL]], allowing updates from Excel calculations.
 
===Common attribute values===
Some attributes may have a more exact spectrum of values which are valid. For example, the ACTIVE attribute is either 1 or a 0.
 
''Note that these attributes can be given other values as well. The resulting behavior for calculations and functionality depending on these attributes is undefined.
 
====ACTIVE====
: ''Applies to: [[Area]]s, [[Neighborhood]]s, [[Overlay]]s, [[Indicator]]s and [[Stakeholder]]s
Some components may have an "active" property. When that property indicates the component is active, the "ACTIVE" attribute's value is "1". When the component is inactive, the attribute's value is "0".
 
====COLOR====
: ''Applies to: [[Area]]s, [[Neighborhoods]], [[Zone]]s
{{main|Color}}
Spatial components with attributes commonly have a "COLOR" attribute, defining the color by which they are displayed.The value corresponds to the color property of that component. When that color property is changed, the attribute is changed, and vice versa.
 
===Examples of special attribute values===
 
====URBANIZATION====
: ''Applies to: [[Neighborhoods]]
The "URBANIZATION" attribute is an indicator for the degree of urbanization. It ranges from 1 (dense urbanization) to 5 (virtually no urbanization).
 
====NATURE_RESERVE====
: ''Applies to: [[Area]]s
The "NATURE_RESERVE" attribute indicates whether an area is a protected area of nature. This usually means the allowance for pollution and noise is lower. Areas with an "NATURE_RESERVE" attribute value of "1" are deemed protected nature. When the attribute's value is 0, the area is not necessarily deemed protected nature.
 
{{article end
| notes=
* When removing attributes which are related to properties of the component, the value of the properties will be changed as well, as though the attribute was set to "0".
| howtos=
* [[How to add an Attribute]]
* [[How to remove an Attribute]]
* [[How to edit an Attribute]]
* [[How to import Attributes]]
* [[How to edit Attributes of multiple Items]]
* [[How to remove Attributes from multiple Items]]
* [[How to change multiple Attributes at once for Water Overlays]]
| seealso=
* [[Overlay Key]]
* [[Global]]
|api=
<div style= "column-count:3">
*[[Api session event editor address set attribute]]
*[[Api session event editor area set attribute]]
*[[Api session event editor attributeaction set attribute]]
*[[Api session event editor building set attribute]]
*[[Api session event editor chatchannel set attribute]]
*[[Api session event editor functionoverride set attribute]]
*[[Api session event editor indicator set attribute]]
*[[Api session event editor neighborhood set attribute]]
*[[Api session event editor netfunction set attribute]]
*[[Api session event editor netline set attribute]]
*[[Api session event editor netload set attribute]]
*[[Api session event editor overlay set attribute]]
*[[Api session event editor panel set attribute]]
*[[Api session event editor parametric set attribute]]
*[[Api session event editor scenario set attribute]]
*[[Api session event editor terraintype set attribute]]
*[[Api session event editor weather set attribute]]
*[[Api session event editor zoning set attribute]]
*[[Api session event editor address set attributes]]
*[[Api session event editor area set attributes]]
*[[Api session event editor attributeaction set attributes]]
*[[Api session event editor building set attributes]]
*[[Api session event editor chatchannel set attributes]]
*[[Api session event editor functionoverride set attributes]]
*[[Api session event editor indicator set attributes]]
*[[Api session event editor neighborhood set attributes]]
*[[Api session event editor netfunction set attributes]]
*[[Api session event editor netline set attributes]]
*[[Api session event editor netload set attributes]]
*[[Api session event editor overlay set attributes]]
*[[Api session event editor panel set attributes]]
*[[Api session event editor parametric set attributes]]
*[[Api session event editor scenario set attributes]]
*[[Api session event editor terraintype set attributes]]
*[[Api session event editor weather set attributes]]
*[[Api session event editor zoning set attributes]]
*[[Api session event editor address remove attribute]]
*[[Api session event editor area remove attribute]]
*[[Api session event editor attributeaction remove attribute]]
*[[Api session event editor building remove attribute]]
*[[Api session event editor chatchannel remove attribute]]
*[[Api session event editor functionoverride remove attribute]]
*[[Api session event editor indicator remove attribute]]
*[[Api session event editor neighborhood remove attribute]]
*[[Api session event editor netfunction remove attribute]]
*[[Api session event editor netline remove attribute]]
*[[Api session event editor netload remove attribute]]
*[[Api session event editor overlay remove attribute]]
*[[Api session event editor panel remove attribute]]
*[[Api session event editor parametric remove attribute]]
*[[Api session event editor scenario remove attribute]]
*[[Api session event editor terraintype remove attribute]]
*[[Api session event editor weather remove attribute]]
*[[Api session event editor zoning remove attribute]]
</div>
}}

Latest revision as of 12:14, 14 July 2026

The right panel allows you to add new attributes. The top half allows you to edit existing attributes, the bottom half allows you to add new attributes.

A number of components, such as neighborhoods, areas, buildings and zones, have adjustable attributes. These attributes are used:

  • to provide meaningful information
  • as parameters in calculations
  • to provide (visual) information to distinguish themselves among peers

Attributes can be defined and redefined by a user. Some attributes are predefined by the Tygron Platform and already exist as default properties of a component. Some components can even inherit properties from other type of components, such as a Building that inherits attributes from it's referenced Function.

In general the Tygron Platform allows users to inspect, adjust and reset existing attributes of these components and define and remove new ones.

The group of components than can store attributes is called Attribute Items. The current list of Attribute Items is:

Note that although Globals seem to behave similarly to attributes, they are not part of any specific Attribute Item in a project. Instead they are individual components part of the project.

Attribute values

An attribute always consists of a name and a value. The name of an attribute is usually written in capital letters, and uses underscores in place of spaces. Values must be numbers (positive, negative, or decimal).

Note that not there are some restrictions for attribute names.

Some components have properties which are also reflected in attributes. Properties such as the color of the component are present both as a dedicated property and as an attribute. Changing either the property or the attribute automatically updates the other.

Attributes are unique to each component; sharing an attribute name between components does not link their values.


Attribute arrays

Main article: Attribute array

Attributes are most commonly a single value, but can also be an array of values.

Attribute values during a session

Attributes can be read during a session. Primarily, it is possible to read attributes of components using TQL. By requesting the value of an attribute of a component using TQL, the value of that attribute can be used in, for example, Excel calculations.

It is possible that, when requesting the value of an attribute of a component, that attribute does not exist for that component. In this case, the value of that attribute is deemed to be "0".

Note that this means that an attribute value of 0 can mean that the proper value of the attribute is 0, or that the attribute does not exist.

Attributes can be changed during a session via Events (e.g., AREA_SET_ATTRIBUTE) or TQL, allowing updates from Excel calculations.

Common attribute values

Some attributes may have a more exact spectrum of values which are valid. For example, the ACTIVE attribute is either 1 or a 0.

Note that these attributes can be given other values as well. The resulting behavior for calculations and functionality depending on these attributes is undefined.

ACTIVE

Applies to: Areas, Neighborhoods, Overlays, Indicators and Stakeholders

Some components may have an "active" property. When that property indicates the component is active, the "ACTIVE" attribute's value is "1". When the component is inactive, the attribute's value is "0".

COLOR

Applies to: Areas, Neighborhoods, Zones
Main article: Color

Spatial components with attributes commonly have a "COLOR" attribute, defining the color by which they are displayed.The value corresponds to the color property of that component. When that color property is changed, the attribute is changed, and vice versa.

Examples of special attribute values

URBANIZATION

Applies to: Neighborhoods

The "URBANIZATION" attribute is an indicator for the degree of urbanization. It ranges from 1 (dense urbanization) to 5 (virtually no urbanization).

NATURE_RESERVE

Applies to: Areas

The "NATURE_RESERVE" attribute indicates whether an area is a protected area of nature. This usually means the allowance for pollution and noise is lower. Areas with an "NATURE_RESERVE" attribute value of "1" are deemed protected nature. When the attribute's value is 0, the area is not necessarily deemed protected nature.

Notes

  • When removing attributes which are related to properties of the component, the value of the properties will be changed as well, as though the attribute was set to "0".

How-to's

See also

API Endpoints

Retrieved from "https://support.tygron.com/w/index.php?title=Attribute&oldid=91487"