UI Toolkit uses a powerful layout system that automatically calculates the position and size of individual elements based on the layout parameters in their style properties. This is based on Flexbox, a web layout model. For more information, see Layout Engine.
UI Toolkit has two types of coordinates:
Each visual elementA node of a visual tree that instantiates or derives from the C# VisualElement
class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
See in Glossary determines the coordinate system used to calculate its position. You can configure which coordinate system to use in the element stylesheet.
The following code shows how to set the coordinate space and the position of a visual element through code:
var newElement = new VisualElement();
newElement.style.position = Position.Relative;
newElement.style.left = 15;
newElement.style.top = 35;
The origin of an element is its top left corner.
The layout system computes the VisualElement.layout
property (type Rect
) for each element, which includes the final position of the element. This takes the relative or absolute position of the element into account.
The layout.position
is expressed in points, relative to the coordinate space of its parent.
Each VisualElement
has a transform property (ITransform
) you can use to add an additional local offset to the position and rotation of an element. The offset isn’t represented in the calculated layout property. By default, the transform
is the identity.
Use the worldBound
property to retrieve the final window space coordinates of the VisualElement
, taking into account both the layout position and the transform. This position includes the height of the header of the window.
The VisualElement.layout.position
and VisualElement.transform
properties define how to transform between the local coordinate system and the parent coordinate system.
The VisualElementExtensions
static class provides the following extension methods that transform points and rectangles between coordinate systems:
WorldToLocal
transforms a Vector2
or Rect
from Panel
space to the referential within the element.LocalToWorld
transforms a Vector2
or Rect
to Panel
space referential.ChangeCoordinatesTo
transforms Vector2
or Rect
from the local space of one element to the local space of another.When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.