VisualElement
Base class for objects that are part of the UIElements visual tree.
Read time 10 minutesLast updated 2 days ago
Definition
- Type: Class
- Namespace: UnityEngine.UIElements
- Assembly: UnityEngine.UIElementsModule
- Inherits from: Focusable
- Implements: IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, ICustomStyle
[UxmlElement(libraryPath = "Containers")][Icon("UIToolkit/Icons/VisualElement.png")]public class VisualElement : Focusable, IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, ICustomStyle
Remarks
VisualElement contains several features that are common to all controls in UIElements, such as layout, styling and event handling. Several other classes derive from it to implement custom rendering and define behaviour for controls.
To inherit from VisualElement and create a custom control, refer to Creating a custom control.
Static Fields
Value | Description |
|---|---|
| disabledUssClassName | USS class name of local disabled elements. |
Constructors
Constructor | Description |
|---|---|
| VisualElement() | Initializes and returns an instance of VisualElement. |
Properties
Property | Description |
|---|---|
| childCount | Number of child elements in this object's contentContainer. |
| contentContainer | Logical container where child elements are added. If a child is added to this element, the child is added to this element's content container instead. |
| contentRect | The rectangle of the content area of the element, in the local space of the element. (Read Only) |
| customStyle | The custom style properties accessor of a VisualElement (Read Only). |
| dataSource | Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. |
| dataSourcePath | Path from the data source to the value. |
| dataSourceType | The possible type of data source assignable to this VisualElement. |
| disablePlayModeTint | Play-mode tint is applied by default unless this is set to true. It's applied hierarchically to this VisualElement and to all its children that exist on an editor panel. |
| enabledInHierarchy | Returns true if the VisualElement is enabled in its own hierarchy. |
| enabledSelf | Returns true if the VisualElement is enabled locally. |
| experimental | Returns the UIElements experimental interfaces. |
| generateVisualContent | Delegate function to generate the visual content of a visual element. |
| hasActivePseudoState | Returns true if this element matches the |
| hasCheckedPseudoState | Returns true if this element matches the |
| hasDisabledPseudoState | Returns true if this element matches the |
| hasEnabledPseudoState | Returns true if this element matches the |
| hasFocusPseudoState | Returns true if this element matches the |
| hasHoverPseudoState | Returns true if this element matches the |
| hasInactivePseudoState | Returns true if this element matches the |
| hasRootPseudoState | Returns true if this element matches the |
| hierarchy | Access to this element physical hierarchy |
| this[] | Retrieves the child element at a specific index. |
| languageDirection | Indicates the directionality of the element's text. The value will propagate to the element's children. |
| layout | The position and size of the VisualElement relative to its parent, as computed by the layout system. (Read Only) |
| localBound | Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the transform, but before applying the layout translation. |
| name | The name of this VisualElement. |
| paddingRect | The rectangle of the padding area of the element, in the local space of the element. |
| panel | The panel onto which this VisualElement is attached. |
| parent | The parent of this VisualElement. |
| pickingMode | Determines if this element can be the target of pointer events or picked by IPanel.Pick queries. |
| resolvedStyle | The final rendered style values of a visual element, as it's rendered in the current frame.(Read Only) |
| resourcesReleased | Indicates if the element has released its reusable resources, in which case it can not be modified or added again. |
| scaledPixelsPerPoint | Return the resulting scaling from the panel that considers the screen DPI and the customizable scaling factor, but not the transform scale of the element and its ancestors. See _scaledPixelsPerPoint. This should only be called on elements that are part of a panel. |
| schedule | Retrieves the IVisualElementScheduler associated to this VisualElement. Use it to enqueue actions. |
| style | Sets the style values on a VisualElement. |
| styleSheets | Returns a VisualElementStyleSheetSet that manipulates style sheets attached to this element. |
| tooltip | Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI. |
| usageHints | A combination of hint values that specify high-level intended usage patterns for the VisualElement. This property can only be set when the VisualElement is not yet part of a Panel. Once part of a Panel, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It's advised to always consider specifying the proper UsageHints, but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform). |
| userData | This property can be used to associate application-specific user data with this VisualElement. |
| viewDataKey | Used for view data persistence, such as tree expanded states, scroll position, or zoom level. |
| visible | Indicates whether or not this element should be rendered. |
| visualTreeAssetSource | Stores the asset reference, if the generated element is cloned from a VisualTreeAsset. |
| worldBound | Returns the axis-aligned bounding box of the element in panel coordinates after the cumulative transform from the IPanel root. |
| worldTransform | Returns a matrix that cumulates the following transformations (in order): |
Methods
Method | Description |
|---|---|
| Add | Adds an element to the contentContainer of this element. |
| AddComponent | Attaches a component of type |
| AddMeshModifier | Registers a modifier that runs after this element's mesh generation completes, before its vertex data is copied to the GPU. |
| AddToClassList | Adds multiple classes to the class list of the element in order to assign styles from USS. Note the class names are case-sensitive. |
| BringToFront | Brings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements. |
| Children | Returns the elements from its contentContainer. |
| ClassListContains | Searches for a class in the class list of this element. |
| Clear | Removes all child elements from this element's _contentContainer. |
| ClearBinding | Removes a binding from the element. |
| ClearBindings | Removes all bindings from the element. |
| ClearClassList | Removes all classes from the class list of this element. VisualElement.AddToClassList |
| ClearMeshModifiers | Removes every modifier previously registered on this element. No-op if none are registered. |
| Contains | Checks if this element is an ancestor of the specified child element. |
| ContainsPoint | Checks if the specified point intersects with this VisualElement's layout. |
| ElementAt | Retrieves the child element at a specific index. |
| EnableInClassList | Enables or disables the class with the given name. |
| FindAncestorUserData | Searches up the hierarchy of this VisualElement and retrieves stored userData, if any is found. |
| FindCommonAncestor | Finds the lowest common ancestor between two VisualElements inside the VisualTree hierarchy. |
| GetBinding | Gets the binding instance for the provided targeted property. |
| GetBindingInfos | Gets information on all the bindings of the current element. |
| GetClasses | Retrieve the classes for this element. |
| GetClassNames | Retrieve the classes for this element. |
| GetComponent | Returns a reference to the attached component of type |
| GetComponentRefOrNullRef | Returns a reference to the component of type |
| GetDataSourceContext | Queries the _dataSource and _dataSourcePath of a binding object. |
| GetFirstAncestorOfType | Walks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type |
| GetFirstOfType | Walks up the hierarchy, starting from this element, and returns the first VisualElement of this type |
| GetHierarchicalDataSourceContext | Queries the _dataSource and _dataSourcePath inherited from the hierarchy. |
| GetOrAddComponent | Returns a reference to the component of type |
| HasBinding | Allows to know if a target property has a binding associated to it. |
| HasComponent | Checks whether a component of type |
| IndexOf | Retrieves the child index of the specified VisualElement. |
| Insert | Insert an element into this element's contentContainer |
| IsMarkedForRepaint | Checks if the VisualElement is marked dirty for repaint. |
| MarkComponentDirty | Marks the attached component of type |
| MarkDirtyRepaint | Marks that the VisualElement requires a repaint. |
| MarkDirtyStyles | Marks the element's resolved styles dirty so the next update re-resolves them, re-reading USS custom property values. The style counterpart of VisualElement.MarkDirtyRepaint. |
| NotifyComponentChanged | Notifies the data binding system that a field of an attached component changed, so a binding targeting that field (for example |
| PlaceBehind | Places this element right before the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually behind of its sibling. |
| PlaceInFront | Places this element right after the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually in front of its sibling. |
| ReleaseResources | Releases reusable resources associated with this element and makes the element unusable. |
| Remove | Removes this child from the _hierarchy of its _contentContainer. |
| RemoveAt | Removes a child, at the provided index, from the list of children of the current element. |
| RemoveComponent | Removes the attached component of type |
| RemoveFromClassList | Removes a class from the class list of the element. |
| RemoveFromHierarchy | Removes this element from its parent hierarchy. |
| RemoveMeshModifier | Removes a previously-registered modifier. The registration is identified by delegate equality; pass the same callback reference that was registered. No-op if the callback is not registered. If the callback was registered more than once, only the first matching registration is removed. |
| SendEvent | Sends an event to the event handler. |
| SendToBack | Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements. |
| SetActivePseudoState | Sets whether or not this element is displayed as being active. |
| SetBinding | Assigns a binding between a target and a source. |
| SetCheckedPseudoState | Sets whether or not this element is displayed as being checked. |
| SetEnabled | Changes the VisualElement enabled state. A disabled visual element does not receive most events. |
| Sort | Reorders child elements from this VisualElement contentContainer. |
| ToggleInClassList | Toggles between adding and removing the given class name from the class list. |
| TryGetBinding | Gets the binding instance for the provided targeted property. |
| TryGetDataSourceContext | Queries the _dataSource and _dataSourcePath of a binding object. |
| TryGetLastBindingToSourceResult | Returns the last BindingResult of a binding object from the UI to the data source. |
| TryGetLastBindingToUIResult | Returns the last BindingResult of a binding object from the data source to the UI. |
| TryRemoveComponent | Removes the attached component of type |
Structs
Struct | Description |
|---|---|
| VisualElement.Hierarchy | Hierarchy is a struct allowing access to the hierarchy of visual elements |
Enums
Enum | Description |
|---|---|
| VisualElement.MeasureMode | The modes available to measure VisualElement sizes. |