The visual tree holds all the visual elements in a window. It is an object graph made of lightweight nodes refered to as visual elements.
These nodes are allocated on the C# heap, either manually or by loading UXML assetsAny media or data that can be used in your game or Project. An asset may come from a file created outside of Unity, such as a 3D model, an audio file or an image. You can also create some asset types in Unity, such as an Animator Controller, an Audio Mixer or a Render Texture. More info
See in Glossary from a UXML template file.
Each node contains the layout information, its drawing and redrawing options, and how the node responds to events.
VisualElement
is the common base class for all nodes in the visual tree. The VisualElement
base class contains properties for styles, layout data, local transformations, event handlers, and so on.
VisualElement
has several subclasses that define additional behaviour and functionality, including specialized controls. VisualElement
may have child elements.
You are not required to derive from the VisualElement
base class to work with UIElements. You can customize the look and behavior of a VisualElement
through stylesheets and event callbacks.
The root object of the visual tree is referred to as the panel. A new element is ignored until it is connected to the panel. You can add elements to an existing element to attach your user interface to the panel.
To verify if a VisualElement
is connected to a panel, you can test the panel
property of this element. When the visual element is not connected, the test returns null
.
Note: While UIElements is experimental, you must go through the extension method GetRootVisualContainer()
in the UnityEditor.Experimental.UIElements
namespace. This namespace is required to prevent accidental usage of this property.
The elements in the visual tree are drawn in the following order:
The only way to change their drawing order is to reorder VisualElement
objects in their parents.
You can draw a subtree in a RenderTexture
and re-use the pixelsThe smallest unit in a computer image. Pixel size depends on your screen resolution. Pixel lighting is calculated at every screen pixel. More info
See in Glossary for future redraw events by setting
VisualElement.clippingOptions = ClippingOptions.ClipAndCacheContents
.
The different coordinate systems are defined as follow:
The layout system computes the VisualElement.layout
property (type Rect
) for each element.
The layout.position
is expressed as pixels relative to the coordinate space of its parent. Although you can assign a value to layout.position
directly, it is recommended that you use style sheets and the layout system to position elements.
Each VisualElement
also has a layout.transform
property (typeITransform
) that positions an element relative to its parent. By default, the transform
is the identity.
The VisualElement.layout.position
and VisualElement.layout.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 referentialChangeCoordinatesTo
transforms Vector2
or Rect
from the local space of one element to the local space of another.For example, in the image above, the tree is arranged as follows:
Panel
DockArea
and labelled “Coordinates”)
VisualElement
acts as the root (refered to as “root container”)
VisualElement
acts as a parent of the button (“red container”)
Button
From the point of view of the panel:
position
property (defined in layout
property) is set as (100, 100) because it is relative to its parent: the root container.position
property (defined in layout
property) is set as (0, 0) because it is relative to its parent: the red container.The origin of an element is its top left corner.
Use the worldBound
property to retrieve the window space coordinates of the VisualElement
, taking into account the transforms and positions of its ancestry.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!
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.