UnityEngine.UIElementsModule Abstract base class for the ProgressBar. USS Class Name used to style the background of the ProgressBar. USS Class Name used to style the container of the ProgressBar. Sets the maximum value of the ProgressBar. Sets the minimum value of the ProgressBar. USS Class Name used to style the progress bar of the ProgressBar. Sets the title of the ProgressBar that displays in the center of the control. USS Class Name used to style the container of the title of the ProgressBar. USS Class Name used to style the title of the ProgressBar. USS Class Name used to style the ProgressBar. Sets the progress value. If the value has changed, dispatches an ChangeEvent_1 of type float. Sets the progress value. Defines the alignment behavior along an axis. Let Flex decide. Items are centered on the axis. End margin of the item is placed at the end of the axis. Start margin of the item is placed at the start of the axis. Default. stretch to fill the axis while respecting min/max values. Static class containing utility methods for aligning visual elements. Return the next larger value representing a whole number of pixels on the target when rendered. Return the next smaller value representing a whole number of pixels on the target when rendered. Round the value so that it is a whole number of pixels on the target when rendered. Options to display alternating background colors for collection view rows. Alternate background colors for all rows, regardless of whether they have content. The background color continues to alternate for empty lines. Alternate background colors only for rows that have content. The background color does not alternate for empty lines. Do not alternate background colors for rows. Represents an angle value. The unit of the value property. The angle value. Creates an Angle from a float and an optionnal AngleUnit. Creates an Angle from a float and an optionnal AngleUnit. Creates an Angle from degrees. The created angle. Creates an Angle from gradians The created angle. Creates an Angle from radians The created angle. Returns the value of the angle, expressed in degrees. Returns the value of the angle, expressed in gradians. Returns the value of the angle, expressed in radians. Returns the value of the angle, expressed in turns. Creates an Angle from turns The created angle. Unit of measurement used to express the value of an Angle. Interprets an angle as degrees. Interprets the measurement of an angle in gradians. One full circle is 400 gradians Interprets the measurement of an angle in radians. One full circle is 2Pi radians which approximates to 6.2832 radians Interprets the measurement of an angle, expressed as a number of turns. One full circle is one turn. Direction to use when defining an arc (see Painter2D.Arc). A clockwise direction. A counter-clockwise direction. Event sent after an element is added to an element that is a descendant of a panel. Describes a VisualElement background. The RenderTexture to display as a background. The sprite to display as a background. The texture to display as a background. The VectorImage to display as a background. Creates from a Texture2D. Creates a background from a RenderTexture. The render texture to use as a background. A new background object. Creates a background from a Sprite. The sprite to use as a background. A new background object. Creates a background from a Texture2D. The texture to use as a background. A new background object. Creates a background from a VectorImage. The vector image to use as a background. A new background object. Retrieves the selected asset which can be of a type of Texture, Sprite, RenderTexture or VectorImage. An asset as an object. Help verify whether an asset has been assigned or not. True if no asset is assigned. Script interface for VisualElement background-position style property IStyle.BackgroundPosition. Background position type Background offset Initialize from single position type Initialize from x position type with x offset Defines the position of the background. Vertical alignment is at the bottom. Vertical alignment is centered and/or Horizontal alignment is centered. This is the default value to make sure it's backward compatible with unity-background-scale-mode default value. Horizontal alignment is to the left. Horizontal alignment is to the right. Vertical alignment is at the top. Helper to convert between background properties and ScaleMode. Converts ScaleMode to the equivalent BackgroundPosition property. The ScaleMode to convert. BackgroundPosition. Converts ScaleMode to the equivalent BackgroundRepeat property. The ScaleMode to convert. BackgroundRepeat. Converts ScaleMode to the equivalent BackgroundSize property. The ScaleMode to convert. BackgroundSize. Resolves the background properties to a valid ScaleMode. The X BackgroundPosition to resolve. The Y BackgroundPosition to resolve. The BackgroundRepeat to resolve. The BackgroundSize to resolve. Indicates whether the background properties resolve to a valid ScaleMode. ScaleMode. Script interface for VisualElement background-repeat style property IStyle.backgroundRepeat. Background repeat in the x direction. Background repeat in the y direction. Create a BackgroundRepeat with x and y repeat Script interface for VisualElement background-size style property IStyle.BackgroundSize. Background size type Background size x Background size y Create a BackgroundSize with x and y repeat Create a BackgroundSize using Enum Defines the size of the background. Resize the background image to make sure the image is fully visible. Resize the background image to cover the entire container, even if it has to stretch the image or cut a little bit off one of the edges. Determines if the size of the background image comes from the BackgroundSize.x and BackgroundSize.y length values. A BaseBoolField is a clickable element that represents a boolean value. Optional text that appears after the BaseBoolField. Whether to activate the toggle when the user clicks the label. Creates a BaseBoolField with a Label and a default manipulator. The Label text. Initializes the Label element whenever the BaseBoolField.text property changes. Sets the value of the BaseBoolField, but does not notify the rest of the hierarchy of the change. Inverts the BaseBoolField.value property. This is the base class for the composite fields. USS class name of field groups in elements of this type. USS class name of fields in elements of this type. USS class name of the first field in elements of this type. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type when the fields are displayed on multiple lines. USS class name of spacers in elements of this type. USS class name of elements of this type when the fields are displayed on two lines. USS class name of elements of this type. Abstract base class for controls. A BaseField is a base class for field elements like TextField and IntegerField. To align a BaseField element automatically with other fields in an Inspector window, use the .unity-base-field__aligned USS class. This style class is designed for use with Inspector elements like PropertyField, which has the style class by default. However, if you manually add a child BaseField element to a PropertyField, you must add the style class manually. When the style class is present, the field automatically calculates the label width to align with other fields in the Inspector window. If there are IMGUI fields present, UI Toolkit fields are aligned with them for consistency and compatibility. USS class name of elements that are aligned in a inspector element USS class name of input elements in elements of this type. The string representing the label that will appear beside the field. If the string is empty, the label element is removed from the hierarchy. If the string is not empty, the label element is added to the hierarchy. USS class name of labels in elements of this type, when there is a dragger attached on them. This is the Label object that appears beside the input for the field. USS class name of labels in elements of this type. Read-only label used to give the appearance of editing multiple different values. USS class name of elements that show mixed values USS class name of elements of this type, when there is no label. The value of the element. When set to true, gives the field the appearance of editing multiple different values. USS class name of elements of this type. The value associated with the field. Allow to set a value without being notified of the change, if any. New value to be set. Update the field's visual content depending on showMixedValue. Defines UxmlTraits for the BaseField. Constructor. Provides the base class for field mouse draggers. Sets the drag zone for the driven field. The target of the drag operation. Sets the drag zone for the driven field. The target of the drag operation. The rectangle that contains the drag zone. Traits for the BaseField. Initializes the trait of BaseField. The VisualElement to initialize. Bag of attributes. The creation context associated with these traits. Base class for a list view, a vertically scrollable area that links to, and displays, a list of items. This property allows the user to allow or block the addition of an item when clicking on the Add Button. It must return true or false. This property allows the user to allow or block the removal of an item when clicking on the Remove Button. It must return true or false. The USS class name for the size field of the ListView when show bound collection size is enabled The USS class name for the size field of the ListView when the footer is enabled. The USS class name for the size field of the ListView when foldout header is enabled. This property controls whether every element in the list will get its data source setup automatically to the correct item in the collection's source. The USS class name for label displayed when ListView is empty. The USS class name for the foldout header of the ListView. The name of the add button element in the footer. The name of the remove button element in the footer. The USS class name for the footer of the ListView. This property controls the text of the foldout header when using showFoldoutHeader. This event is called for every item added to the itemsSource. Includes the item index. This event is called for every item removed from the itemsSource. Includes the item index. The USS class name of item elements in ListView elements. The USS class name for ListView when add/remove footer is enabled. The USS class name for ListView when foldout header is enabled. This callback allows the user to make their own footer for this control. This callback allows the user to make their own header for this control. This callback allows the user to set a Visual Element to replace the "List is empty" Label shown when the ListView is empty. This callback allows the user to implement their own code to be executed when the Add Button is clicked. This callback allows the user to implement their own code to be executed when the Remove Button is clicked. The USS class name for label displayed when ListView is trying to edit too many items. This callback allows the user to implement a DropdownMenu when the Add Button is clicked. The USS class name for item container in reorderable animated ListView. The USS class name for drag handle bar in reorderable animated ListView. The USS class name for drag handle in reorderable animated ListView. The USS class name for item elements in reorderable animated ListView. The USS class name for reorderable animated ListView elements. This property controls the drag and drop mode for the list view. The USS class name for scroll view when add/remove footer is enabled. This property controls whether a footer will be added to the list view. This property controls whether the list view displays the collection size (number of items). This property controls whether the list view displays a header, in the form of a foldout that can be expanded or collapsed. The USS class name for ListView elements. The view controller for this view, cast as a BaseListViewController. Creates a BaseListView with all default properties. The BaseVerticalCollectionView.itemsSource must all be set for the BaseListView to function properly. Constructs a BaseListView, with all important properties provided. The list of items to use as a data source. The height of each item, in pixels. Assigns the view controller for this view and registers all events required for it to function properly. The controller to use with this view. Defines UxmlTraits for the BaseListView. Returns an empty enumerable, because list views usually do not have child elements. An empty enumerable. Initializes BaseListView properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Base collection list view controller. View controllers of this type are meant to take care of data virtualized by any BaseListView inheritor. View for this controller, cast as a BaseListView. Raised when an item is added to the CollectionViewController.itemsSource. Raised when an item is removed from the CollectionViewController.itemsSource. Raised when the CollectionViewController.itemsSource size changes. Adds a certain amount of items at the end of the collection. The number of items to add. Removes all items from the source. Moves an item in the source. The source index. The destination index. Returns whether this item needs a drag handle or not with the Animated drag mode. Item index. Whether or not the drag handle is needed. Invokes the itemsAdded event. Invokes the itemsRemoved event. Invokes the itemsSourceSizeChanged event. Removes an item from the source, by index. The item index. Removes items from the source, by indices. A list of indices to remove. This is the base class for all the popup field elements. TValue and TChoice can be different, see MaskField, or the same, see PopupField USS class name of arrow indicators in elements of this type. The list of choices to display in the popup menu. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. This is the text displayed to the user for the current selection of the popup. This is the text displayed. USS class name of text elements in elements of this type. USS class name of elements of this type. Allow changing value without triggering any change event. The new value. This is a base class for the Slider fields. This is the actual property to contain the direction of the slider. USS class name of container elements in elements of this type. USS class name of the dragger border element in elements of this type. USS class name of dragger elements in elements of this type. Enables fill to set the color and shape of a slider. USS class name of fill element in elements of this type. This is the maximum value that the slider encodes. USS class name of elements of this type, when they are displayed horizontally. USS class name of input elements in elements of this type. This indicates whether or not this slider is inverted. For an inverted horizontal slider, high value is located to the left, low value is located to the right For an inverted vertical slider, high value is located to the bottom, low value is located to the top. USS class name of labels in elements of this type. This is the minimum value that the slider encodes. USS class name on the dragger that indicates it is currently controlled by NavigationMoveEvent. When the slider detects move events aligned with the slider's direction, it adjusts the slider's value. If it detects a navigation submit event, it removes the style, causing all navigation events to revert to their default behavior. A second navigation submit event re-applies the style to the dragger and restores the previous customized behavior. Represents the value that should be applied to the calculated scroll offset while scrolling the slider, such as when clicking within the track or clicking the slider arrows. This is the range from the minimum value to the maximum value of the slider. The visibility of the optional field inside the slider control. USS class name of the text field element in elements of this type. USS class name of tracker elements in elements of this type. USS class name of elements of this type. The actual value of the slider. USS class name of elements of this type, when they are displayed vertically. Method used to adjust the dragelement. Mainly used in a scroller. The factor used to adjust the drag element, where a value &gt; 1 will make it invisible. Called when the user is dragging the label to update the value contained in the field. Delta on the move. Speed of the move. Starting value. Defines UxmlTraits for the BaseSlider. This class must be used instead of the non-generic inherited UxmlTraits equivalent. Constructor. Base class for a tree view, a vertically scrollable area that links to, and displays, a list of items organized in a tree. When true, items are automatically expanded when added to the TreeView. The USS class name for TreeView item container elements. Raised when an item is expanded or collapsed. The USS class name for TreeView indent container elements. The USS class name for TreeView indent element. Access to the itemsSource. For a TreeView, the source contains the items wrappers. The USS class name for TreeView item toggle elements. The USS class name for TreeView item elements. The USS class name for TreeView elements. The view controller for this view, cast as a BaseTreeViewController. Adds an item to the existing tree. Item to add. The parent id for the item. The child index in the parent's children list. Whether we should call RebuildTree and RefreshItems or not. Set to false when doing multiple additions to save a few rebuilds. Adds an item to the current selection by id. The item id. Collapses all TreeView items, including children. Collapses the specified TreeView item. The TreeView item identifier. When true, all children will also get collapsed. This is false by default. Whether to refresh items or not. Set to false when doing multiple operations on the tree, to only do one RefreshItems once all operations are done. This is true by default. Creates a TreeView with all default properties. Creates a TreeView with specified factory methods using the fixed height virtualization method. The item height to use in FixedHeight virtualization mode. Expands all TreeView items, including children. Expands the specified TreeView item. The TreeView item identifier. When true, all children will also get expanded. This is false by default. Whether to refresh items or not. Set to false when doing multiple operations on the tree, to only do one RefreshItems once all operations are done. This is true by default. Expands all root TreeView items. Gets children identifiers for the specified TreeView item. The TreeView item index. The children item identifiers. Gets the specified TreeView item's identifier. The TreeView item index. The TreeView item's identifier. Gets data for the specified TreeView item id. The TreeView item id. The TreeView item data. Gets data for the specified TreeView item index. The TreeView item index. The TreeView item data. Gets the specified TreeView item's parent identifier. The TreeView item index. The TreeView item's parent identifier. Gets the root item identifiers. The root item identifiers. Gets tree data for the selected item indices. The selected TreeViewItemData items. Gets the TreeView's total number of items. The TreeView's total number of items. Returns true if the specified TreeView item is expanded, false otherwise. The TreeView item identifier. Removes an item from the current selection by id. The item id. Sets the root items to use with the default tree view controller. The TreeView root items. Sets the currently selected item by id. The item id. Sets a collection of selected items by ids. The item ids. Sets a collection of selected items by id, without triggering a selection change callback. The item ids. Assigns the view controller for this view and registers all events required for it to function properly. The controller to use with this view. Removes an item of the tree if it can find it. The item id. Whether we need to rebuild tree data. Set to false when doing multiple additions to save a few rebuilds. If the item was removed from the tree. Defines UxmlTraits for the TreeView. Base collection tree view controller. View controllers of this type are meant to take care of data virtualized by any BaseTreeView inheritor. View for this controller, cast as a BaseTreeView. Items for this tree. Contains items that are expanded in the tree. Determines whether the item with the specified ID can be expanded or collapsed. Collapses all items in the tree and refreshes the view. Collapses the item with the specified ID, hiding its children. Allows to collapse the whole hierarchy under that item. The item ID. Whether the whole hierarchy under that item will be collapsed. Whether to refresh items or not. Set to false when doing multiple operations on the tree, to only do one RefreshItems once all operations are done. Collapses the item with the specified index, hiding its children. Allows to collapse the whole hierarchy under that item. The item index. Whether the whole hierarchy under that item will be collapsed. Whether to refresh items or not. Set to false when doing multiple operations on the tree, to only do one RefreshItems once all operations are done. This is true by default. Checks if an ID exists within this tree. The id to look for. Whether an item with this id exists in the tree. Expands all items in the tree and refreshes the view. Expands the item with the specified ID, making its children visible. Allows to expand the whole hierarchy under that item. The item ID. Whether the whole hierarchy under that item will be expanded. Whether to refresh items or not. Set to false when doing multiple operations on the tree, to only do one RefreshItems once all operations are done. This is true by default. Expands the item with the specified index, making his children visible. Allows to expand the whole hierarchy under that item. The item index. Whether the whole hierarchy under that item will be expanded. Whether to refresh items or not. Set to false when doing multiple operations on the tree, to only do one RefreshItems once all operations are done. Returns all item IDs that can be found in the tree, optionally specifying root IDs from where to start. Root IDs to start from. If null, will use the tree root ids. All items IDs in the tree, starting from the specified IDs. Gets the child index under the parent of the item with the specified ID. The item ID. The child index under the parent. Returns -1 if the item has no parent or doesn't exist in the tree. Get all children of a specific ID in the tree. The item ID. The children IDs. Gets the children IDs of the item with the specified index. The item index. The children IDs. Returns the ID for a specified index in the visible items source. Returns the depth of the element at that ID. The item ID. The depth of the element. Return the depth of the element at that index. The item index. The depth of the element. Returns the index in the source of the item, by ID. The ID of the item to look for. The index of the item in the expanded items source. Returns -1 if the item is not visible. Returns the parent ID of an item, by ID. The ID of the item to fetch the parent from. The parent ID, or -1 if the item is at the root of the tree. Returns the root items of the tree, by IDs. The root item IDs. Get the number of items in the whole tree. The number of items in the tree. Return whether the item with the specified ID has one or more child. The item id. Whether the item with the specified ID has one or more child. Return whether the item with the specified index has one or more child. The item index. Whether the item with the specified ID has one or more child. Return whether the item with the specified ID is expanded in the tree. The item ID Whether the item with the specified ID is expanded in the tree. Return whether the item with the specified index is expanded in the tree. The item index Whether the item with the specified index is expanded in the tree. Will return false if the index is not valid. Moves an item by ID, to a new parent and child index. The ID of the item to move. The new parent ID. -1 if moved at the root. The child index to insert at under the parent. -1 will add as the last child. Whether we need to rebuild tree data. Set to false when doing multiple operations. Rebuilds the tree item data and regenerates wrappers to fill the source. Removes an item by id. The item id. Whether to refresh the tree data. Set to <c>false<c> when doing multiple operations and call <see cref="BaseVerticalCollectionView.RefreshItems()" >. Whether the item was successfully found and removed. Generic base class for UXML element factories, which instantiate a VisualElement using the data read from a UXML file. Returns UxmlTraitscanHaveAnyAttribute (where UxmlTraits is the argument for T1). Returns an empty string if T0 is not VisualElement; otherwise, returns "VisualElement". Returns the namespace for substituteForTypeName. Returns the fully qualified name for substituteForTypeName. Returns an empty enumerable. Returns an empty enumerable. Returns the type name of T0. Returns the namespace name of T0. Returns the type fully qualified name of T0. Returns the type of T0. Returns true. The attribute bag. Always true. Base class that describes a VisualElement derived class for the parsing of UXML files and the generation of UXML schema definition. Must return true if the UXML element attributes are not restricted to the values enumerated by uxmlAttributesDescription. Describes the UXML attributes expected by the element. The attributes enumerated here will appear in the UXML schema. Describes the types of element that can appear as children of this element in a UXML file. Base class for controls that display virtualized vertical content inside a scroll view. Obsolete. Use ListView.bindItem or TreeView.bindItem instead. The USS class name for BaseVerticalCollectionView elements with a border. Called when a drag operation wants to start in this collection view. Returns the content container for the BaseVerticalCollectionView. Because the BaseVerticalCollectionView control automatically manages its content, this always returns null. Obsolete. Use ListView.destroyItem or TreeView.destroyItem instead. Called when a drag operation updates in this collection view. The USS class name of the drag hover bar. The USS class name of the drag hover circular marker used to indicate depth. The height of a single item in the list, in pixels. Called when a drag operation is released in this collection view. This property controls whether the collection view shows a horizontal scroll bar when its content does not fit in the visible area. The USS class name for odd rows in the BaseVerticalCollectionView. The USS class name applied to an item element on drag hover. Obsolete. Use BaseVerticalCollectionView.fixedItemHeight instead. Called when an item is moved in the itemsSource. Callback triggered when the user acts on a selection of one or more items, for example by double-clicking or pressing Enter. The USS class name of selected item elements in the BaseVerticalCollectionView. The data source for collection items. Raised when the data source of a vertical collection view is assigned a new reference or new type. The USS class name of item elements in BaseVerticalCollectionView elements. The USS class name of the scroll view in the BaseVerticalCollectionView. Obsolete. Use ListView.makeItem or TreeView.makeItem instead. Obsolete. Use BaseVerticalCollectionView.itemsChosen instead. Obsolete. Use BaseVerticalCollectionView.selectedIndicesChanged instead. Obsolete. Use BaseVerticalCollectionView.selectionChanged instead. Gets or sets a value that indicates whether the user can drag list items to reorder them. Obsolete, will be removed from the API. Returns the persistent IDs of selected items in the data source, regardless of whether they are collapsed or not. Always returns an enumerable, even if no item is selected, or a single item is selected. Returns or sets the selected item's index in the data source. If multiple items are selected, returns the first selected item's index. If multiple items are provided, sets them all as selected. If no item is selected, returns -1. Returns the indices of selected items in the data source. Always returns an enumerable, even if no item is selected, or a single item is selected. Callback triggered when the selection changes. Returns the selected item from the data source. If multiple items are selected, returns the first selected item. Returns the selected items from the data source. Always returns an enumerable, even if no item is selected, or a single item is selected. Callback triggered when the selection changes. Controls the selection type. Called when a drag operation starts in this collection view. This property controls whether the background colors of collection view rows alternate. Takes a value from the AlternatingRowBackground enum. Enable this property to display a border around the collection view. Obsolete. Use ListView.unbindItem or TreeView.unbindItem instead. The USS class name for BaseVerticalCollectionView elements. The view controller for this view. The virtualization method to use for this collection when a scroll bar is visible. Takes a value from the CollectionVirtualizationMethod enum. Adds an item to the collection of selected items. Item index. Deselects any selected items. Creates the view controller for this view. Override this method in inheritors to change the controller type. The view controller. Creates a BaseVerticalCollectionView with all default properties. The BaseVerticalCollectionView.itemsSource must all be set for the BaseVerticalCollectionView to function properly. Constructs a BaseVerticalCollectionView, with all required properties provided. The list of items to use as a data source. The height of each item, in pixels. For <c>FixedHeight</c> virtualization only. Gets the root element of the specified collection view item. The item identifier. The item's root element. Gets the root element of the specified collection view item. The item index. The item's root element. Clears the collection view, recreates all visible visual elements, and rebinds all items. Obsolete. Use BaseVerticalCollectionView.Rebuild instead. Rebinds a single item if it is currently visible in the collection view. The item index. Rebinds all items currently visible. Removes an item from the collection of selected items. The item index. Scrolls to a specific VisualElement. The element to scroll to. Obsolete. Use BaseVerticalCollectionView.ScrollToItemById instead. Item id to scroll to. Scrolls to a specific item index and makes it visible. Item index to scroll to. Specify -1 to make the last item visible. Scrolls to a specific item id and makes it visible. Item id to scroll to. Sets the currently selected item. The item index. Sets a collection of selected items. The collection of the indices of the items to be selected. Sets a collection of selected items without triggering a selection change callback. The collection of items to be selected. Assigns the view controller for this view and registers all events required for it to function properly. The controller to use with this view. Defines UxmlTraits for the BaseVerticalCollectionView. Returns an empty enumerable, because list views usually do not have child elements. An empty enumerable. Constructor. Initializes BaseVerticalCollectionView properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Element that can be bound to a property. For more information, refer to. Binding object that will be updated. Path of the target property to be bound. Instantiates a BindableElement using the data read from a UXML file. Defines UxmlTraits for the BindableElement. Constructor. Initialize BindableElement properties using values from the attribute bag. Provides information about the property that has changed. Returns the name of the property that has changed. Instantiates a new BindablePropertyChangedEventArgs. The name of the property that has changed. Base class for defining a binding. When set to true, the binding instance updates during the next update cycle. When set to false, the binding instance updates only if a change is detected. When set to BindingUpdateTrigger.EveryUpdate, the binding instance updates in every update, regardless of the data source version. Notifies the binding system to process this binding. Called when the binding becomes active for a specific VisualElement. Context object. Called when the resolved data source of a binding changes. Context object. Called when the binding is no longer active for a specific VisualElement. Context object. Resets the log level for binding failures on a panel to use the global setting. The panel to reset the global log level. Sets the log level for all binding failures. The log level. Sets the log level for binding failures on a panel. The panel to apply to. The log level. Contains information passed to binding instances during registration and deregistration. The binding id being activated/deactivated. The target element of the binding. Context object containing the necessary information to resolve a binding. The binding ID of the element to bind. The data source that was resolved for a given binding. The resolved path to the value in the source, including relative data source paths found in the hierarchy between the target and to the resolved source owner. The target element of the binding. Defines a binding property that serves as an identifier for the binding system. Instantiate a new binding property. The path of the property. Instantiate a new binding property. The path of the property. Indicates whether two binding properties are equal. The object to compare with the current instance. true if obj and this instance are the same type and represent the same value; otherwise, false. Converts a PropertyPath to a BindingId. The path to the property. The property. Converts a string to a BindingId. The name of the property. The property. Converts a BindingId to a PropertyPath. The property. A path for the property. Converts a BindingId to a string . The property. A path for the property. Returns an invalid binding property. Returns the binding property as a string. The property path. Provides information about a binding. The binding matching this information. The binding id. The visual element targeted by the binding. Options to change the log level for warnings that occur during the update of data bindings. Log warnings to the console when a binding is updated. Never log warnings. Log warnings only once when the result of the binding changes. Binding mode to control how a binding is updated. Changes will only be replicated from the UI to the data source for this binding. Changes will only be replicated from the source to the UI for this binding. Changes will only be replicated once, from the source to the UI. This binding will be ignored on subsequent updates. Changes on the data source will be replicated in the UI. Changes on the UI will be replicated to the data source. Provides information about the binding update. Gets the message associated with the binding update. The status from the binding update. Constructs a binding result. The status of the binding. The message linked to the status. Option to change the data source assignation when using Data Binding in collection views. The items source and indexed path are automatically assigned to each item's data source. Data source assignation will be handled by user code when binding each item. Status to report the result of a binding update. Indicates that the binding has failed to process the update. Indicates that the binding has not yet completed the update. Indicates that the binding has successfully processed the update. Option to tell a binding when to update. On every update, regardless of data source changes. Only when a change is detected in the source or Binding.MarkDirty has been called. Only when Binding.MarkDirty has been called. Event sent immediately after an element has lost focus. This event trickles down and does not bubbles up. A Bounds editor field. For more information, refer to. USS class name of center fields in elements of this type. USS class name of extents fields in elements of this type. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Initializes and returns an instance of BoundsField. Initializes and returns an instance of BoundsField. The text to use as a label. Instantiates a BoundsField using the data read from a UXML file. Defines UxmlTraits for the BoundsField. Initialize BoundsField properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. A BoundsInt field. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of position fields in elements of this type. USS class name of size fields in elements of this type. USS class name of elements of this type. Initializes and returns an instance of BoundsIntField. Initializes and returns an instance of BoundsIntField. The text to use as a label. Instantiates a BoundsIntField using the data read from a UXML file. Defines UxmlTraits for the BoundsIntField. Initializes the UxmlTraits for the BoundsIntField. The <see cref="VisualElement" /> to be initialized. Bag of attributes. CreationContext, unused. Styled visual element to match the IMGUI Box Style. For more information, refer to. USS class name of elements of this type. Initializes and returns an instance of Box. Instantiates a Box using the data read from a UXML file. This is a clickable button. Clickable MouseManipulator for this Button. Callback triggered when the button is clicked. The Texture, Sprite, or VectorImage that will represent an icon within a Button element. The USS class name for Button elements with an icon only, no text. The USS class name for Button elements with an icon. The USS class name of the image element that will be used to display the icon texture. Obsolete. Use clicked instead. USS class name of elements of this type. Constructs a Button. Constructs a button with a Background and an Action. The image definition will be used to represent an icon while the Action is triggered when the button is clicked. The image value that will be rendered as an icon. The action triggered when the button is clicked. Constructs a button with an Action that is triggered when the button is clicked. The action triggered when the button is clicked. Instantiates a Button using data from a UXML file. Defines UxmlTraits for the Button. Constructor. Interface for classes capable of having callbacks to handle events. Executes logic after the callbacks registered on the event target have been executed, unless the event has been marked to prevent its default behaviour. EventBase_1.PreventDefault. The event instance. Executes logic after the callbacks registered on each element in the BubbleUp phase have been executed, unless the event propagation is stopped by one of the callbacks. EventBase_1.PreventDefault. The event instance. Executes logic on this element during the BubbleUp phase, immediately before this element's BubbleUp callbacks. Calling StopPropagation will prevent further invocations of this method along the propagation path. The event instance. Executes logic on this element during the TrickleDown phase, immediately after this element's TrickleDown callbacks. Calling StopPropagation will prevent further invocations of this method along the propagation path. The event instance. Return true if event handlers for the event propagation BubbleUp phase have been attached to this object. True if the object has event handlers for the BubbleUp phase. Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object. True if the object has event handlers for the TrickleDown phase. Informs the data binding system that a property of a control has changed. The property that has changed. Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. The event handler to add. By default, this callback is called during the BubbleUp phase. Pass TrickleDown.TrickleDown to call this callback during the TrickleDown phase. Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. The event handler to add. Data to pass to the callback. By default, this callback is called during the BubbleUp phase. Pass TrickleDown.TrickleDown to call this callback during the TrickleDown phase. Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. The event handler is automatically unregistered after it has been invoked exactly once. The event handler to add. By default, this callback is called during the BubbleUp phase. Pass TrickleDown.TrickleDown to call this callback during the TrickleDown phase. Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. The event handler is automatically unregistered after it has been invoked exactly once. The event handler to add. Data to pass to the callback. By default, this callback is called during the BubbleUp phase. Pass TrickleDown.TrickleDown to call this callback during the TrickleDown phase. Sends an event to the event handler. The event to send. Remove callback from the instance. The callback to remove. If this callback was never registered, nothing happens. Set this parameter to true to remove the callback from the TrickleDown phase. Set this parameter to false to remove the callback from the BubbleUp phase. Remove callback from the instance. The callback to remove. If this callback was never registered, nothing happens. Set this parameter to true to remove the callback from the TrickleDown phase. Set this parameter to false to remove the callback from the BubbleUp phase. Information about a drag-and-drop operation that is about to start. See BaseVerticalCollectionView.canStartDrag. The element on which the drag operation is starting. The ID of the dragged element. The selected IDs in the source. Sends an event when a value in a field changes. The new value. The value before the change occured. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The previous value. The new value. An initialized event. Sets the event to its initial state. Manipulator that tracks Mouse events on an element and callbacks when the elements is clicked. This property tracks the activation of the manipulator. Set it to true when the manipulator is activated. Callback triggered when the target element is clicked. Callback triggered when the target element is clicked, including event data. Specifies the mouse position saved during the last mouse event on the target Element. Constructor. Determines when the event begins. Value is defined in milliseconds. Applies if delay is greater than 0. Determines the time delta between event repetition. Value is defined in milliseconds. Applies if interval is greater than 0. Constructor. Constructor. Invokes a click action. This method is called when a PointerDownEvent is sent to the target element. The event. This method is called when a PointerMoveEvent is sent to the target element. The event. This method is called when a PointerUpEvent is sent to the target element. The event. This method processes the up cancel sent to the target Element. This method processes the down event sent to the target Element. This method processes the move event sent to the target Element. This method processes the up event sent to the target Element. Called to register mouse event callbacks on the target element. Called to unregister event callbacks from the target element. This event is sent when the left mouse button is clicked. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. Base collection view controller. View controllers are meant to take care of data virtualized by any BaseVerticalCollectionView inheritor. Raised when an item in the source changes index. The first argument is source index, second is destination index. The items source stored in a non-generic list. Raised when the itemsSource changes. The view for this controller. Binds a row to an item index. The element from that row, created by MakeItem(). The item index. Destroys a VisualElement when the view is rebuilt or cleared. The element being destroyed. Called when this controller is not longer needed to provide a way to release resources. Returns the id for the specified index. The item index. The item id. Returns the index for the specified id. The item id.. The item index. Returns the item with the specified ID. The item ID. The object in the source with this ID. Returns the item with the specified index. The item index. The object in the source at this index. Returns the expected item count in the source. The item count. Creates a VisualElement to use in the virtualization of the collection view. A VisualElement for the row. Initialization step once the view is set. Invokes the itemIndexChanged event. The source index. The destination index. Invokes the itemsSourceChanged event. Set the itemsSource without raising the itemsSourceChanged event. The new source. Sets the view for this controller. The view for this controller. Must not be null. Unbinds a row to an item index. The element from that row, created by MakeItem(). The item index. Options to change the virtualization method used by the collection view to display its content. Collection view will use the actual height of every item when geometry changes. More flexible but less performant. Collection view won't wait for the layout to update items, as the all have the same height. fixedItemHeight Needs to be set. More performant but less flexible. Represents a column in multi-column views such as multi-column list view or multi-column tree view. Provides the properties to define how user interacts with a column in a multi-column view, how its data and the data of each cell in this column are represented. Callback for binding the specified data item at the given row to the visual element. Callback for binding the header element to this column. Path of the target property to be bound. The VisualElement that is the template for each cell of the column. The column collection that contains this column. The comparison to use when using ColumnSortingMode.Default. Compares two items by their index in the source. Callback for destroying the VisualElement that was built for this column. Callback for destroying the visual representation of the column in the header. The VisualElement that is the template for the header of the column. The icon of the column. Callback for constructing the VisualElement that is the template for each cell of the column. Callback for constructing the visual representation of the column in the header. The maximum width of the column. The minimum width of the column. The name of the column. Indicates whether the column is optional. Optional columns be shown or hidden interactively by the user. Called when a property has changed. Indicates whether the column can be resized interactively by the user. Indicates whether the column can be sorted. Indicates whether the column will be automatically resized to fill the available space within its container. The title of the column. Callback for unbinding the specified data item at the given row from the visual element. Callback for unbinding the header element to this column. Indicates whether the column is visible. The desired width of the column. Represents a collection of columns. Indicates the column that needs to be considered as the primary column, by ID. Called when a property has changed. Indicates whether the columns can be reordered interactively by user. Indicates whether the columns can be resized interactively by user. Indicates whether columns are resized as the user drags resize handles or only upon mouse release. Indicates how the size of columns in this collection is automatically adjusted as other columns or the containing view get resized. The default value is StretchMode.GrowAndFill Adds a column at the end of the collection. The column to add. Removes all columns from the collection. Whether the columns contain the specified name. The name of the column to look for. Whether a column with the given name exists or not. Copies the elements of the current collection to a Array, starting at the specified index. The array to copy to. The starting index. Gets the number of columns in the collection. Returns an enumerator that iterates through the collection. The enumerator. Returns the index of the specified column if it is contained in the collection; returns -1 otherwise. The column to locate in the <see cref="Columns" />. The index of the column if found in the collection; otherwise, -1. Inserts a column into the current instance at the specified index. Index to insert to. The column to insert. Checks if the specified column is the primary one. The column to check. Whether or not the specified column is the primary one. Gets a value indicating whether the collection is readonly. Removes the first occurence of a column from the collection. The column to remove. Whether it was removed or not. Removes the column at the specified index. The index of the column to remove. Reorders the display of a column at the specified source index, to the destination index. The display index of the column to move. The display index where the column will be moved to. Indicates how the size of a stretchable column in this collection should get automatically adjusted as other columns or its containing view get resized. The default value is StretchMode.Grow. The size of stretchable columns is automatically and proportionally adjusted only as its container gets resized. Unlike StretchMode.GrowAndFill, the size is not adjusted to fill any available space within its container when other columns are resized. The size of stretchable columns is automatically adjusted to fill the available space within its container when this container or other columns get resized Returns the column at the specified index. The index of the colum to locate. The column at the specified index. Returns the column at the specified index. The index of the colum to locate. The column at the specified index. Defines the sorting mode of a MultiColumnListView or MultiColumnTreeView. Sorting is left to the user in the MultiColumnListView.columnSortingChanged or MultiColumnTreeView.columnSortingChanged. The default Unity sorting will be used. Define how to compare items in a column with Column.comparison. Sorting is disabled. Base class for command events. The command to validate or execute. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An IMGUI command event. An initialized event. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The command name. An initialized event. Resets the event members to their initial values. The event sent when clicking the right mouse button. Describes in which context a VisualElement hierarchy is being ran. Currently running in the Unity Editor. Currently running in an Unity Player. Use this class to display a contextual menu. Displays the contextual menu. The event that triggered the display of the menu. The element for which the menu is displayed. True if a contextual menu was effectively displayed. Checks if the event triggers the display of the contextual menu. This method also displays the menu. The event to inspect. The element for which the menu is displayed. Displays the contextual menu. The menu to display. The event that triggers the display of the contextual menu. Manipulator that displays a contextual menu when the user clicks the right mouse button or presses the menu key on the keyboard. Constructor. Check whether the handling of contextual menu events needs to be adapted for OSX. True if it needs to operate as it would on OSX. False otherwise. Register the event callbacks on the manipulator target. Unregister the event callbacks from the manipulator target. The event sent when a contextual menu requires menu items. The event trickles down and bubbles up. The menu to populate. The event that triggered the ContextualMenuPopulateEvent. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The event that triggered the display of the contextual menu. The menu to populate. The element that triggered the display of the contextual menu. The menu manager that displays the menu. An initialized event. Resets the event members to their initial values. A type to hold information about a conversion registry used locally on bindings. Optional description for a converter group ID that may include information about what this group contains or is used for, to be displayed to users to assist while authoring. Optional and alternative name for a converter group ID, to be displayed to users to assist while authoring. The group id. Adds a converter to the group. The converter to add. Creates a ConverterGroup. The group id. The group display name. The group description. Converts the specified value from TSource to TDestination using only the converter group. The source value to convert. The converted destination value if the conversion succeeded, and the default value otherwise. true if the conversion succeeded, and false otherwise. Sets the value of a property at the given path to the given value, using this converter group or the global ones. The container whose property needs to be set. The path of the property to set. The value to assign to the property. The return code of the conversion. true if the value was set correctly, and false otherwise. Provides a set of static methods to register and use converter groups and registers a set of global converters. ConverterGroup. DataBinding. Registers a converter group by ID. Converter groups can be applied on a binding using local converters. The converter group to register. Registers a global UI conversion delegate that will be used when converting data between a data source and a UI control. This delegate will be used both when converting data from and to UI. The delegate that handles the conversion. Converts the specified value from TSource to TDestination using the registered global converters. The source value to convert. The converted destination value if the conversion succeeded, and the default value otherwise. true if the conversion succeeded, and false otherwise. Retrieves a converter group by ID. The group ID. The converter group. Sets the value of a property at the given path to the given value, using the global converters. The container whose property needs to be set. The path of the property to set. The value to assign to the property. The return code of the conversion. true if the value was set correctly, and false otherwise. This structure holds information used during UXML template instantiation. The element into which the visualTreeAsset is being cloned or instantiated. VisualTreeAsset.CloneTreeVisualTreeAsset.Instantiate The target UXML file to clone or instantiate. Script interface for VisualElement cursor style property IStyle.cursor. The offset from the top left of the texture to use as the target point (must be within the bounds of the cursor). The texture to use for the cursor style. To use a texture as a cursor, import the texture with "Read/Write enabled" in the texture importer (or using the "Cursor" defaults). Base class for general purpose binding extensibility. Called when the binding system updates the binding. Context object containing the necessary information to resolve a binding. A BindingResult indicating if the binding update succeeded or not. Define a custom style property for an element to be retrieved with CustomStyleResolvedEvent. Name of the custom property. Creates custom property from a string. Name of the property. Must start with a -- prefix. Event sent after the custom style properties of a VisualElement have been resolved. Returns the custom style properties accessor for the targeted VisualElement. Binding type that enables data synchronization between a property of a data source and a property of a VisualElement. Controls how this binding should be updated. The default value is BindingMode.TwoWay. Object that serves as a local source for the binding, and is particularly useful when the data source is not part of the UI hierarchy, such as a static localization table. If this object is null, the binding resolves the data source using its normal resolution method. Path from the data source to the value. The possible data source types that can be assigned to the binding. Returns the ConverterGroup used when trying to convert data from the data source to a UI property. Returns the ConverterGroup used when trying to convert data from a UI property back to the data source. Applies a ConverterGroup to this binding that will be used when converting data between a UI control to a data source. The converter group. Applies a ConverterGroup to this binding that will be used when converting data between a data source to a UI control. The converter group. Initializes and returns an instance of DataBinding. Callback called to allow derived classes to update the data source with the resolved value when a change from the UI is detected. Context object containing the necessary information to resolve a binding. The resolved value from the data source. A BindingResult indicating if the binding update succeeded or not. Callback called to allow derived classes to update the UI with the resolved value from the data source. Context object containing the necessary information to resolve a binding. The resolved value from the data source. A BindingResult indicating if the binding update succeeded or not. Contains information about the data source and data source path of a binding. The resolved data source. The resolved data source path. Creates a new instance of a DataSourceContext. The data source. The data source path. Contains information passed to binding instances when the resolved data source context has changed. Returns the id of the binding. Returns the newly resolved data source of the binding. Returns the previous resolved data source context of the binding. Returns the target element of the binding. Default implementation of a MultiColumnTreeViewController. Adds an item to the tree. Item to add. The parent id for the item. The child index in the parent's children list. Whether to refresh the tree data immediately. If <c>false<c>, call <see cref="BaseVerticalCollectionView.RefreshItems()" >. The constructor for DefaultMultiColumnTreeViewController. The columns data used to initialize the header. The sort data used to initialize the header. The sorted columns for the view. Gets data for the specified TreeView item ID. The TreeView item ID. The data. Gets data for the specified TreeView item index. The TreeView item index. The data. Gets the tree item data for the specified TreeView item ID. The TreeView item ID. The tree item data. Gets the tree item data for the specified TreeView item index. The TreeView item index. The tree item data. Sets the root items. The TreeView root items. Default implementation of a TreeViewController. Adds an item to the tree. Item to add. The parent id for the item. The child index in the parent's children list. Whether to refresh the tree data immediately. If <c>false<c>, call <see cref="BaseVerticalCollectionView.RefreshItems()" >. Gets data for the specified TreeView item ID. The TreeView item ID. The data. Gets data for the specified TreeView item index. The TreeView item index. The data. Gets the tree item data for the specified TreeView item ID. The TreeView item ID. The tree item data. Gets the tree item data for the specified TreeView item index. The TreeView item index. The tree item data. Sets the root items. The TreeView root items. Speed at which the value changes for a given input device delta. The value changes at four times the normal rate. The value changes at the normal rate. The value changes at one quarter of its normal rate. Event sent just before an element is detached from its parent, if the parent is the descendant of a panel. Defines how an element is displayed in the layout. The element displays normally. The element isn't visible and absent from the layout. Makes a text field for entering doubles. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Applies the values of a 3D delta and a speed from an input device. A vector used to compute the value change. A multiplier for the value change. The start value. Constructor. Constructor. Maximum number of characters the field can take. Constructor. Maximum number of characters the field can take. Converts a string to a double. The string to convert. The double parsed from the string. Instantiates a DoubleField using the data read from a UXML file. Defines UxmlTraits for the DoubleField. Converts the given double to a string. The double to be converted to string. The double as string. Data stored during drag-and-drop operations, enabling information to be carried throughout the process. A list of paths to the assets being dragged. The object that started the drag. Unity Object references being dragged. The state of the current drag operation. Gets data associated with the current drag-and-drop operation. The key for this entry. The object stored for this key. Sets data associated with the current drag-and-drop operation. The key for this entry. The data to store. Base class for drag and drop events. Position where the drop operation occurs. Dragging between items, to add as a sibling. Dragging in front or after visible items. Dragging over an item, to add as a child. Use the DragEnterEvent class to manage events that occur when dragging enters an element or one of its descendants. The DragEnterEvent does not trickle down and does not bubble up. Constructor. Avoid renewing events. Instead, use GetPooled() to get an event from a pool of reusable events. Resets the event members to their initial values. The event sent to a dragged element when the drag and drop process ends. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An IMGUI drag exited event. An initialized event. Resets the event members to their initial values. Use the DragLeaveEvent class to manage events sent when dragging leaves an element or one of its descendants. The DragLeaveEvent does not trickle down and does not bubble up. Constructor. Avoid renewing events. Instead, use GetPooled() to get an event from a pool of reusable events. Resets the event members to their initial values. The event sent to an element when another element is dragged and dropped on the element. The event sent when the element being dragged enters a possible drop target. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An IMGUI drag updated event. An initialized event. The status of a drag-and-drop operation. The drag-and-drop handlers want to copy data. The drag-and-drop handlers want to move data. The drag-and-drop is currently unhandled. The drag-and-drop operation is being rejected by the handlers. A control that allows the user to pick a choice from a list of options. For more information, refer to. Construct an empty DropdownField. Construct a DropdownField with a Label in front. The label to display in front of the field. Construct a DropdownField. The list of choices to display in the dropdown. The default value selected from the dropdown. Callback to format the selected value. Callback to format the list items displayed in the dropdown. Construct a DropdownField. The label to display in front of the field. The list of choices to display in the dropdown. The default value selected from the dropdown. Callback to format the selected value. Callback to format the list items displayed in the dropdown. Construct a DropdownField. The list of choices to display in the dropdown. The index of the choice selected by default. Callback to format the selected value. Callback to format the list items displayed in the dropdown. Construct a DropdownField. The label to display in front of the field. The list of choices to display in the dropdown. The index of the choice selected by default. Callback to format the selected value. Callback to format the list items displayed in the dropdown. Instantiates a DropdownField using the data read from a UXML file. Defines UxmlTraits for the DropdownField. Represents a dropdown menu. Determines whether the menu allows duplicate names. Adds an item that executes an action in the dropdown menu. The name of the item. This name is displayed in the dropdown menu. The callback to execute when the user selects this item in the menu. The callback to execute to determine the status of this item. The object to store in the <b>userData<b> property of the <see cref="DropdownMenuAction" > item. Adds an item that executes an action in the dropdown menu. The name of the item. This name is displayed in the dropdown menu. The callback to execute when the user selects this item in the menu. The status of the item. Adds a separator line in the menu. The submenu path to add the separator to. Path components are delimited by forward slashes ('/'). Clears all items from the menu. Adds an item that executes an action in the dropdown menu. The index to insert the item at. The name of the item. This name is displayed in the dropdown menu. Callback to execute when the user selects this item in the menu. The callback to execute to determine the status of the item. The object to store in the <b>userData<b> property of the <see cref="DropdownMenuAction" > item. This object is accessible through the action callback. Adds an item that executes an action in the dropdown menu. The index to insert the item at. The name of the item. This name is displayed in the dropdown menu. The callback to execute when the user selects this item in the menu. The status of the item. Adds a separator line in the menu. The submenu path to add the separator to. Path components are delimited by forward slashes ('/'). The index to insert the separator at. Gets the list of menu items. The list of items in the menu. Gets the status of all items by calling their status callback and removes the excess separators. The source event. Removes the menu item at index. The index of the item to remove. Represents a menu action item. Provides information about the event that triggered the dropdown menu. The name of the item. The status of the item. The userData object stored by the constructor. Creates a status callback that always returns Status.Disabled status. Unused parameter. Always returns Status.Disabled. Creates a status callback that always returns Status.Enabled. Unused parameter. Always returns Status.Enabled Initializes a menu action with specified parameters. The path and name of the menu item. Use the path, delimited by forward slashes ('/'), to place the menu item within a submenu. The action to execute when the menu item is selected. The function called to determine if the menu item is enabled. The object to store in the <b>userData</b> property. Executes the callback associated with this item. Status of the menu item. Display the item with a checkmark. Disable the item and make it so it is not selectable by the user. Do not display the item. Do not display the item. Display the item normally. Updates the status flag of this item by calling the item status callback. Information about the event that caused the dropdown menu to display, such as the mouse position or the key pressed. Provides information about the event that caused the dropdown menu to display. The position of the mouse if the event that triggered the dropdown menu to display was a mouse event. The modifier keys that were pressed if those keys triggered the dropdown menu to display of the dropdown menu. For example, Alt, Ctrl, Shift, Windows, and Command. The mouse position expressed in the global coordinate system if the event that triggered the dropdown menu to display was a mouse event. Initialized menu event info with event provided. Source event. Represents an item in a dropdown menu. Provides a separator menu item. The submenu path to the separator. Path components are delimited by forward slashes ('/'). Initializes a separator at a path. The path for the submenu. Path components are delimited by forward slashes ('/'). Delegate that can be used as a custom filter for the dynamic atlas. The texture to filter. The filters the dynamic atlas applies when the delegate returns <c>true<c>. by default, this value is equal to <see cref="DynamicAtlasSettings.activeFilters" >. When false, the texture cannot be added to the atlas. When true the texture is added to the atlas, as long as it is not excluded by filtersToApply. Options to enable or disable filters for the dynamic atlas. Excludes textures whose color space does not match the color space of the atlas. Excludes textures that use a filter mode that the atlas does not support. This filter is disabled by default. You can enable it to prevent artifacts that might occur when the atlas does not support the texture's filter mode, and cannot sample the texture correctly. However, because excluding textures from the atlas can reduce performance, the default behavior is preferable in most cases. On GLES3 (and later) devices, the atlas supports more than one filter mode, so you should not need to enable this filter. Excludes textures that, because of their format, would lose precision, or be truncated when the system adds them to the atlas. The dynamic atlas system accepts non-HDR texture formats that have 8 bits or less per component, before compression You can add a compressed texture to a dynamic atlas. However, doing so might cause additional image loss because the system must first decompress the image in order to store it in the atlas. Decompression can yield values that are impossible to represent precisely in 8-bits per component. For example, a value of 1256 in the compressed image might decompress to 3512. The system cannot store 3512 in the atlas, so it stores the value as either 1256 or 2256. This creates potential differences between the source texture and the version stored in the atlas. These differences are noticeable in the following scenarios: 1. Blending Operations: 3512, 1256, and 2256 each produce a different result when you use them in a blending operation. 2. Rendering to high precision render targets (for example, 16 bits per component). In most cases, the performance benefits of allowing compressed textures into the atlas outweigh the inconvenience of introducing small errors. No filtering is performed. Excludes readable textures. Readable textures are textures that are readable from scripts, which means they are also writable or editable. Another way to think of this filter is as a way to exclude textures that are not read-only. Excludes textures whose size exceeds the maximum sub-texture size specified in the dynamic atlas settings. Contains the settings used by the dynamic atlas system. Defines the filters that the dynamic atlas system uses to exclude textures from the texture atlas. When a delegate is assigned, the dynamic atlas system calls it to determine whether or not a texture can be added to the atlas. Default filters for a dynamic atlas. Specifies default values used to initialize the structure. Specifies the maximum size (width/height) of the atlas texture, in pixels. This value must be a power of two, and must be greater than or equal to minAtlasSize. Specifies the maximum size (width/height) of a texture that can be added to the atlas. When activeFilters contains DynamicAtlasFilters.Size, textures larger than this size are excluded from the atlas. Otherwise, this value is not used. Specifies the minimum size (width/height) of the atlas texture, in pixels. This value must be a power of two, and must be greater than 0 and less than or equal to maxAtlasSize. Determines how intermediate values are calculated for a transition. The value of the EasingMode. Creates from a EasingMode. Represents a mathematical function that describes the rate at which a numerical value changes. Defines how the editor rendering the text by default Every font size needed is creating a new FontAsset to be as sharp as possible. Sdf is using a single FontAsset is needed to render multiple resulting fontsize Makes a dropdown for switching between enum values. For more information, refer to. USS class name of arrow indicators in elements of this type. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. Return the text value of the currently selected enum. USS class name of text elements in elements of this type. USS class name of elements of this type. Construct an EnumField. Construct an EnumField. Initial value. Also used to detect Enum type. Construct an EnumField. Initial value. Also used to detect Enum type. Initializes the EnumField with a default value, and initializes its underlying type. The typed enum value. Initializes the EnumField with a default value, and initializes its underlying type. The typed enum value. Set to true to display obsolete values as choices. Instantiates an EnumField using the data read from a UXML file. Defines UxmlTraits for the EnumField. Initialize EnumField properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. The base class for all UIElements events. The class implements IDisposable to ensure proper release of the event from the pool and of any unmanaged resources, when necessary. Returns whether this event type bubbles up in the event propagation path. The current target of the event. This is the VisualElement, in the propagation path, for which event handlers are currently being executed. Indicates whether the event is being dispatched to a visual element. An event cannot be redispatched while it being dispatched. If you need to recursively dispatch an event, it is recommended that you use a copy of the event. Retrieves the type ID for this event instance. The IMGUIEvent at the source of this event. The source can be null since not all events are generated by IMGUI. Returns true if the default actions should not be executed for this event. Indicates whether StopImmediatePropagation() was called for this event. Whether StopPropagation() was called for this event. The original mouse position of the IMGUI event, before it is transformed to the current target local coordinates. Whether the event is allocated from a pool of events. The current propagation phase for this event. The target visual element that received this event. Unlike currentTarget, this target does not change when the event is sent to other elements along the propagation path. The time when the event was created, in milliseconds. Returns whether this event is sent down the event propagation path during the TrickleDown phase. Implementation of IDisposable. Resets all event members to their initial values. Allows subclasses to perform custom logic after the event has been dispatched. The panel where the event has been dispatched. Allows subclasses to perform custom logic before the event is dispatched. The panel where the event will be dispatched. Indicates whether the default actions are prevented from being executed for this event. Registers an event class to the event type system. The type ID. Immediately stops the propagation of the event. The event isn't sent to other elements along the propagation path. This method prevents other event handlers from executing on the current target. Stops propagating this event. The event is not sent to other elements along the propagation path. This method does not prevent other event handlers from executing on the current target. If this method is called during the TrickleDown propagation phase, it will prevent default actions to be processed, such as an element getting focused as a result of a PointerDownEvent. Generic base class for events, implementing event pooling and automatic registration to the event type system. Retrieves the type ID for this event instance. Implementation of IDispose. Gets an event from the event pool. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An initialized event. Resets all event members to their initial values. Retrieves the type ID for this event instance. The type ID. Defines the structure of a callback that can be registered onto an element for an event type The event instance Defines the structure of a callback that can be registered onto an element for an event type, along with a custom user defined argument. The event instance. The user argument instance. Dispatches events to a IPanel. Gates control when the dispatcher processes events. Constructor. The dispatcher controlled by this gate. Implementation of IDisposable.Dispose. Opens the gate. If all gates are open, events in the queue are processed. Optional attribute on overrides of CallbackEventHandler.HandleEventBubbleUp and CallbackEventHandler.HandleEventTrickleDown. Use this attribute to specify all the event types used by the method override. The event dispatcher can then safely skip events not needed for this method if they are identified internally as valid candidates for performance optimizations. Use this constructor when the affected method uses only specific event types that can easily be determined at compile time. Multiple EventInterestAttribute can be used on the same method to add more type interests. The affected method is guaranteed to be invoked if the incoming event has any of the specified types in this argument. Use this constructor when the affected method treats events in a general, non type-specific manner. See EventInterestOptions for more information on the available argument values. The affected method is guaranteed to be invoked if the incoming event has any of the specified types in this argument. Options used as arguments for EventInterestAttribute when the affected method treats events in a general, non type-specific manner. Use the EventInterestOptions.AllEventTypes option when the method with an EventInterestAttribute doesn't have a specific filter for the event types it uses, or wants to receive all possible event types. For example, a class that overrides CallbackEventHandler.HandleEventBubbleUp and logs a message every time an event of any kind is received would require this option. Use the Inherit option when only the events needed by the base class are required. For example, a class that overrides the CallbackEventHandler.HandleEventBubbleUp method and checks if an enabled flag is active before calling its base.ExecuteDefaultActionAtTarget method would use this option. This event is sent by the Editor when an element in the panel should execute a command. A collection of easing curves to be used with ValueAnimations. Provides helper methods to create transition animations for VisualElement style values Triggers an animation changing this element's layout style values. Triggers an animation changing this element's transform position. Triggers an animation changing this element's transform rotation. Triggers an animation changing this element's transform scale. Triggers an animation changing this element's size style values. Starts a transition animation on this VisualElement. Start value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Start value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Start value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Start value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Start value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Start value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Start value. End value. Duration of the transition in milliseconds. The created animation object. Starts a transition animation on this VisualElement. End value. Duration of the transition in milliseconds. The created animation object. Starts a transition animation on this VisualElement. Callback that provides the initial value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Callback that provides the initial value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Callback that provides the initial value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Callback that provides the initial value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Callback that provides the initial value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Starts a transition animation on this VisualElement. Callback that provides the initial value. End value. Duration of the transition in milliseconds. Callback that applies the interpolated value. The created animation object. Triggers an animation changing this element's positioning style values. Base interface for transition animations. Duration of the transition in milliseconds. Tells if the animation is currently active. Returns this animation object into its object pool. Starts the animation using this object's values. Stops this animation. This event is sent when a pointer is pressed on a Link tag. LinkTag corresponding linkID. LinkTag corresponding text. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An initialized event. Resets the event members to their initial values. This event is sent when a pointer changes state on a link tag. LinkTag corresponding linkID. LinkTag corresponding text. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An initialized event. Resets the event members to their initial values. This event is sent when a pointer exits a link tag. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An initialized event. Resets the event members to their initial values. This event is sent when a pointer enters a link tag. LinkTag corresponding linkID. LinkTag corresponding text. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An initialized event. Resets the event members to their initial values. This event is sent when a pointer's last pressed button is released on a link tag. LinkTag corresponding linkID. LinkTag corresponding text. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An initialized event. Resets the event members to their initial values. Container object used to animate multiple style values at once. Background color to paint in the element's box. The radius of the bottom-left corner when a rounded rectangle is drawn in the element's box. The radius of the bottom-right corner when a rounded rectangle is drawn in the element's box. Space reserved for the bottom edge of the border during the layout phase. Color of the border to paint inside the element's box. Space reserved for the left edge of the border during the layout phase. Space reserved for the right edge of the border during the layout phase. The radius of the top-left corner when a rounded rectangle is drawn in the element's box. The radius of the top-right corner when a rounded rectangle is drawn in the element's box. Space reserved for the top edge of the border during the layout phase. Bottom distance from the element's box during layout. Color to use when drawing the text of an element. Specifies how much the item will grow relative to the rest of the flexible items inside the same container. Specifies how the item will shrink relative to the rest of the flexible items inside the same container. Fixed height of an element for the layout. Left distance from the element's box during layout. Space reserved for the bottom edge of the margin during the layout phase. Space reserved for the left edge of the margin during the layout phase. Space reserved for the right edge of the margin during the layout phase. Space reserved for the top edge of the margin during the layout phase. Specifies the transparency of an element. Space reserved for the bottom edge of the padding during the layout phase. Space reserved for the left edge of the padding during the layout phase. Space reserved for the right edge of the padding during the layout phase. Space reserved for the top edge of the padding during the layout phase. Right distance from the element's box during layout. Top distance from the element's box during layout. Tinting color for the element's backgroundImage. Fixed width of an element for the layout. Implementation object for transition animations. Returns true if this animation object will be automatically returned to the instance pool after the animation has completed. Duration of the animation in milliseconds. Smoothing function related to this animation. Default value is Easing.OutQuad. The animation start value. Callback invoked when the from field has not been set, in order to retrieve the starting state of this animation. Value interpolation method. Tells if the animation is currently active. Callback invoked when this animation has completed. The animation end value. Callback invoked after every value interpolation. Creates a new ValueAnimation object or returns an available one from it's instance pool. Constructor. Sets the easing function. Will not return the object to the instance pool when the animation has completed. Sets a callback invoked when this animation has completed. Returns this animation object into its object pool. Starts the animation using this object's values. Stops this animation. Provides dragging on a visual element to change a value field. Is dragging. Start value before drag. FieldMouseDragger's constructor. The field. The fill rule to use when filling shapes with Painter2D.Fill. The "non-zero" winding rule. The "odd-even" winding rule. Defines the main-axis of the flex layout. Top to Bottom. Bottom to Top. Left to Right. Right to Left. Makes a text field for entering a float. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Applies the values of a 3D delta and a speed from an input device. A vector used to compute the value change. A multiplier for the value change. The start value. Constructor. Constructor. Maximum number of characters the field can take. Constructor. Maximum number of characters the field can take. Converts a string to a float. The string to convert. The float parsed from the string. Instantiates a FloatField using the data read from a UXML file. Defines UxmlTraits for the FloatField. Converts the given float to a string. The float to be converted to string. The float as string. Base class for objects that can get the focus. Return true if the element can be focused. Whether the element should delegate the focus to its children. True if the element can be focused. Return the focus controller for this element. An integer used to sort focusables in the focus ring. Must be greater than or equal to zero. Tell the element to release the focus. Attempt to give the focus to this element. Base class for defining in which direction the focus moves in a focus ring. Last value for the direction defined by this class. The null direction. This is usually used when the focus stays on the same element. Focus came from an unspecified direction, for example after a mouse down. Class in charge of managing the focus inside a Panel. The currently focused VisualElement. Constructor. Instructs the FocusController to ignore the given event. This will prevent the event from changing the current focused VisualElement or triggering focus events. The event to be ignored. Event sent immediately after an element has gained focus. This event trickles down and does not bubbles up. Base class for focus related events. Direction of the focus change. The focus controller that emitted the event. For FocusOut and Blur events, contains the element that gains the focus. For FocusIn and Focus events, contains the element that loses the focus. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The event target. The related target. The direction of the focus change. The object that manages the focus. An initialized event. Resets the event members to their initial values. Event sent immediately before an element gains focus. This event trickles down and bubbles up. Constructor. Resets the event members to their initial values. Event sent immediately before an element loses focus. This event trickles down and bubbles up. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. A Foldout control is a collapsible section of a user interface. When toggled, it expands or collapses, which hides or reveals the elements it contains. The USS class name for the Label element in a Foldout. This element contains the elements that are shown or hidden when you toggle the Foldout. The USS class name for the content element in a Foldout. The USS class name for the Label element in a Foldout. The label text for the toggle. The USS class name for the Label element in a Foldout. Whether to toggle the foldout state when the user clicks the label. The USS class name of Toggle sub-elements in Foldout elements. The USS class name for Foldout elements. This is the state of the Foldout's toggle. It is true if the Foldout is open and its contents are visible, and false if the Foldout is closed, and its contents are hidden. Constructs a Foldout element. Sets the value of the Foldout's Toggle sub-element, but does not notify the rest of the hierarchy of the change. The new value of the foldout Instantiates a Foldout using the data from a UXML file. Defines UxmlTraits for the Foldout. Initializes Foldout properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Describes a VisualElement font. Font to use to display text. You cannot set this and FontDefinition.fontAsset at the same time. SDF font to use to display text. You cannot set this and FontDefinition.font at the same time. Create a FontDefinition from Font. The font to use to display text. A new FontDefinition object. Create a FontDefinition from FontAsset. The SDF font to use to display text. A new FontDefinition object. GenericDropdownMenu allows you to display contextual menus with default textual options or any VisualElement. USS class name of separators in elements of this type. USS class name of inner containers in elements of this type. USS class name of outer containers in elements of this type. Returns the content container for the GenericDropdownMenu. Allows users to create their own dropdown menu if they don't want to use the default implementation. USS class name that's added when the GenericDropdownMenu fits the width of its content. USS class name of labels in elements of this type. USS class name of labels in elements of this type. USS class name of labels in elements of this type. USS class name of separators in elements of this type. USS class name of elements of this type. Adds a disabled item to this menu using a default VisualElement. The text to display to the user. Indicates whether a checkmark next to the item is displayed. Adds an item to this menu using a default VisualElement. The text to display to the user. Indicates whether a checkmark next to the item is displayed. The callback to invoke when the item is selected by the user. Adds an item to this menu using a default VisualElement. The text to display to the user. Indicates whether a checkmark next to the item is displayed. The callback to invoke when the item is selected by the user. The object to pass to the callback as a parameter. Adds a visual separator after the previously added items in this menu. Not used. Initializes and returns an instance of GenericDropdownMenu. Displays the menu at the specified position. The position in the coordinate space of the panel. The element determines which root to use as the menu's parent. If true, the menu's width matches the width of the position; otherwise, the menu expands to the container's full width. Displays the menu at the specified position. The position in the coordinate space of the panel. The element determines which root to use as the menu's parent. If true, the menu's width matches the width of the position; otherwise, the menu expands to the container's full width. If true and the menu is anchored, the menu's width matches its content's width; otherwise, the menu's width matches the width of the position. If the menu is unanchored, this parameter is ignored. This event is sent after layout calculations, when the position or the dimension of an element changes. Gets the elements's new dimensions. Gets the element's old dimensions. Constructor. Gets an event from the event pool, and initializes it with the specified values. Use this method instead of instancing new events. Use Dispose() to release events back to the event pool. The old dimensions of the element. The new dimensions of the element. An initialized event. Resets the event values to their initial values. This is an enclosing container for a group of IGroupBoxOption. All group options within this container will interact together to allow a single selection, using the DefaultGroupManager. Default options are RadioButton, but users can provide other implementations. If no IGroupBox is found in the hierarchy, the default container will be the panel. USS class name for Labels in GroupBox elements. The title text of the box. USS class name for GroupBox elements. Creates a GroupBox with no label. Creates a GroupBox with a title. The title text. Instantiates a GroupBox using data from a UXML file. Defines UxmlTraits for the GroupBox. Initializes GroupBox properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Information about a drag-and-drop operation in progress. See BaseVerticalCollectionView.dragAndDropUpdate and BaseVerticalCollectionView.handleDrop. The child index under the parentId that the drag-and-drop operation targets. Used only for trees. Data stored for the drag-and-drop operation. The type of drop position. The index at which the drop operation wants to happen. The new parent targeted by the drag-and-drop operation. Used only for trees. The world position of the pointer. The target of the drop. There is only a target when hovering over an item. DropPosition.OverItem Makes a field for editing an Hash128. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Initializes and returns an instance of Hash128Field. Initializes and returns an instance of Hash128Field. Maximum number of characters for the field. Initializes and returns an instance of Hash128Field. The text to use as a label. Maximum number of characters for the field. Instantiates a Hash128Field using the data read from a UXML file. Defines UxmlTraits for the Hash128Field. Makes a help box with a message to the user. For more information, refer to. The USS class name for the HelpBoxMessageType.Error state in Elements of this type. The USS class name for the HelpBoxMessageType.Info state in Elements of this type. The USS class name for images in Elements of this type. The USS class name for the HelpBoxMessageType.Warning state in Elements of this type. The USS class name for labels in Elements of this type. The type of message. The message text. The USS class name for Elements of this type. Creates a new HelpBox. Creates a new HelpBox. The message text. The type of message. Instantiates a HelpBox with data from a UXML file. Defines UxmlTraits for the HelpBox. Initializes HelpBox properties with values from an attribute bag. The Element to initialize. The attribute bag. The creation context; unused. User message types. Error message. Info message. Neutral message. Warning message. Base interface for UXML factories. While it is not strictly required, concrete factories should derive from the generic class UxmlFactory_2 or UxmlObjectFactory_2. Must return true if the UXML element attributes are not restricted to the values enumerated by uxmlAttributesDescription. The type of element for which this element type can substitute for. The UXML namespace for the type returned by substituteForTypeName. The fully qualified XML name for the type returned by substituteForTypeName. Describes the UXML attributes expected by the element. The attributes enumerated here will appear in the UXML schema. Describes the types of element that can appear as children of this element in a UXML file. The name of the UXML element read by the factory. The namespace of the UXML element read by the factory. The fully qualified name of the UXML element read by the factory. The type of the UXML element read by the factory. Returns true if the factory accepts the content of the attribute bag. The attribute bag. The creation context. True if the factory accepts the content of the attribute bag. False otherwise. Interface for all bindable fields. Binding object that will be updated. Path of the target property to be bound. Base interface for Binding objects. Called at regular intervals to synchronize bound properties to their IBindable counterparts. Called before the Update() method. Disconnects the field from its bound property. Called at regular intervals to synchronize bound properties to their IBindable counterparts. Extensions methods to provide additional IBindable functionality. Checks if a IBindable is bound to a property. This Bindable object. True if this IBindable is bound to a property. Base interface for ChangeEvent. Interface for Command events. Name of the command. This interface exposes methods to read custom style properties applied from USS files to visual elements. Gets the value associated with the specified CustomStyleProperty_1. True if the property is found, false if not. Gets the value associated with the specified CustomStyleProperty_1. True if the property is found, false if not. Gets the value associated with the specified CustomStyleProperty_1. True if the property is found, false if not. Gets the value associated with the specified CustomStyleProperty_1. True if the property is found, false if not. Gets the value associated with the specified CustomStyleProperty_1. True if the property is found, false if not. Gets the value associated with the specified CustomStyleProperty_1. True if the property is found, false if not. Gets the value associated with the specified CustomStyleProperty_1. True if the property is found, false if not. Gets the value associated with the specified CustomStyleProperty_1. True if the property is found, false if not. Gets the value associated with the specified CustomStyleProperty_1. True if the property is found, false if not. Binding types deriving from Binding can implement this interface to gain an additional layer of data source and data source path. These will be used by the binding system to compute the final BindingContext.dataSource and BindingContext.dataSourcePath that will be passed to the BindingContext during the binding update. Data source object that is local to the binding object. Data source path that is local to the binding object. Defines a component as a data source view. Returns the hash code of the view, which can be used to notify the data binding system to refresh. The hash code of the view. Implement this to receive callbacks for visual element changes. This interface is exclusively available in development builds and the Editor, as it serves as a debug feature that complements the profiling of an application. Receives notifications for every change that occurs on the panel's visual elements. This method is exclusively available in development builds and the Editor, as it serves as a debug feature that complements the profiling of an application. The element that changed. A string that contains the comma-separated value of what has changed. Interface for drag and drop events. Interface for class capable of handling events. Handles an event according to its propagation phase and current target, by executing the element's default action or callbacks associated with the event. The event to handle. Returns true if event handlers for the event propagation BubbleUp phase, have been attached to this object. True if the object has event handlers for the BubbleUp phase. Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object. True if the object already has event handlers for the TrickleDown phase. Sends an event to the event handler. The event to send. Give access to UIElement experimental features. Returns the animation experimental interface. Interface for focus events. Direction of the focus change. Related target. See implementation for specific meaning. Interface for classes implementing focus rings. Get the direction of the focus change for the given event. For example, when the Tab key is pressed, focus should be given to the element to the right. Get the next element in the given direction. This interface describes the data used by keyboard events. Gets a boolean value that indicates whether the platform-specific action key is pressed. True means the action key is pressed. False means it isn't. Gets a boolean value that indicates whether the Alt key is pressed. True means the Alt key is pressed. False means it isn't. Gets the character entered. Gets a boolean value that indicates whether the WindowsCmd key is pressed. True means the WindowsCmd key is pressed. False means it isn't. Gets a boolean value that indicates whether the Ctrl key is pressed. True means the Ctrl key is pressed. False means it isn't. The key code. Gets flags that indicate whether modifier keys (Alt, Ctrl, Shift, Windows/Cmd) are pressed. Gets a boolean value that indicates whether the Shift key is pressed. True means the Shift key is pressed. False means it isn't. A VisualElement representing a source texture. The texture to display in this image. If you assign a Texture or Texture2D, the Image element will resize and show the assigned texture. ScaleMode used to display the Image. The source rectangle inside the texture relative to the top left corner. The sprite to display in this image. Tinting color for this Image. USS class name of elements of this type. The base texture coordinates of the Image relative to the bottom left corner. The VectorImage to display in this image. Constructor. Instantiates an Image using the data read from a UXML file. Defines UxmlTraits for the Image. Returns an empty enumerable, as images generally do not have children. Interface for Manipulator objects. VisualElement being manipulated. Element that draws IMGUI content. For more information, refer to. ContextType of this IMGUIContainer. Currently only supports ContextType.Editor. When this property is set to true, onGUIHandler is not called when the Element is outside the viewport. The function that's called to render and handle IMGUI events. USS class name of elements of this type. Constructor. Constructor. The function assigned to <see cref="onGUIHandler" />. Releases the native memory that this IMGUIContainer instance uses. Marks layout as dirty to trigger a redraw. Instantiates an IMGUIContainer using the data read from a UXML file. Defines UxmlTraits for the IMGUIContainer. Returns an empty enumerable, as IMGUIContainer cannot have VisualElement children. Constructor. Class used to send a IMGUI event that has no equivalent UIElements event. Constructor. Use GetPooled() to get an event from a pool of reusable events. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The IMGUI event used to initialize the event. An initialized event. Resets the event members to their initial values. An interface that allows value fields to visually represent a mixed value. Indicates whether to enable the mixed value state on the value field. VisualElement that can implement custom immediate mode rendering. When this property is set to true, the Element does not repaint itself when it is outside the viewport. Constructor. Invoked during the repaint phase. Interface for mouse capture events. Interface for mouse events. Returns true if the platform-specific action key is pressed. This key is Cmd on macOS, and Ctrl on all other platforms. Return true if the Alt key is pressed. A value that indicates which mouse button was pressed or released (if any) to cause this event: 0 is the left button, 1 is the right button, 2 is the middle button. A negative value indicates that no mouse button changed state during this event. The number of times the button is pressed. Return true if the Windows/Command key is pressed. Return true if the Ctrl key is pressed. The mouse position in the current target coordinate system. Flag set holding the pressed modifier keys (Alt, Ctrl, Shift, Windows/Command). Mouse position difference between the last mouse event and this one. The mouse position in the panel coordinate system. A bitmask that describes the currently pressed buttons. Return true if the Shift key is pressed. Interface for all navigation events. Gets a boolean value that indicates whether the platform-specific action key is pressed. True means the action key is pressed. False means it isn't. Gets a boolean value that indicates whether the Alt key is pressed. True means the Alt key is pressed. False means it isn't. Gets a boolean value that indicates whether the WindowsCmd key is pressed. True means the WindowsCmd key is pressed. False means it isn't. Gets a boolean value that indicates whether the Ctrl key is pressed. True means the Ctrl key is pressed. False means it isn't. Gets flags that indicate whether modifier keys (Alt, Ctrl, Shift, Windows/Cmd) are pressed. Gets a boolean value that indicates whether the Shift key is pressed. True means the Shift key is pressed. False means it isn't. Defines a component that notifies when a property has changed. Called when a property has changed. Interface for controls that hold a value and can notify when it is changed by user input. The value the control holds. Sets the value and, even if different, doesn't notify registers callbacks with a ChangeEvent_1 The new value to be set. INotifyValueChangedExtensions is a set of extension methods useful for objects implementing INotifyValueChanged_1. Registers this callback to receive ChangeEvent_1 when the value is changed. Unregisters this callback from receiving ChangeEvent_1 when the value is changed. Sends an event when text from a TextField changes. The new text. The text before the change occured. Constructor. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The text before the change occured. The new text. An initialized event. Resets the event members to their initial values. Makes a text field for entering an integer. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Applies the values of a 3D delta and a speed from an input device. A vector used to compute the value change. A multiplier for the value change. The start value. Constructor. Constructor. Maximum number of characters the field can take. Constructor. Maximum number of characters the field can take. Converts a string to an integer. The string to convert. The integer parsed from the string. Instantiates an IntegerField using the data read from a UXML file. Defines UxmlTraits for the IntegerField. Converts the given integer to a string. The integer to be converted to string. The integer as string. Interface for classes implementing UI panels. Describes in which context a VisualElement hierarchy is being ran. The Contextual menu manager for the panel. This Panel EventDispatcher. Return the focus controller for this panel. Checks whether any element within the panel has had any changes to its state since the panel was last rendered. Gives the current scaled pixels per point value of the panel. Root of the VisualElement hierarchy. Returns the top element at this position. Will not return elements with pickingMode set to PickingMode.Ignore. World coordinates. Top VisualElement at the position. Null if none was found. Returns all elements at this position. Will not return elements with pickingMode set to PickingMode.Ignore. World coordinates. All Visualelements overlapping this position. Top VisualElement at the position. Null if none was found. Interface for panel change events. Interface for pointer capture events and mouse capture events. This interface describes properties available to pointer events. Gets a boolean value that indicates whether the platform-specific action key is pressed. True means the action key is pressed. False means it isn't. Gets the angle of the stylus relative to the surface, in radians Gets a boolean value that indicates whether the Alt key is pressed. True means the Alt key is pressed. False means it isn't. Gets the angle of the stylus relative to the x-axis, in radians. Gets a value that indicates which mouse button was pressed or released (if any) to cause this event: 0 is the left button, 1 is the right button, 2 is the middle button. A negative value indicates that no mouse button changed state during this event. Gets the number of times the button was pressed. Gets a boolean value that indicates whether the WindowsCmd key is pressed. True means the WindowsCmd key is pressed. False means it isn't. Gets a boolean value that indicates whether the Ctrl key is pressed. True means the Ctrl key is pressed. False means it isn't. Gets the difference between the pointer's position during the previous mouse event and its position during the current mouse event. Gets the amount of time that has elapsed since the last recorded change in pointer values, in seconds. Gets a boolean value that indicates whether the pointer is a primary pointer. True means the pointer is a primary pointer. False means it isn't. Gets the pointer position in the current target's coordinate system. Gets flags that indicate whether modifier keys (Alt, Ctrl, Shift, Windows/Cmd) are pressed. Specifies the state of the pen. For example, whether the pen is in contact with the screen or tablet, whether the pen is inverted, and whether buttons are pressed. On macOS, penStatus will not reflect changes to button mappings. Gets the identifier of the pointer that sends the event. Gets the type of pointer that created the event. Gets the pointer position in the Screen or World coordinate system. Gets a bitmask that describes the buttons that are currently pressed. Gets the amount of pressure currently applied by a touch. Gets an estimate of the radius of a touch. Gets the accuracy of the touch radius. Gets a boolean value that indicates whether the Shift key is pressed. True means the Shift key is pressed. False means it isn't. Gets the pressure applied to an additional pressure-sensitive control on the stylus. Specifies the angle of the pen relative to the X and Y axis respectively, in radians. Gets the rotation of the stylus around its axis, in radians. Style values after layout pass. Alignment of the whole area of children on the cross axis if they span over multiple lines in this container. Alignment of children on the cross axis of this container. Similar to align-items, but only for this specific element. Background color to paint in the element's box. Background image to paint in the element's box. Background image x position value. Background image y position value. Background image repeat value. Background image size value. Transitions are fully supported only when using size in pixels or percentages, such as pixel-to-pixel or percentage-to-percentage transitions. Color of the element's bottom border. The radius of the bottom-left corner when a rounded rectangle is drawn in the element's box. The radius of the bottom-right corner when a rounded rectangle is drawn in the element's box. Space reserved for the bottom edge of the border during the layout phase. Color of the element's left border. Space reserved for the left edge of the border during the layout phase. Color of the element's right border. Space reserved for the right edge of the border during the layout phase. Color of the element's top border. The radius of the top-left corner when a rounded rectangle is drawn in the element's box. The radius of the top-right corner when a rounded rectangle is drawn in the element's box. Space reserved for the top edge of the border during the layout phase. Bottom distance from the element's box during layout. Color to use when drawing the text of an element. Defines how an element is displayed in the layout. Initial main size of a flex item, on the main flex axis. The final layout might be smaller or larger, according to the flex shrinking and growing determined by the other flex properties. Direction of the main axis to layout children in a container. Specifies how the item will grow relative to the rest of the flexible items inside the same container. Specifies how the item will shrink relative to the rest of the flexible items inside the same container. Placement of children over multiple lines if not enough space is available in this container. Font size to draw the element's text. Fixed height of an element for the layout. Justification of children on the main axis of this container. Left distance from the element's box during layout. Increases or decreases the space between characters. Space reserved for the bottom edge of the margin during the layout phase. Space reserved for the left edge of the margin during the layout phase. Space reserved for the right edge of the margin during the layout phase. Space reserved for the top edge of the margin during the layout phase. Maximum height for an element, when it is flexible or measures its own size. Maximum width for an element, when it is flexible or measures its own size. Minimum height for an element, when it is flexible or measures its own size. Minimum width for an element, when it is flexible or measures its own size. Specifies the transparency of an element and of its children. Space reserved for the bottom edge of the padding during the layout phase. Space reserved for the left edge of the padding during the layout phase. Space reserved for the right edge of the padding during the layout phase. Space reserved for the top edge of the padding during the layout phase. Element's positioning in its parent container. Right distance from the element's box during layout. A rotation transformation. A scaling transformation. The element's text overflow mode. Top distance from the element's box during layout. The transformation origin is the point around which a transformation is applied. Duration to wait before starting a property's transition effect when its value changes. Time a transition animation should take to complete. Properties to which a transition effect should be applied. Determines how intermediate values are calculated for properties modified by a transition effect. A translate transformation. Tinting color for the element's backgroundImage. Background image scaling in the element's box. TextElement editor rendering mode. Font to draw the element's text, defined as a Font object. Font to draw the element's text, defined as a FontDefinition structure. It takes precedence over -unity-font. Font style and weight (normal, bold, italic) to draw the element's text. Increases or decreases the space between paragraphs. Size of the 9-slice's bottom edge when painting an element's background image. Size of the 9-slice's left edge when painting an element's background image. Size of the 9-slice's right edge when painting an element's background image. Scale applied to an element's slices. Size of the 9-slice's top edge when painting an element's background image. Specifies the type of sclicing. Horizontal and vertical text alignment in the element's box. Switches between Unity's standard and advanced text generator Outline color of the text. Outline width of the text. The element's text overflow position. Specifies whether or not an element is visible. Word wrap over multiple lines if not enough space is available to draw the text of an element. Fixed width of an element for the layout, specified in pixels. Increases or decreases the space between words. Interface for classes implementing UI runtime panels. The UnityEngine.UIElements.PanelSettings asset associated with this panel. A GameObject from the Scene that can be used by UnityEngine.EventSystems.EventSystem to get and set focus to this panel. If null, panel focus will be handled independently of Event System selection. This interface provides access to a VisualElement inline style data. Alignment of the whole area of children on the cross axis if they span over multiple lines in this container. Alignment of children on the cross axis of this container. Similar to align-items, but only for this specific element. Background color to paint in the element's box. Background image to paint in the element's box. Background image x position value. Background image y position value. Background image repeat value. Background image size value. Transitions are fully supported only when using size in pixels or percentages, such as pixel-to-pixel or percentage-to-percentage transitions. Color of the element's bottom border. The radius of the bottom-left corner when a rounded rectangle is drawn in the element's box. The radius of the bottom-right corner when a rounded rectangle is drawn in the element's box. Space reserved for the bottom edge of the border during the layout phase. Color of the element's left border. Space reserved for the left edge of the border during the layout phase. Color of the element's right border. Space reserved for the right edge of the border during the layout phase. Color of the element's top border. The radius of the top-left corner when a rounded rectangle is drawn in the element's box. The radius of the top-right corner when a rounded rectangle is drawn in the element's box. Space reserved for the top edge of the border during the layout phase. Bottom distance from the element's box during layout. Color to use when drawing the text of an element. Mouse cursor to display when the mouse pointer is over an element. Defines how an element is displayed in the layout. Initial main size of a flex item, on the main flex axis. The final layout might be smaller or larger, according to the flex shrinking and growing determined by the other flex properties. Direction of the main axis to layout children in a container. Specifies how the item will grow relative to the rest of the flexible items inside the same container. Specifies how the item will shrink relative to the rest of the flexible items inside the same container. Placement of children over multiple lines if not enough space is available in this container. Font size to draw the element's text. Fixed height of an element for the layout. Justification of children on the main axis of this container. Left distance from the element's box during layout. Increases or decreases the space between characters. Space reserved for the bottom edge of the margin during the layout phase. Space reserved for the left edge of the margin during the layout phase. Space reserved for the right edge of the margin during the layout phase. Space reserved for the top edge of the margin during the layout phase. Maximum height for an element, when it is flexible or measures its own size. Maximum width for an element, when it is flexible or measures its own size. Minimum height for an element, when it is flexible or measures its own size. Minimum width for an element, when it is flexible or measures its own size. Specifies the transparency of an element and of its children. How a container behaves if its content overflows its own box. Space reserved for the bottom edge of the padding during the layout phase. Space reserved for the left edge of the padding during the layout phase. Space reserved for the right edge of the padding during the layout phase. Space reserved for the top edge of the padding during the layout phase. Element's positioning in its parent container. Right distance from the element's box during layout. A rotation transformation. A scaling transformation. The element's text overflow mode. Drop shadow of the text. Top distance from the element's box during layout. The transformation origin is the point around which a transformation is applied. Duration to wait before starting a property's transition effect when its value changes. Time a transition animation should take to complete. Properties to which a transition effect should be applied. Determines how intermediate values are calculated for properties modified by a transition effect. A translate transformation. Tinting color for the element's backgroundImage. Background image scaling in the element's box. TextElement editor rendering mode. Font to draw the element's text, defined as a Font object. Font to draw the element's text, defined as a FontDefinition structure. It takes precedence over -unity-font. Font style and weight (normal, bold, italic) to draw the element's text. Specifies which box the element content is clipped against. Increases or decreases the space between paragraphs. Size of the 9-slice's bottom edge when painting an element's background image. Size of the 9-slice's left edge when painting an element's background image. Size of the 9-slice's right edge when painting an element's background image. Scale applied to an element's slices. Size of the 9-slice's top edge when painting an element's background image. Specifies the type of sclicing. Horizontal and vertical text alignment in the element's box. Switches between Unity's standard and advanced text generator Outline color of the text. Outline width of the text. The element's text overflow position. Specifies whether or not an element is visible. Word wrap over multiple lines if not enough space is available to draw the text of an element. Fixed width of an element for the layout. Increases or decreases the space between words. Base interface for the style properties. The style keyword. The style value. Interface to access a TextElement edition capabilities This interface is not meant to be implemented explicitly as its declaration might change in the future. Determines if the soft keyboard auto correction is turned on or off. Hides or shows the mobile input field. Hides the placeholder on focus. If set to true, the value property isn't updated until either the user presses Enter or the element loses focus. Returns true if the field is used to edit a password. Returns true if the element is read only. The type of mobile keyboard that will be used. The character used for masking when in password mode. Maximum number of characters for that element A short hint to help users understand what to enter in the field. The TouchScreenKeyboard being used to edit the Input Field. Give access to TextElement experimental features. Setting this property will override the displayed text while preserving the original text value. Interface to access a TextElement selection and cursor information This interface is not meant to be implemented explicitly as its declaration might change in the future. Color of the cursor. This is the cursor index in the text presented. The position of the text cursor inside the element. Controls whether double-clicking selects the word under the mouse pointer. Returns true if the field is selectable. Controls whether the element's content is selected upon receiving focus. Controls whether the element's content is selected when you mouse up for the first time. This is the selection index in the text presented. Background color of selected text. Controls whether triple-clicking selects the entire line under the mouse pointer. Return true is the TextElement has a selection. Selects all the text contained in the field. Remove selection Select text between cursorIndex and selectIndex. This interface provides access to a VisualElement transform data. Transformation matrix calculated from the position, rotation and scale of the transform (Read Only). The position of the VisualElement transform. The rotation of the VisualElement transform stored as a Quaternion. The scale of the VisualElement transform. Interface for all transition events. The number of seconds the transition has been running, excluding delay phase time. The names of the properties associated with the transition. This type allows UXML attribute value retrieval during the VisualElement instantiation. An instance will be provided to the factory method - see UXMLFactoryAttribute. Get the value of an attribute as a string. Attribute name. The attribute value or null if not found. True if the attribute was found, false otherwise. Interface for UXML factories. While it is not strictly required, concrete factories should derive from the generic class UxmlFactory_2. Instantiate and initialize an object of type T0. A bag of name-value pairs, one for each attribute of the UXML element. This can be used to initialize the properties of the created object. When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. The created object. Base interface for UIElements text value fields. The value of the field. Applies the values of a 3D delta and a speed from an input device. A vector used to compute the value change. A multiplier for the value change. The start value. Indicate when the mouse dragging is starting. Indicate when the mouse dragging is ending. Represents a scheduled task created with a VisualElement's schedule interface. Returns the VisualElement this object is associated with. Will be true when this item is scheduled. Note that an item's callback will only be executed when it's VisualElement is attached to a panel. Repeats this action after a specified time. Minimum amount of time in milliseconds between each action execution. This ScheduledItem. Cancels any previously scheduled execution of this item and re-schedules the item. Minimum time in milliseconds before this item will be executed. After specified duration, the item will be automatically unscheduled. The total duration in milliseconds where this item will be active. This ScheduledItem. Removes this item from its VisualElement's scheduler. If not already active, will schedule this item on its VisualElement's scheduler. Adds a delay to the first invokation. The minimum number of milliseconds after activation where this item's action will be executed. This ScheduledItem. Item will be unscheduled automatically when specified condition is met. When condition returns true, the item will be unscheduled. This ScheduledItem. A scheduler provides the functionality to queue actions to run at a specific time or duration. Schedule this action to be executed later. The action to be executed. Reference to the scheduled action. Schedule this action to be executed later. The action to be executed. Reference to the scheduled action. Defines the alignment along the main axis, how is extra space distributed. Items are centered along the line. Items are packed toward the end line. Items are packed toward the start line. Default Value. Items are evenly distributed in the line with equal space around them. Space on the edge is half of the space between objects. Items are evenly distributed in the line; first item is on the start line, last item on the end line. Items are evenly distributed in the line with equal space around them. This is the base class for keyboard events. Gets a boolean value that indicates whether the platform-specific action key is pressed. True means the action key is pressed. False means it isn't. Gets a boolean value that indicates whether the Alt key is pressed. True means the Alt key is pressed. False means it isn't. Gets the character entered. Gets a boolean value that indicates whether the WindowsCmd key is pressed. True means the WindowsCmd key is pressed. False means it isn't. Gets a boolean value that indicates whether the Ctrl key is pressed. True means the Ctrl key is pressed. False means it isn't. The key code. Gets flags that indicate whether modifier keys (Alt, Ctrl, Shift, Windows/Cmd) are pressed. Gets a boolean value that indicates whether the Shift key is pressed. True means the Shift key is pressed. False means it isn't. Gets a keyboard event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The character for this event. The key code for this event. Event modifier keys that are active for this event. An initialized event. Gets a keyboard event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. A keyboard IMGUI event. An initialized event. Resets the event members to their initial values. Provides a default implementation for translating input device specific events to higher level navigation operations as commonly possible with a keyboard. Initializes and returns an instance of KeyboardNavigationManipulator, configured to invoke the specified callback. This action is invoked when specific low level events are dispatched to the target <see cref="VisualElement" >, with a specific value of <see cref="KeyboardNavigationOperation" > and a reference to the original low level event. Represents an operation that the user is trying to accomplish through a specific input mechanism. Selects the first element. Cancels the current UI interaction. Selects the last element. Moves to the left. Moves to the right. Moves down to the next item. Default value. Indicates an uninitialized enum value. Moves the selection down one page (in a list that has a scrollable area). Moves the selection up one page (in a list that has a scrollable area). Moves up to the previous item. Selects all UI selectable elements or text. Submits or concludes the current UI interaction. This event is sent when a key is pressed. This event is sent when a pressed key is released. Provides an Element displaying text. For more information, refer to. USS class name of elements of this type. Constructs a Label with no initial text. Constructs a Label displaying the specified text. The initial text to be displayed in the Label. Instantiates a Label using the data read from a UXML file. Defines UxmlTraits for the Label. Indicates the directionality of the element's text. Inherits the directionality from the nearest ancestor with a specified directionality. Left to right language direction. Right to left language direction. Represents a distance value. The unit of the value property. The length value. Creates an Auto Length Length. Auto length. Creates from a float and an optional LengthUnit. Creates from a float and an optional LengthUnit. Check if Length is Auto. true if Length is Auto, false otherwise Check if Length is None. true if Length is None, false otherwise Creates a None Length Length. None length. Creates a percentage Length from a float. The created length. Describes how to interpret a Length value. Interprets length as a percentage, with 100 representing 100%. The value is not constrained and can range from negative numbers to values greater than 100. Interprets length as pixel. Controls the visibility of the UxmlElementAttribute|UxmlElement in the UI Builder Library projects tab. The element's visibility is not specified and is determined by the UI Builder. Unity hides elements with namespaces that start with "Unity", "UnityEngine", and "UnityEditor". The element is not visible in the UI Builder Library. The element is visible in the UI Builder Library. Cap types for the beginning and end of paths (see Painter2D.lineCap). Terminates the path with no tip. Terminates the path with a round tip. Join types connecting two sub-paths (see Painter2D.lineJoin). Joins the sub-paths with a beveled corner. Joins the sub-paths with a sharp corner. The join converts to a beveled join when the Painter2D.miterLimit ratio is reached. Joins the sub-paths with a round corner. A ListView is a vertically scrollable area that links to, and displays, a list of items. Callback for binding a data item to the visual element. Callback invoked when a VisualElement created via makeItem is no longer needed and will be destroyed. A UXML template that constructs each recycled and rebound element within the list. This template is designed to replace the makeItem definition. Callback for constructing the VisualElement that is the template for each recycled and re-bound element in the list. Callback for unbinding a data item from the VisualElement. Creates a ListView with all default properties. The ListView.itemsSource must all be set for the ListView to function properly. Constructs a ListView, with all important properties provided. The list of items to use as a data source. The height of each item, in pixels. The factory method to call to create a display item. The method should return a VisualElement that can be bound to a data item. The method to call to bind a data item to a display item. The method receives as parameters the display item to bind, and the index of the data item to bind it to. Instantiates a ListView using data from a UXML file. Defines UxmlTraits for the ListView. List view controller. View controllers of this type are meant to take care of data virtualized by any ListView inheritor. View for this controller, cast as a ListView. Options to change the drag-and-drop mode for items in the ListView. ListView will add drag handles before every item, that can be used to drag a single item with animated visual feedback. ListView will display the standard blue line dragger on reorder. Makes a text field for entering long integers. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Applies the values of a 3D delta and a speed from an input device. A vector used to compute the value change. A multiplier for the value change. The start value. Constructor. Constructor. Maximum number of characters the field can take. Constructor. Maximum number of characters the field can take. Converts a string to a long integer. The string to convert. The long integer parsed from the string. Instantiates a LongField using the data read from a UXML file. Defines UxmlTraits for the LongField. Converts the given long integer to a string. The long integer to be converted to string. The long integer as string. Base class for all Manipulator implementations. For more information, refer to. VisualElement being manipulated. Called to register event callbacks on the target element. Called to unregister event callbacks from the target element. Defines conditions for manipulators to respond to specific events. The button that triggers the manipulation. Number of mouse clicks required to activate the manipulator. Any modifier keys (ie. ctrl, alt, ...) required to trigger the manipulator. Checks whether the current mouse event satisfies the activation requirements. The mouse event. True if the event matches the requirements. False otherwise. Checks whether the current mouse event satisfies the activation requirements. The mouse event. True if the event matches the requirements. False otherwise. Provides methods for generating a visual element's visual content during the VisualElement.generateVisualContent callback. The vector painter object used to issue drawing commands. The element for which VisualElement.generateVisualContent was invoked. Instructs the renderer to wait for the completion of the provided JobHandle before beginning processing the meshes. JobHandle to wait for. Allocates and draws the specified number of vertices and indices required to express geometry for drawing the content of a VisualElement. The number of vertices to allocate. The maximum is 65535 (or UInt16.MaxValue). The number of triangle list indices to allocate. Each 3 indices represent one triangle, so this value should be multiples of 3. An optional texture to be applied on the triangles allocated. Pass null to rely on vertex colors only. Allocates the specified number of vertices and indices from a temporary allocator. The number of vertices to allocate. The maximum is 65535 (or UInt16.MaxValue). The number of triangle list indices to allocate. Each 3 indices represent one triangle, so this value should be multiples of 3. The returned vertices. The returned indices. Records a draw command with the provided triangle-list indexed mesh. The vertices to be drawn. All referenced vertices must be initialized. The triangle list indices. Must be a multiple of 3. All indices must be initialized. An optional texture to be applied on the triangles. Pass null to rely on vertex colors only. Draw a string of text. The text to display. The start position where the text will be displayed. The font size to use. The text color. The font asset to use. If the value is null, the font asset of the VisualElement style is used instead. For more information, refer to <see cref="IStyle.unityFontDefinition" />. Draws a VectorImage asset. The vector image to draw. The position offset where to draw the vector image. The rotation of the vector image. The scale of the vector image Returns an allocator that can be used to safely allocate temporary meshes from the job system. The meshes have the same scope as those allocated by AllocateTempMesh. The allocator. Inserts a node into the rendering tree that can be populated from the job system. The inserted mesh generation node. Contains a part of the draw sequence of a VisualElement. You can use it in a job to add nested draw calls. Records a draw command with the provided triangle-list indexed mesh. The vertices to be drawn. All referenced vertices must be initialized. The triangle list indices. Must be a multiple of 3. All indices must be initialized. An optional texture to be applied on the triangles. Pass null to rely on vertex colors only. Represents the vertex and index data allocated for drawing the content of a VisualElement. The number of indices successfully allocated for VisualElement content drawing. The number of vertices successfully allocated for VisualElement content drawing. Fills the values of the allocated indices with values copied directly from an array. Each 3 consecutive indices form a single triangle. The array of indices to copy from. The length of the array must match the allocated index count. Fills the values of the allocated indices with values copied directly from an array. Each 3 consecutive indices form a single triangle. The array of indices to copy from. The length of the array must match the allocated index count. Fills the values of the allocated vertices with values copied directly from an array. When this method is called, it is not possible to use SetNextVertex to fill the allocated vertices array. The array of vertices to copy from. The length of the array must match the allocated vertex count. Fills the values of the allocated vertices with values copied directly from an array. When this method is called, it is not possible to use SetNextVertex to fill the allocated vertices array. The array of vertices to copy from. The length of the array must match the allocated vertex count. Assigns the value of the next index of the allocated indices list. The value of the next index. Assigns the value of the next vertex of the allocated vertices list. The value of the next vertex. A min/max slider containing a representation of a range. For more information, refer to. USS class name of dragger elements in elements of this type. This is the high limit of the slider. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. This is the low limit of the slider. USS class name of the maximum thumb elements in elements of this type. This is the high value of the range represented on the slider. USS class name of the minimum thumb elements in elements of this type. This is the low value of the range represented on the slider. USS class name of the element that is currently controlled by NavigationMoveEvent. When a NavigationSubmitEvent is received the slider cycles through the elements in the following order: 1. Minimum thumb. 2. Maximum thumb. 3. Middle bar. 4. None (Default Navigation behavior). Returns the range of the low/high limits of the slider. USS class name of tracker elements in elements of this type. USS class name of elements of this type. This is the value of the slider. This is a Vector2 where the x is the lower bound and the y is the higher bound. Constructor. Constructor. The minimum value in the range to be represented. The maximum value in the range to be represented. The minimum value of the slider limit. The maximum value of the slider limit. Constructor. The minimum value in the range to be represented. The maximum value in the range to be represented. The minimum value of the slider limit. The maximum value of the slider limit. Instantiates a MinMaxSlider using the data read from a UXML file. Defines UxmlTraits for the MinMaxSlider. Constructor. Initialize MinMaxSlider properties using values from the attribute bag. The element to initialize. The bag of attributes. Creation Context, unused. Describes a MouseButton. The Left Mouse Button. The Middle Mouse Button. The Right Mouse Button. Class that manages capturing mouse events. Assigns an event handler to capture mouse events. The event handler that captures mouse events. Checks if the event handler is capturing the mouse. Event handler to check. True if the handler captures the mouse. Checks if there is a handler capturing the mouse. True if a handler is capturing the mouse, false otherwise. Stops an event handler from capturing the mouse. The event handler to stop capturing the mouse. If this handler is not assigned to capturing the mouse, nothing happens. Stops an event handler from capturing the mouse. Event sent after a handler starts capturing the mouse. Event sent when the handler capturing the mouse changes. In the case of a MouseCaptureEvent, this property is the IEventHandler that loses the capture. In the case of a MouseCaptureOutEvent, this property is the IEventHandler that gains the capture. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The handler taking or releasing the mouse capture. The related target. An initialized event. Event sent before a handler stops capturing the mouse. This event is sent when a mouse button is pressed. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An IMGUI mouse event. An initialized event. Resets the event members to their initial values. Event sent when the mouse pointer enters an element or one of its descendent elements. The event trickles down but does not bubble up. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. Event sent when the mouse pointer enters a window. The event bubbles up but does not trickle down. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. The base class for mouse events. Returns true if the platform-specific action key is pressed. This key is Cmd on macOS, and Ctrl on all other platforms. Returns true if the Alt key is pressed. A value that indicates which mouse button was pressed or released (if any) to cause this event: 0 is the left button, 1 is the right button, 2 is the middle button. A negative value indicates that no mouse button changed state during this event. The number of times the button is pressed. Returns true if the Windows/Cmd key is pressed. Returns true if the Ctrl key is pressed. The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed. The mouse position in the current target coordinate system. Flags that hold pressed modifier keys (Alt, Ctrl, Shift, Windows/Cmd). The difference of the mouse position between the previous mouse event and the current mouse event. The mouse position in the screen coordinate system. A bitmask that describes the currently pressed buttons. Returns true if the Shift key is pressed. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An IMGUI mouse event. An initialized event. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The mouse position. The mouse button pressed. The number of consecutive mouse clicks received. The relative movement of the mouse compared to the mouse position when the last event was received. The modifier keys held down during the event. An initialized event. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The event that sent this event. An initialized event. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The pointer event that sent this event. An initialized event. Resets the event members to their initial values. Event sent when the mouse pointer exits an element and all its descendent elements. The event trickles down but does not bubble up. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. Event sent when the mouse pointer exits a window. The event bubbles up but does not trickle down. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An IMGUI MouseLeaveWindow event. An initialized event. Resets the event members to their initial values. MouseManipulators have a list of activation filters. List of Activationfilters. Checks whether MouseEvent satisfies all of the ManipulatorActivationFilter requirements. The MouseEvent to validate. True if the event satisfies the requirements. False otherwise. Checks whether the MouseEvent is related to this Manipulator. MouseEvent to validate. True if MouseEvent uses the current activator button. False otherwise. This event is sent when the mouse moves. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An IMGUI mouse event. An initialized event. Resets the event members to their initial values. Event sent when the mouse pointer exits an element. The event trickles down and bubbles up. Event sent when the mouse pointer enters an element. The event trickles down and bubbles up. This event is sent when a mouse button is released. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An IMGUI mouse event. An initialized event. Resets the event members to their initial values. The default controller for a multi column view. Takes care of adding the MultiColumnCollectionHeader and reacting to the various callbacks. The USS class name for default labels cells inside a multi column view. The USS class name for all cells inside a multi column view. Raised when sorting changes for a column. The USS class name for the header container inside a multi column view. Raised when a column is right-clicked to bring context menu options. The USS class name for all row containers inside a multi column view. Binds a row of multiple cells to an item index. The element from that row, created by MakeItem(). The item index. The item to bind. Constructor. It will create the MultiColumnCollectionHeader to use for the view. The columns data used to initialize the header. The sort data used to initialize the header. The sorted columns for the view. Destroys a VisualElement when the view is rebuilt or cleared. The element being destroyed. Unregisters events and removes the header from the hierarchy. Creates a VisualElement to use in the virtualization of the collection view. It will create a cell for every visible column. A VisualElement for the row. Initialization step once the view is set. It will insert the multi column header in the hierarchy and register to important callbacks. The view to register to. Unbinds the row at the item index. The element from that row, created by MakeItem(). The item index. A list view with multi column support. For more information, refer to. The collection of columns for the multi-column header. If a column is clicked to change sorting, this event is raised to allow users to sort the list view items. For a default implementation, set sortingMode to ColumnSortingMode.Default. If a column is right-clicked to show context menu options, this event is raised to allow users to change the available options. The collection of sorted columns by default. Contains information about which columns are currently being sorted. Whether or not sorting is enabled in the multi-column header. This is deprecated. Use sortingMode instead. Indicates how to sort columns. To enable sorting, set it to ColumnSortingMode.Default or ColumnSortingMode.Custom. The Default mode uses the sorting algorithm provided by MultiColumnController, acting on indices. You can also implement your own sorting with the Custom mode, by responding to the columnSortingChanged event. The view controller for this view, cast as a MultiColumnListViewController. Initializes a MultiColumnListView with an empty header. Initializes a MultiColumnListView with a list of column definitions. Column definitions used to initialize the header. Assigns the view controller for this view and registers all events required for it to function properly. The controller to use with this view. Instantiates a MultiColumnListView using data from a UXML file. Defines UxmlTraits for the MultiColumnListView. Initializes MultiColumnListView properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Multi-column list view controller. View controllers of this type are meant to take care of data virtualized by any MultiColumnListView inheritor. The column controller, taking care of operations on the header. The constructor for MultiColumnListViewController. The columns data used to initialize the header. The sort data used to initialize the header. The sorted columns for the view. Unregisters events and removes the header from the hierarchy. A tree view with multi column support. For more information, refer to. The collection of columns for the multi-column header. If a column is clicked to change sorting, this event is raised to allow users to sort the tree view items. For a default implementation, set sortingMode to ColumnSortingMode.Default. If a column is right-clicked to show context menu options, this event is raised to allow users to change the available options. The collection of sorted columns by default. Contains information about which columns are currently being sorted. Whether or not sorting is enabled in the multi-column header. This is deprecated. Use sortingMode instead. Indicates how to sort columns. To enable sorting, set it to ColumnSortingMode.Default or ColumnSortingMode.Custom. The Default mode uses the sorting algorithm provided by MultiColumnController, acting on indices. You can also implement your own sorting with the Custom mode, by responding to the columnSortingChanged event. The view controller for this view, cast as a MultiColumnTreeViewController. Initializes a MultiColumnTreeView with an empty header. Initializes a MultiColumnTreeView with a list of column definitions. Column definitions used to initialize the header. Assigns the view controller for this view and registers all events required for it to function properly. The controller to use with this view. Instantiates a MultiColumnTreeView using data from a UXML file. Defines UxmlTraits for the MultiColumnTreeView. Initializes MultiColumnTreeView properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Multi-column tree view controller. View controllers of this type are meant to take care of data virtualized by any MultiColumnTreeView inheritor. The column controller, taking care of operations on the header. Unregisters events and removes the header from the hierarchy. Event sent when the user presses the cancel button. Navigation events abstract base class. By default, navigation events trickle down and bubble up. Disabled elements won't receive these events. Gets a boolean value that indicates whether the platform-specific action key is pressed. True means the action key is pressed. False means it isn't. Gets a boolean value that indicates whether the Alt key is pressed. True means the Alt key is pressed. False means it isn't. Gets a boolean value that indicates whether the WindowsCmd key is pressed. True means the WindowsCmd key is pressed. False means it isn't. Gets a boolean value that indicates whether the Ctrl key is pressed. True means the Ctrl key is pressed. False means it isn't. Gets flags that indicate whether modifier keys (Alt, Ctrl, Shift, Windows/Cmd) are pressed. Gets a boolean value that indicates whether the Shift key is pressed. True means the Shift key is pressed. False means it isn't. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The modifier keys held down during the event. The type of device this event was created from. An initialized navigation event. Event typically sent when the user presses the D-pad, moves a joystick or presses the arrow keys. The direction of the navigation. The move vector, if applicable. Constructor. Move event direction. Down. Left. Forwards, toward next element. No specific direction. Backwards, toward previous element. Right. Up. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The move vector. The modifier keys held down during the event. An initialized navigation event. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The logical direction of the navigation. The modifier keys held down during the event. An initialized navigation event. Initialize the event members. Event sent when the user presses the submit button. Defines what should happened if content overflows an element bounds. The overflow is clipped, and the rest of the content will be invisible. The overflow isn't clipped. It renders outside the element's box. Default Value. Boxes against which the VisualElement content is clipped. Clip the content against the box inside the padding areas. Clip the content against the box outside the padding areas but inside the borders. Object to draw 2D vector graphics. The color used for fill paths when using Fill. The cap to use when drawing paths using Stroke. The join to use when drawing paths using Stroke. The line width of draw paths when using Stroke. When using LineJoin.Miter joins, this defines the limit on the ratio of the miter length to the stroke width before converting the miter to a bevel. The color of draw paths when using Stroke. The stroke gradient to use when using Stroke. Adds an arc to the current sub-path to the provided position, radius and angles. The center position of the arc. The radius of the arc. The starting angle the arc. The ending angle of the arc. Whether the arc should draw in the anti-clockwise direction (default=false). Adds an arc to the current sub-path to the provided position using a control point. The first control point of the arc. The final point of the arc. The radius of the arc. Begins a new path and empties the list of recorded sub-paths. Adds a cubic bezier curve to the current sub-path to the provided position using two control points. The first control point of the cubic bezier. The second control point of the cubic bezier. The final position of the cubic bezier. When created as a detached painter, clears the current content. Does nothing otherwise. Closes the current sub-path with a straight line. If the sub-path is already closed, this does nothing. Initializes an instance of Painter2D. Dispose the Painter2D object and free its internal unmanaged resources. Fills the currently defined path. The fill rule (non-zero or odd-even) to use. Default is non-zero. Adds a straight line to the current sub-path to the provided position. The end position of the line. Begins a new sub-path at the provied coordinate. The position of the new sub-path. Adds a quadratic bezier curve to the current sub-path to the provided position using a control point. The control point of the quadratic bezier. The final position of the quadratic bezier. Saves the content of this Painter2D to a VectorImage object. The VectorImage object that will be initialized with this painter. This object should not be null. True if the VectorImage initialization succeeded. False otherwise. Strokes the currently defined path. Abstract base class for events notifying of a panel change. In the case of AttachToPanelEvent, the panel to which the event target element is now attached. In the case of DetachFromPanelEvent, the panel to which the event target element will be attached. In the case of AttachToPanelEvent, the panel to which the event target element was attached. In the case of DetachFromPanelEvent, the panel from which the event target element is detached. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. Sets the originPanel property of the event. Sets the destinationPanel property of the event. An initialized event. Resets the event members to their initial values. Options that specify how elements in the panel scale when the screen size changes. See PanelSettings.scaleMode. Elements stay the same physical size (displayed size) regardless of screen size and resolution. Elements stay the same size, in pixels, regardless of screen size. Elements get bigger when the screen size increases, and smaller when it decreases. Options that specify how to scale the panel area when the aspect ratio of the current screen resolution does not match the reference resolution. See PanelSettings.screenMatchMode. Expand the panel area horizontally or vertically so the panel size is never smaller than the reference resolution. Scales the panel area using width, height, or a mix of the two as a reference. Crops the panel area horizontally or vertically so the panel size never exceeds the reference resolution. Defines a Panel Settings asset that instantiates a panel at runtime. The panel makes it possible for Unity to display UXML-file based UI in the Game view. Sets the log level for bindings in panels using this PanelSettings asset. Determines whether the color buffer is cleared before the panel is rendered. Determines whether the depth/stencil buffer is cleared before the panel is rendered. The color used to clear the color buffer. The depth used to clear the depth/stencil buffer. Settings of the dynamic atlas. The DPI value that Unity uses when it cannot determine the screen DPI. Forces the UI shader to output colors in the gamma color space. Determines whether Unity uses width, height, or a mix of the two as a reference when it scales the panel area. The DPI that the UI is designed for. The resolution the UI is designed for. Sprites have a Pixels Per Unit value that controls the pixel density of the sprite. For sprites that have the same Pixels Per Unit value as the Reference Pixels Per Unit value in the PanelSettings asset, the pixel density will be one to one. A uniform scaling factor that Unity applies to elements in the panel before the panel transform. Determines how elements in the panel scale when the screen size changes. Specifies how to scale the panel area when the aspect ratio of the current resolution does not match the reference resolution. When the Scene uses more than one panel, this value determines where this panel appears in the sorting order relative to other panels. Set the display intended for the panel. Specifies a Render Texture to render the panel's UI on. Specifies a PanelTextSettings that will be used by every UI Document attached to the panel. Specifies a style sheet that Unity applies to every UI Document attached to the panel. The expected number of vertices that will be used by this panel. Sets a custom IPanelChangeReceiver in the panelChangeReceiver setter to receive every change event. This method is available only in development builds and the editor, as it is a debug feature to go along the profiling of an application. Sets the function that handles the transformation from screen space to panel space. For overlay panels, this function returns the input value. The translation function. Set to null to revert to the default behavior. Represents text rendering settings for a specific UI panel. PanelSettings.textSettings Describes a PenButton. Based on W3 conventions: https:www.w3.orgTRpointerevents2/#the-buttons-property. The Pen Barrel Button. The Pen is in Contact. The Pen Eraser. Describes the picking behavior. Prevents picking as the result of a mouse event. Picking enabled. Default Value. Performs picking based on the position rectangle. In the VisualElement tree hierarchy, the picking process works using a similar logic as the rendering but in reverse order: it starts with the front-most elements and proceeds step by step towards background elements. Thus, the child elements are picked before parents, and the sibling elements further down the list are picked before their predecessors. This event is sent when pointer interaction is cancelled. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. Event sent when a pointer is captured by a VisualElement. Base class for pointer capture events and mouse capture events. Identifies the pointer that sends the event. For PointerCaptureEvent and MouseCaptureEvent, returns the VisualElement that loses the pointer capture, if any. For PointerCaptureOutEvent and MouseCaptureOutEvent, returns the VisualElement that captures the pointer. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. For PointerCapture and MouseCapture events, the element that captures the pointer. For PointerCaptureOut and MouseCaptureOut events, the element that releases the pointer. For PointerCaptureEvent and MouseCaptureEvent, returns the element that loses the pointer capture, if any. For PointerCaptureOutEvent and MouseCaptureOutEvent, returns the element that captures the pointer. The pointer that is captured or released. An initialized event. Resets the event members to their initial values. A static class to capture and release pointers. Captures the pointer. The VisualElement that captures the pointer. The pointer to capture. Returns the element that is capturing the pointer. The panel that holds the element. The captured pointer. The element that is capturing the pointer. Tests whether the element has captured the pointer. The VisualElement being tested. The captured pointer. True if element captured the pointer. Tests whether an element captured a pointer and, if so, tells the element to release the pointer. The element which potentially captured the pointer. The captured pointer. Releases the pointer. The panel that holds the element that captured the pointer. The captured pointer. Event sent when a VisualElement releases a pointer. Sends when a pointer is pressed inside a visual element. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. This event is sent when a pointer enters a VisualElement or one of its descendants. The event does not trickle down and does not bubble up. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. Base class for all pointer-related events. Gets a boolean value that indicates whether the platform-specific action key is pressed. True means the action key is pressed. False means it isn't. Gets the angle of the stylus relative to the surface, in radians Gets a boolean value that indicates whether the Alt key is pressed. True means the Alt key is pressed. False means it isn't. Gets the angle of the stylus relative to the x-axis, in radians. Gets a value that indicates which mouse button was pressed or released (if any) to cause this event: 0 is the left button, 1 is the right button, 2 is the middle button. A negative value indicates that no mouse button changed state during this event. Gets the number of times the button was pressed. Gets a boolean value that indicates whether the WindowsCmd key is pressed. True means the WindowsCmd key is pressed. False means it isn't. Gets a boolean value that indicates whether the Ctrl key is pressed. True means the Ctrl key is pressed. False means it isn't. Gets the current target of the event. Gets the difference between the pointer's position during the previous mouse event and its position during the current mouse event. Gets the amount of time that has elapsed since the last recorded change in pointer values, in seconds. Gets a boolean value that indicates whether the pointer is a primary pointer. True means the pointer is a primary pointer. False means it isn't. Gets the pointer position in the current target's coordinate system. Gets flags that indicate whether modifier keys (Alt, Ctrl, Shift, Windows/Cmd) are pressed. Specifies the state of the pen. For example, whether the pen is in contact with the screen or tablet, whether the pen is inverted, and whether buttons are pressed. On macOS, penStatus will not reflect changes to button mappings. Gets the identifier of the pointer that sent the event. Gets the type of pointer that created the event. Gets the pointer position in the Screen or World coordinate system. Gets a bitmask that describes the buttons that are currently pressed. Gets the amount of pressure currently applied by a touch. Gets an estimate of the radius of a touch. Gets the accuracy of the touch radius. Gets a boolean value that indicates whether the Shift key is pressed. True means the Shift key is pressed. False means it isn't. Gets the pressure applied to an additional pressure-sensitive control on the stylus. Specifies the angle of the pen relative to the X and Y axis respectively, in radians. Gets the rotation of the stylus around its axis, in radians. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. An IMGUI mouse event. An initialized event. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. A <see cref="Touch" /> structure from the InputManager. The modifier keys held down during the event. An initialized event. Gets a pointer event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. A <see cref="PenData" /> structure from the InputManager containing pen event information. The modifier keys held down during the event. An initialized event. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. The event that sent this event. An initialized event. Resets the event members to their initial values. A static class that holds pointer ID values. Represents an invalid pointer ID value. The maximum number of pointers the implementation supports. The mouse pointer ID. The number of pen pointers the implementation supports. The base ID for pen pointers. The number of touch pointers the implementation supports. The base ID for touch pointers. This event is sent when a pointer exits an element and all of its descendants. The event does not trickle down and does not bubble up. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. PointerManipulators have a list of activation filters. Checks whether PointerEvent satisfies all of the ManipulatorActivationFilter requirements. The PointerEvent to validate. True if the event satisfies the requirements. False otherwise. Checks whether the PointerEvent is related to this Manipulator. PointerEvent to validate. True if PointerEvent uses the current activator button. False otherwise. This event is sent when a pointer changes state. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. This event is sent when a pointer exits an element. The event trickles down and bubbles up. This event is sent when a pointer enters an element. The event trickles down and bubbles up. This event is sent when a pointer does not change for a set amount of time, determined by the operating system. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. A static class that holds pointer type values. The pointer type for mouse events. The pointer type for pen events. The pointer type for touch events. The pointer type for events created by unknown devices. This event is sent when a pointer's last pressed button is released. Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances. Resets the event members to their initial values. Generic popup selection field. Callback that provides a string representation used to populate the popup menu. Callback that provides a string representation used to display the selected value. The currently selected index in the popup menu. Setting the index updates the value field and sends a property change notification. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. The currently selected value in the popup menu. Construct a PopupField. Construct a PopupField. Construct a PopupField. Construct a PopupField. Construct a PopupField. Construct a PopupField. Styled visual text element. This element doesn't have any functionality. It's just a container with a border and a title, rather than a window or popup. For more information, refer to. USS class name of content elements in elements of this type. USS class name of elements of this type. Initializes and returns an instance of PopupWindow. Instantiates a PopupWindow using the data read from a UXML file. Defines UxmlTraits for the PopupWindow. Returns an empty enumerable, as popup windows generally do not have children. Defines how the position values are interpreted by the layout engine. The element is positioned in relation to its parent box and doesn't contribute to the layout anymore. The element is positioned in relation to its default box as calculated by layout. A control that displays the progress between a lower and upper bound value. For more information, refer to. The propagation phases of an event. The event is sent from the target element back to the panel's root element. The event is not propagated. The event is sent from the panel's root element to the target element. A control that allows users to select a single option inside a RadioButtonGroup. For more information, refer to. USS class name of checkmark background in RadioButton elements. USS class name of checkmark in RadioButton elements. USS class name of input elements in RadioButton elements. USS class name for Labels in RadioButton elements. USS class name of Text elements in RadioButton elements. USS class name for RadioButton elements. Creates a RadioButton with no label. Creates a RadioButton with a Label and a default manipulator. The Label text. Instantiates a RadioButton using data from a UXML file. Defines UxmlTraits for the RadioButton. Initializes RadioButton properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. A control that allows single selection out of a logical group of RadioButton elements. Selecting one will deselect the others. For more information, refer to. The list of available choices in the group. USS class name of container element of this type. USS class name for RadioButtonGroup elements. Initializes and returns an instance of RadioButtonGroup. Initializes and returns an instance of RadioButtonGroup. The label for this group The choices to display in this group Instantiates a RadioButtonGroup using data from a UXML file. Defines UxmlTraits for the RadioButtonGroup. Initializes RadioButtonGroup properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. A Rect field. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Initializes and returns an instance of RectField. Initializes and returns an instance of RectField. The text to use as a label. Instantiates a RectField using the data read from a UXML file. Defines UxmlTraits for the RectField. Initialize RectField properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. A RectInt field. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Initializes and returns an instance of RectIntField. Initializes and returns an instance of RectIntField. The text to use as a label. Instantiates a RectIntField using the data read from a UXML file. Defines UxmlTraits for the RectIntField. Initializes the UxmlTraits for the RectIntField. The <see cref="VisualElement" /> to be initialized. Bags of attributes where the values come from. Creation Context, unused. Attribute allowing the UXML registry to more efficiently retrieve the UXML description data. Defines how the background is repeated. The background-image isn't repeated. The image is only shown once. This is the default to keep background compatibility with unity-background-scale-mode. The background image is repeated both vertically and horizontally. The last image will be clipped if it doesn't fit. The background-image is repeated and squished or stretched to fill the space (no gaps). The background-image is repeated as much as possible without clipping. The first and last image is pinned to either side of the element, and whitespace is distributed evenly between the images. A button that executes an action repeatedly while it is pressed. For more information, refer to. USS class name of elements of this type. Constructor. Constructor. The action to execute when the button is pressed. The initial delay before the action is executed for the first time. Value is defined in milliseconds. The interval between each execution of the action. Value is defined in milliseconds. Set the action that should be executed when the button is pressed. The action to execute. The initial delay before the action is executed for the first time. Value is defined in milliseconds. The interval between each execution of the action. Value is defined in milliseconds. Instantiates a RepeatButton using the data read from a UXML file. Defines UxmlTraits for the RepeatButton. Initialize RepeatButton properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Provides rotation information for visual elements that rotates around the TransformOrigin. Positive values represent clockwise rotation. The angle applied by the rotation. Positive values represent clockwise rotation and negative values represent counterclockwise rotation. Create a Rotate struct that correspond to a rotation around the z axis by the provided Angle. Return a value of Rotate that applies no rotation A collection of static methods that provide simple World, Screen, and Panel coordinate transformations. Transforms a world absolute position to its equivalent local coordinate on given panel, using provided camera for internal WorldToScreen transformation. The local coordinates reference panel. The world position to transform. The Camera used for internal WorldToScreen transformation. A position in panel coordinates that corresponds to the provided world position. Transforms a world position and size (in world units) to their equivalent local position and size on given panel, using provided camera for internal WorldToScreen transformation. The local coordinates reference panel. The world position to transform. The world size to transform. The object in the panel will appear to have that size when compared to other 3D objects at neighboring positions. The Camera used for internal WorldToScreen transformation. A (position, size) Rect in panel coordinates that corresponds to the provided world position and size. Resets the dynamic atlas of the panel. Resets the renderer of the panel. Releases all meshes, rendering commands, and pools owned by the renderer. Transforms a screen absolute position to its equivalent local coordinate on given panel. The local coordinates reference panel. The screen position to transform. A position in panel coordinates that corresponds to the provided screen position. Notifies the dynamic atlas of the panel that the content of the provided texture has changed. If the dynamic atlas contains the texture, it will update it. The current panel The texture whose content has changed. Represents the scale applied as element transformations. The center point that doesn't move when the scaling is applied is the TransformOrigin. Creates a new Scale from a Vector2. Creates a new Scale from a Vector3. Returns a value of Scale without any scaling applied. A vertical or horizontal scrollbar. For more information, refer to. Direction of this scrollbar. Top or right scroll button. USS class name of high buttons in elements of this type. Maximum value. USS class name of elements of this type, when they are displayed horizontally. Bottom or left scroll button. USS class name of low buttons in elements of this type. Minimum value. The slider used by this scroller. USS class name of slider elements in elements of this type. USS class name of elements of this type. Value that defines the slider position. It lies between lowValue and highValue. Event sent when the slider value has changed. USS class name of elements of this type, when they are displayed vertically. Updates the slider element size as a ratio of total range. A value greater than or equal to 1 will disable the Scroller. Slider size ratio. Constructor. Constructor. Will change the value according to the current slider pageSize. Will change the value according to the current slider pageSize. Will change the value according to the current slider pageSize. Will change the value according to the current slider pageSize. Instantiates a Scroller using the data read from a UXML file. Defines UxmlTraits for the Scroller. Returns an empty enumerable, as scrollers do not have children. Initialize Scroller properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Options for controlling the visibility of scroll bars in the ScrollView. The scroll bar is always visible. Displays a scroll bar only if the content does not fit in the scroll view. Otherwise, hides the scroll bar. The scroll bar is always hidden. Displays its contents inside a scrollable frame. For more information, see. USS class name of content elements in elements of this type. Contains full content, potentially partially visible. USS class name of content elements in elements of this type. Represents the visible part of contentContainer. The minimum amount of time, in milliseconds, between executions of elastic spring animation. The amount of elasticity to use when a user tries to scroll past the boundaries of the scroll view. This property controls the speed of the horizontal scrolling when using a keyboard or the on-screen scrollbar buttons (arrows and handle), based on the size of the page. Horizontal scrollbar. Specifies whether the horizontal scroll bar is visible. USS class name that's added when the ContentContainer is in horizontal mode. ScrollViewMode.Horizontal USS class name that's added when the ScrollView is in horizontal mode. ScrollViewMode.Horizontal USS class name that's added when the Viewport is in horizontal mode. ScrollViewMode.Horizontal USS class name of horizontal scrollers in elements of this type. Controls how the ScrollView allows the user to scroll the contents. ScrollViewMode This property controls the scrolling speed only when using a mouse scroll wheel, based on the size of the page. It takes precedence over the --unity-metrics-single_line-height USS variable. The behavior to use when scrolling reaches limits of a nested ScrollView. Controls the rate at which the scrolling movement slows after a user scrolls using a touch interaction. The current scrolling position. Obsolete. Use ScrollView.horizontalScrollerVisibility instead. Obsolete. Use ScrollView.verticalScrollerVisibility instead. The behavior to use when a user tries to scroll past the boundaries of the ScrollView content using a touch interaction. USS class name of elements of this type. USS class name that's added when the ContentContainer is in both horizontal and vertical mode. ScrollViewMode.VerticalAndHorizontal USS class name that's added when the ScrollView is in both horizontal and vertical mode. ScrollViewMode.VerticalAndHorizontal USS class name that's added when the Viewport is in both horizontal and vertical mode. ScrollViewMode.VerticalAndHorizontal This property controls the speed of the vertical scrolling when using a keyboard or the on-screen scrollbar buttons (arrows and handle), based on the size of the page. Gets the vertical scrollbar for the scroll view. Specifies whether the vertical scroll bar is visible. USS class name that's added when the ContentContainer is in vertical mode. ScrollViewMode.Vertical USS class name that's added when the ScrollView is in vertical mode. ScrollViewMode.Vertical USS class name that's added when the Viewport is in vertical mode. ScrollViewMode.Vertical USS class name of viewport elements in elements of this type. USS class name of vertical scrollers in elements of this type. Constructor. Constructor. Options for controlling how nested ScrollView handles scrolling when reaching the limits of the scrollable area. Automatically selects the behavior according to the context in which the UI runs. For touch input, typically mobile devices, NestedInteractionKind.StopScrolling is used. For scroll wheel input, NestedInteractionKind.ForwardScrolling is used. Scrolling will continue to the parent when no movement is possible in the scrolled direction. Scrolling capture will remain in the scroll view if it initiated the drag. Scroll to a specific child element. The child to scroll to. The behavior to use when a user tries to scroll past the end of the ScrollView content using a touch interaction. The content position is clamped to the ScrollView boundaries. The content position can overshoot the ScrollView boundaries, but then "snaps" back within them. The content position can move past the ScrollView boundaries. Instantiates a ScrollView using the data read from a UXML file. Defines UxmlTraits for the ScrollView. Initialize ScrollView properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Configurations of the ScrollView to influence the layout of its contents and how scrollbars appear. ScrollView.mode Configure ScrollView for horizontal scrolling. Configure ScrollView for vertical scrolling. Configure ScrollView for vertical and horizontal scrolling. Controls how many items can be selected at once. Multiple items are selectable at once. Selections are disabled. Only one item is selectable. Information about a drag-and-drop operation that just started. You can use it to store generic data for the rest of the drag. See BaseVerticalCollectionView.setupDragAndDrop. The element on which the drag operation started. The selected IDs in the source. Provides entry points to initialize data and visual of the new drag-and-drop operation. The slice type determines whether the center of the image is scaled or tiled. Fill the slices by stretching the center and sides. Fill the slices by tiling the center and sides. Image must be imported as a Sprite (2D and UI) and have Mesh Type set to Full Rect. A slider containing floating point values. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Creates a new instance of a Slider. Creates a new instance of a Slider. The minimum value that the slider encodes. The maximum value that the slider encodes. The direction of the slider (Horizontal or Vertical). A generic page size used to change the value when clicking in the slider. Creates a new instance of a Slider. The string representing the label that will appear beside the field. The minimum value that the slider encodes. The maximum value that the slider encodes. The direction of the slider (Horizontal or Vertical). A generic page size used to change the value when clicking in the slider. Instantiates a Slider using the data read from a UXML file. Defines UxmlTraits for the Slider. Initialize Slider properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. This is the direction of the Slider and SliderInt. An horizontal slider is made with a SliderDirection Horizontal. An vertical slider is made with a SliderDirection Vertical. A slider containing Integer discrete values. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. The value to add or remove to the SliderInt.value when it is clicked. USS class name of elements of this type. Constructors for the SliderInt. Constructors for the SliderInt. This is the low value of the slider. This is the high value of the slider. This is the slider direction, horizontal or vertical. This is the number of values to change when the slider is clicked. Constructors for the SliderInt. This is the low value of the slider. This is the high value of the slider. This is the slider direction, horizontal or vertical. This is the number of values to change when the slider is clicked. Instantiates a SliderInt using the data read from a UXML file. Defines UxmlTraits for the SliderInt. Initialize SliderInt properties using values from the attribute bag. The object to initialize. The bag of attributes. The creation context; unused. This represents a description on what column to sort and in which order. The sorted column. The index of the column to be used to find the column only if the SortColumnDescription.columnName|columnName isn't set. The name of the column. The sort direction. Called when a property has changed. Default constructor. Constructor. The column index for this sort description. The sort description. Constructor. The column name for this sort description. The sort description. This represents a collection or SortColumnDescriptions in multi SortColumnDescription views. Adds a sort description at the end of the collection. The sort description to add. Removes all sort descriptions from the collection. Determines whether the current collection contains a specific value. The object to locate in the current collection. Whether the item is in the collection or not. Copies the elements of the current collection to a Array, starting at the specified index. The array to copy to. The starting index. Gets the number of sort descriptions in the collection. Returns an enumerator that iterates through the collection. The enumerator. Returns the index of the specified SortColumnDescription if it is contained in the collection; returns -1 otherwise. The description to locate in the <see cref="SortColumnDescriptions" />. The index of the SortColumnDescriptions if found in the collection; otherwise, -1. Inserts a sort description into the current instance at the specified index. Index to insert to. The sort description to insert. Gets a value indicating whether the collection is readonly. Removes the first occurence of a sort description from the collection. The sort description to remove. Whether it was removed or not. Removes the sort description at the specified index. The index of the sort description to remove. Returns the SortColumnDescription at the specified index. The index of the SortColumnDescription to locate. The SortColumnDescription at the specified index. The sort direction. The ascending order. The descending order. Provides entry points to initialize the new drag-and-drop operation. The title displayed near the pointer to identify what is being dragged. Should be set during the BaseVerticalCollectionView.setupDragAndDrop callback. The mode to use for this drag-and-drop operation. Initializes a StartDragArgs. The text to use during the drag. The visual mode the drag starts with. Sets data associated with the current drag-and-drop operation. The key for this entry. The data to store. Stores an array of paths to assets being dragged during this drag-and-drop operation. The asset paths. Sets Unity Objects associated with the current drag-and-drop operation. The Unity Object references. Style value that can be either a Background or a StyleKeyword. The style keyword. The Background value. Creates from either a Background or a StyleKeyword. Creates from either a Background or a StyleKeyword. Creates from either a Background or a StyleKeyword. Creates from either a Background or a StyleKeyword. Creates from either a Background or a StyleKeyword. Represents a style value that can be either a BackgroundPosition or a StyleKeyword. The style keyword. The BackgroundPosition value. Creates a new StyleBackgroundPosition from either a BackgroundPosition or a StyleKeyword. Creates a new StyleBackgroundPosition from either a BackgroundPosition or a StyleKeyword. Represents a style value that can be either a BackgroundRepeat or a StyleKeyword. The style keyword. The BackgroundRepeat value. Creates a new StyleBackgroundRepeat from either a BackgroundRepeat or a StyleKeyword. Creates a new StyleBackgroundRepeat from either a BackgroundRepeat or a StyleKeyword. Represents a style value that can be either a BackgroundSize or a StyleKeyword. The style keyword. The BackgroundSize value. Creates a new StyleBackgroundSize from either a BackgroundSize or a StyleKeyword. Creates a new StyleBackgroundSize from either a BackgroundSize or a StyleKeyword. Style value that can be either a Color or a StyleKeyword. The style keyword. The Color value. Creates from either a Color or StyleKeyword. Creates from either a Color or StyleKeyword. Style value that can be either a Cursor or a StyleKeyword. The style keyword. The Cursor value. Creates from either a Cursor or StyleKeyword. Creates from either a Cursor or StyleKeyword. Style value that can be either an enum or a StyleKeyword. The style keyword. The style value. Creates from either an enum or a StyleKeyword. Creates from either an enum or a StyleKeyword. Style value that can be either a float or a StyleKeyword. The style keyword. The float value. Creates from either a float or a StyleKeyword. Creates from either a float or a StyleKeyword. Style value that can be either a Font or a StyleKeyword. The style keyword. The Font value. Creates from a Font or StyleKeyword. Creates from a Font or StyleKeyword. Style value that can be either a FontDefinition or a StyleKeyword. The style keyword. The actual value of the definition. Creates from either a FontDefinition or a StyleKeyword. Creates from either a FontDefinition or a StyleKeyword. Creates from either a FontDefinition or a StyleKeyword. Style value that can be either an integer or a StyleKeyword. The style keyword. The integer value. Creates from either an integer or StyleKeyword. Creates from either an integer or StyleKeyword. Keyword that can be used on any style value types. For style properties accepting auto. The initial (or default) value of a style property. For style properties accepting none. Means that an inline style from IStyle has no value or keyword. Means that there's no keyword defined for that property. Style value that can be either a Length or a StyleKeyword. The style keyword. The Length value. Creates from either a Length or a StyleKeyword. Creates from either a Length or a StyleKeyword. Creates from either a Length or a StyleKeyword. Style value that can be either a list or a StyleKeyword. The style keyword. The style value. Creates from either a list or a StyleKeyword. Creates from either a list or a StyleKeyword. Defines the name of a style property. Initializes and returns an instance of StylePropertyName from a string. Implicit string operator. Name of the property you want to create a new StylePropertyName with. Checks if the StylePropertyName is null or empty. StylePropertyName you want to check. True if propertyName is invalid. False otherwise. Determines if the StylePropertyNames are equal. First StylePropertyName. Second StylePropertyName. True if both StylePropertyNames are equal. False otherwise. Determines if the StylePropertyNames are not equal. First StylePropertyName. Second StylePropertyName. True if the StylePropertyNames are not equal. False otherwise. Collection of StylePropertyName. Determines whether a StylePropertyNameCollection contains the specified element. The element to locate in the <see cref="StylePropertyNameCollection" />. true if the StylePropertyNameCollection contains the specified element; otherwise, false. Enumerates the elements of a StylePropertyNameCollection. Gets the element at the current position of the enumerator. The element in the StylePropertyNameCollection at the current position of the enumerator. Releases all resources used by the StylePropertyNameCollection enumerator. Advances the enumerator to the next element of the StylePropertyNameCollection. true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. Returns an enumerator that iterates through the StylePropertyNameCollection. An enumerator that can be used to iterate through the StylePropertyNameCollection. Represents a style value that can be either a Rotate or a StyleKeyword. The style keyword. The Rotate value. Creates a StyleRotate from either a Rotate or a StyleKeyword. Creates a StyleRotate from either a Rotate or a StyleKeyword. Style value that can be either a Scale or a StyleKeyword. The style keyword. The Scale value. Creates a new StyleScale from a Scale. Creates a new StyleScale from a StyleKeyword. Creates a new StyleScale from a Vector2. Style sheets are applied to visual elements in order to control the layout and visual appearance of the user interface. A hash value computed from the stylesheet content. Whether there were errors encountered while importing the StyleSheet Whether there were warnings encountered while importing the StyleSheet Style value that can be either a TextShadow or a StyleKeyword. The style keyword. The TextShadow value. Creates from either a TextShadow or StyleKeyword. Creates from either a TextShadow or StyleKeyword. Represents a style value that can be either a TransformOrigin or a StyleKeyword. The style keyword. The TransformOrigin value. Creates a new StyleTransformOrigin from either a TransformOrigin or a StyleKeyword. Creates a new StyleTransformOrigin from either a TransformOrigin or a StyleKeyword. Style value that can be either a Translate or a StyleKeyword. The style keyword. The Translate value. Creates from either a Translate or a StyleKeyword. Creates from either a Translate or a StyleKeyword. Creates a tab to organize content on different screens. A property that adds the ability to close tabs. The USS class name for a closeable tab. The USS class name for close button in closable tabs. This event is called when a tab has been closed. This event is called before a tab is closed. Return true if the tab can be closed. The container for the content of the Tab. USS class name of container element of this type. USS class name for the dragging state of this type. Sets the icon for the Tab's header. Sets the label of the Tab's header. USS class name for drag handlebar in reorderable tabs. USS class name for drag handle in reorderable tabs. USS class name for reorderable tab elements. This event is called when a tab has been selected. Returns the Tab's header. USS class name for the icon inside the header when the value is null. USS class name for the label of the header when the value is empty or null. USS class name for the icon inside the header. USS class name for the label of the header. USS class name for the icon inside the header when the label is empty or null. USS class name for the active state underline of the header. USS class name for the header of this type. USS class name of elements of this type. Constructs a Tab. Constructs a Tab. The text to use as the header label. Constructs a Tab. The icon used as the header icon. Constructs a Tab. The text to use as the header label. The icon used as the header icon. Instantiates an Tab using the data read from a UXML file. Defines UxmlTraits for the Tab. Creates a tab view that groups a one or more Tab elements. Property that holds the current active tab. Called when the active tab is reassigned. The container for the content of the TabView. USS class name for the content container of this type. USS class name for the header container of this type. A property that adds dragging support to tabs. The USS class name for reorderable tab view. A property that returns the index of current active tab inside a list of available tabs. Raised when a tab is closed. The first argument is the tab that was closed, the second is the index of the tab that was closed. Raised when a tab is reordered. The first argument is source index, second is destination index. USS class name of elements of this type. The USS class name for vertical tab view. Constructs a TabView. Returns the tab at the specified index. Returns the tab header at the specified index. Moves the tab from the specified index to a new index. The current index of the tab to move. The target index to move the tab to. Instantiates a TabView using the data read from a UXML file. Defines UxmlTraits for the TabView. Represents the root VisualElement of UXML file. The local ID of the template in the parent UXML file (Read Only). Stores the template asset reference, if the generated element is cloned from a VisualTreeAsset as a Template declaration inside another VisualTreeAsset. Instantiates and clones a TemplateContainer using the data read from a UXML file. Defines UxmlTraits for the TemplateContainer. Returns an empty enumerable, as template instances do not have children. Initialize TemplateContainer properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Used in jobs to allocate UI Toolkit temporary meshes. Allocates the specified number of vertices and indices from a temporary allocator. The number of vertices to allocate, with a maximum limit of 65535 (or UInt16.MaxValue). The number of triangle list indices to allocate, where every three indices represent one triangle. Therefore, this value should always be a multiple of three. The returned vertices. The returned indices. Use this as the super class if you are declaring a custom VisualElement that displays text. For example, Button or Label use this as their base class. When true, a tooltip displays the full version of elided text, and also if a tooltip had been previously provided, it will be overwritten. Specifies the order in which the system should look for Emoji characters when rendering text. If this setting is enabled, the global Emoji Fallback list will be searched first for characters defined as Emoji in the Unicode 14.0 standard. When false, rich text tags will not be parsed. Returns the TextElement experimental interface. Returns true if text is elided, false otherwise. Determines how escape sequences are displayed. When set to true, escape sequences (such as \n, \t) are parsed and transformed into their corresponding characters. For example, '\n' will insert a new line. When set to false, escape sequences are displayed as raw text (for example, \n is shown as the characters '\' followed by 'n'). USS class name of selectable text elements. Retrieves this TextElement's ITextSelection The text to be displayed. USS class name of elements of this type. Initializes and returns an instance of TextElement. Computes the size needed to display a text string based on element style values such as font, font-size, word-wrap, and so on. The text to measure. Suggested width. Can be zero. Width restrictions. Suggested height. Height restrictions. The horizontal and vertical size needed to display the text string. Instantiates a TextElement using the data read from a UXML file. Defines UxmlTraits for the TextElement. Enumerator to get the child elements of the UxmlTraits of TextElement. Initializer for the UxmlTraits for the TextElement. <see cref="VisualElement" /> to initialize. Bag of attributes where to get the value from. Creation Context, not used. A TextField accepts and displays text input. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. Set this to true to allow multiple lines in the textfield and false if otherwise. USS class name of elements of this type. The string currently being exposed by the field. Creates a new textfield. Creates a new textfield. The maximum number of characters this textfield can hold. If -1, there is no limit. Set this to true to allow multiple lines in the textfield and false if otherwise. Set this to true to mask the characters and false if otherwise. The character used for masking in a password field. Creates a new textfield. Creates a new textfield. The maximum number of characters this textfield can hold. If 0, there is no limit. Set this to true to allow multiple lines in the textfield and false if otherwise. Set this to true to mask the characters and false if otherwise. The character used for masking in a password field. Instantiates a TextField using the data read from a UXML file. Defines UxmlTraits for the TextField. Initialize TextField properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. Abstract base class used for all text-based fields. Determines if the touch screen keyboard auto correction is turned on or off. Color of the cursor. This is the cursor index in the text presented. The position of the text cursor inside the element. Controls whether double-clicking selects the word under the mouse pointer. Specifies the order in which the system should look for Emoji characters when rendering text. If this setting is enabled, the global Emoji Fallback list will be searched first for characters defined as Emoji in the Unicode 14.0 standard. Hides or shows the mobile input field. USS class name of input elements in elements of this type. If set to true, the value property isn't updated until either the user presses Enter or the text field loses focus. Returns true if the field is used to edit a password. Returns true if the field is read only. The type of mobile keyboard that will be used. USS class name of labels in elements of this type. The character used for masking in a password field. Maximum number of characters for the field. USS class name of multiline input elements in elements of this type. Calls the methods in its invocation list when isReadOnly changes. USS class name of input elements when placeholder text is shown Controls whether the element's content is selected upon receiving focus. Controls whether the element's content is selected when you mouse up for the first time. This is the selection index in the text presented. Background color of selected text. USS class name of single line input elements in elements of this type. The value of the input field. Retrieves this Field's TextElement ITextEdition USS class name of input elements in elements of this type. Retrieves this Field's TextElement ITextSelection The active touch keyboard being displayed. Controls whether triple clicking selects the entire line under the mouse pointer or not. USS class name of elements of this type. Option for controlling the visibility of the vertical scroll bar in the TextInputBaseField_1. Computes the size needed to display a text string based on element style values such as font, font-size, and word-wrap. The text to measure. Suggested width. Can be zero. Width restrictions. Suggested height. Height restrictions. The horizontal and vertical size needed to display the text string. Selects all the text contained in the field. Remove selection Select text between cursorIndex and selectIndex. Options for controlling the visibility of the vertical scroll bar in the TextInputBaseField_1. Converts a string to the value of the specified generic type from the subclass. The string to convert. A value converted from the string. Defines UxmlTraits for TextInputFieldBase. Initialize the traits for this field. VisualElement to which to apply the attributes. Bag of attributes where to get the attributes. Creation context. Converts a value of the specified generic type from the subclass to a string representation. The value to convert. A string representing the value. Specifies how the text Element treats hidden overflow content. The Element clips overflow content and hides it. This is the default value. The Element clips overflow content and hides it, but displays an ellipsis ("...") to indicate that clipped content exists. Specifies which part of the text the Element replaces with an ellipsis when textOverflow is set to TextOverflow.Ellipsis. The ellipsis replaces content at the end of the text. This is the default value. The ellipsis replaces content in the middle of the text. The ellipsis replaces content at the beginning of the text. Script interface for VisualElement text-shadow style property IStyle.textShadow. The blur radius of the shadow. The color of the shadow. The offset of the shadow. Base class for text fields. The format string used to define how numeric values are displayed. The string follows standard .NET formatting conventions. Method used to add a mouse dragger on the label for specific numeric fields. Applies the values of a 3D delta and a speed from an input device. A vector used to compute the value change. A multiplier for the value change. The start value. Allow to set the value without being notified. The new value to set. Indicates the user started the mouse dragging for text selection. Indicates the user stopped the mouse dragging for text selection. This is the inner representation of the Text input. Method to override to indicate the allowed characters in the actual field. Formats the string. Called when the user is dragging the label to update the value contained in the field. Delta on the move. Speed of the move. Starting value. Method called by the application when the label of the field is started to be dragged to change the value of it. Method called by the application when the label of the field is stopped to be dragged to change the value of it. Converts a string to a value type. The string to convert. The value parsed from the string. Convert the value to string for visual representation. Value to convert. String representation. Specifies the TextValueField_1's UxmlTraits. Initializes the TextValueField_1's UxmlTraits. The VisualElement to initialize. A bag of UXML attribute name-value pairs used to initialize VisualElement members. The creation context associated with these traits. Represents a style sheet that's assembled from other style sheets. Contains timing information of scheduler events. Time difference in milliseconds between now and the previous callback. Current time in milliseconds. Start time in milliseconds, or last callback time for repeatable IScheduledItem. Compare this object with another object and return true if they are equal. The object to compare with. True if the objects are equal. Compare this object with another object and return true if they are equal. The object to compare with. True if the objects are equal. Describes how to interpret a TimeValue. Interprets the time value as milliseconds. Interprets the time value as seconds. Represents a time value. The unit of the value property. The time value. Creates from a float and an optional TimeUnit. Creates from a float and an optional TimeUnit. A Toggle is a clickable element that represents a boolean value. USS class name of Images in Toggle elements. USS class name of input elements in Toggle elements. USS class name for Labels in Toggle elements. USS class name of Toggle elements that have mixed values USS class name of Toggle elements that have no text. USS class name of Text elements in Toggle elements. USS class name for Toggle elements. Creates a Toggle with no label. Creates a Toggle with a Label and a default manipulator. The Label text. Instantiates a Toggle using data from a UXML file. Defines UxmlTraits for the Toggle. Initializes Toggle properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. A control that allows single or multiple selection out of a logical group of Button elements. Allows having all buttons to be unchecked when set to true. USS class name for any Buttons in the group. USS class name of container element of this type. USS class name for the leftmost Button in the group. USS class name for any Buttons in the middle of the group. USS class name for the rightmost Button in the group. USS class name for the Button if only one is available in the group. USS class name of container element of this type. USS class name for empty state label. Whether all buttons can be selected. USS class name of elements for this type. Constructs a ToggleButtonGroup. Constructs a ToggleButtonGroup. The text used as a label. Constructs a ToggleButtonGroup. The ToggleButtonGroupState to be used by this control. Constructs a ToggleButtonGroup. The text used as a label. The ToggleButtonGroupState to be used by this control. Sets a new value without triggering any change event. The new value. Instantiates a ToggleButtonGroup. Defines UxmlTraits for the ToggleButtonGroup. The structure that keeps track of the Button states inside a ToggleButtonGroup. Returns the number of toggle button options available. Compares two ToggleButtonGroupState of flag enum types. The ToggleButtonGroupState to be compared with. The value of a given flag enum. True if both options sets are the same, otherwise false. Compares two ToggleButtonGroupState. The option set to be compared against. True if both option sets are the same, otherwise returns false. Helps generate a ToggleButtonGroupState based on a list of booleans. A list of booleans that is used to generated a ToggleButtonGroupState. a ToggleButtonGroupState created by the list of booleans. Constructs a ToggleButtonGroupState. A bit value where each bit represents the binary state of the corresponding button. The number of toggle button options. Checks if a given ToggleButtonGroupState matches with the current one. A ToggleButtonGroupState to be compared against. True if both option has the same data and number of options, otherwise returns false. Compares the the current option set with an Object. An object to be compared against. True if both option sets are not the same, otherwise returns false. Creates a ToggleButtonGroupState based on a FlagsAttribute enum type. The default Enum Flag value. The number of options. A ToggleButtonGroupState based on the EnumFlag passed as an argument. Retrieves a Span of integers containing the active options as indices. A Span of type integers with the allocated size to hold the number of active indices. Get the hashcode of this ToggleButtonGroupState. The hashcode of this ToggleButtonGroupState. Retrieves a Span of integers containing the inactive options as indices. A Span of type integers with the allocated size to hold the number of inactive indices. Checks if both of the ToggleButtonGroupState are the same. The first option set to be compared against. The second option set to be compared against. True if both option sets are the same, otherwise returns false. Checks if both of the ToggleButtonGroupState are not the same. The first option set to be compared against. The second option set to be compared against. True if both option sets are not the same, otherwise returns false. Resets the states of the toggle buttons. Sets all the available options to active. The option based on the index. The index of the option. Synchronizes the internal data with the ToggleButtonGroupState from a FlagsAttribute. The option set to be synced against. The ability to synchronize two option sets of different sizes. A flag enum type. Toggles all the available options' state. Defines how a serialized ToggleButtonGroupState will be initialized in the inspector. See ToggleButtonGroup.allowEmptySelection. See ToggleButtonGroup.isMultipleSelection. The initial length of the ToggleButtonGroupState. Defines how the toggle button group will be initialized. If multiple buttons can be selected. If an empty selection is possible. The length of the group. Event sent to find the first VisualElement that displays a tooltip. Rectangle of the hovered VisualElement in the panel coordinate system. Text to display inside the tooltip box. Initializes and returns an instance of TooltipEvent. Resets the event members to their initial values. Represents the point of origin where the transformations (Scale, Translate, and Rotate) are applied. Create a TransformOrigin data with two Lengths for the x and y axis. Returns the initial value for the TransformOrigin property. Specifies the alignment keywords for TransformOrigin. The origin of the transform operation set to the bottom of the element. The origin of the transform operation is set to the center of the element. The origin of the transform operation is set to the left of the element. The origin of the transform operation is set to the right of the element. The origin of the transform operation is set to the top of the element. Event sent when a transition is canceled. Event sent at the completion of the transition. In the case where a transition is removed before completion then the event will not fire. Transition events abstract base class. The number of seconds the transition has been running, excluding delay phase time. The names of the properties associated with the transition. Determines whether the ITransitionEvent affects the specified property. The property to check against. true if the ITransitionEvent affects the specified property; otherwise, false. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). The name of the style property. The elapsed time. An initialized transition event. Event sent when a transition is created (i.e. added to the set of running transitions). Event sent when a transition's delay phase ends. Represents a translation of the object. Percentage values in X and Y are relative to the width and height of the visual element where the style value is applied. Create a Translate data with two Lengths for the x and y axis. Returns the value of a Translate object with no translation applied. A TreeView is a vertically scrollable area that links to, and displays, a list of items organized in a tree. Callback for binding a data item to the visual element. Callback invoked when a VisualElement created via makeItem is no longer needed and will be destroyed. A UXML template that constructs each recycled and rebound element within the tree. This template is designed to replace the makeItem definition. Callback for constructing the VisualElement that is the template for each recycled and re-bound element in the list. Callback for unbinding a data item from the VisualElement. The view controller for this view, cast as a TreeViewController. Creates a TreeView with all default properties. Creates a TreeView with specified factory methods. The factory method to call to create a display item. The method should return a VisualElement that can be bound to a data item. The method to call to bind a data item to a display item. The method receives as parameters the display item to bind, and the index of the data item to bind it to. Creates a TreeView with specified factory methods using the fixed height virtualization method. The item height to use in FixedHeight virtualization mode. The factory method to call to create a display item. The method should return a VisualElement that can be bound to a data item. The method to call to bind a data item to a display item. The method receives as parameters the display item to bind, and the index of the data item to bind it to. Instantiates a TreeView using data from a UXML file. Defines UxmlTraits for the TreeView. Tree view controller. View controllers of this type are meant to take care of data virtualized by any TreeView inheritor. View for this controller, cast as a TreeView. A data structure for the tree view item expansion event. The id of the item being expanded or collapsed. Returns -1 when expandAll() or collapseAll() is being called. Indicates whether the expandAllChildren or collapsedAllChildren is applied when expanding the item. Indicates whether the item is expanded (true) or collapsed (false). Item structure provided to a TreeView using the default implementation. For more information on usage, refer to. Children of this tree item. Data for this item. Whether this item has children or not. Id of the item. Creates a TreeViewItemData_1 with all required parameters. The item id. The item data. The item's children. Use this enum to specify during which phases the event handler is executed. The event handler should be executed during the AtTarget and BubbleUp phases. The event handler should be executed during the AtTarget and TrickleDown phases. A SplitView that contains two resizable panes. One pane is fixed-size while the other pane has flex-grow style set to 1 to take all remaining space. The border between the panes is draggable to resize both panes. Both horizontal and vertical modes are supported. Requires exactly two child elements to operate. The child element that is set as the fixed size pane. 0 for setting first child as the fixed pane, 1 for the second child element. The initial width or height for the fixed pane. The child element that is set as the flexable size pane. Orientation of the split view. Collapse one of the panes of the split view. This will hide the resizer and make the other child take up all available space. Index of child to collapse. Parameterized constructor. 0 for setting first child as the fixed pane, 1 for the second child element. Set an inital width or height for the fixed pane. Orientation of the split view. Un-collapse the split view. This will restore the split view to the state it was before the previous collapse. Instantiates a TwoPaneSplitView using the data read from a UXML file. Defines UxmlTraits for the TwoPaneSplitView. Determines the orientation of the two resizable panes. Split view panes layout is left/right with vertical resizable split. Split view panes layout is top/bottom with horizontal resizable split. Base class for all the UXML specific attributes. The default value to be used for that specific attribute. The string representation of the default value of the UXML attribute. Use this method to obtain the actual value of the attribute. The bag of attributes where to get the actual value. The creation context. The value of type T. Defines a Component that connects VisualElements to GameObjects. This makes it possible to render UI defined in UXML documents in the Game view. Specifies the PanelSettings instance to connect this UIDocument component to. If the GameObject that this UIDocument component is attached to has a parent GameObject, and that parent GameObject also has a UIDocument component attached to it, this value is set to the parent GameObject's UIDocument component automatically. The root visual element where the UI hierarchy starts. The runtime panel that this UIDocument is attached to. The order in which this UIDocument will show up on the hierarchy in relation to other UIDocuments either attached to the same PanelSettings, or with the same UIDocument parent. The VisualTreeAsset loaded into the root visual element automatically. A renderer Component that should be added next to a UIDocument Component to allow world-space rendering. This Component is added automatically by the UIDocument when the PanelSettings asset is configured in world-space. Input backend options for UI Toolkit events at runtime. The initial configuration on UI Toolkit start up. This is equal to InputSystemCompatibleBackend. This option will use the Input System package is available, and the old Input Manager if not. The new Input System compatible backend allows the Input System package to send its input to UI Toolkit directly, removing the need for an UnityEngine.EventSystems.EventSystem in the user scene. This option will use the Input System package is available, and the old Input Manager if not. The legacy backend relies on the Input Manager UnityEngine.Input class only and is not compatible with the Input System package. This option will always try to use the old Input Manager. If the Input Manager is not enabled as an active input handler, UI Toolkit runtime events will not work. Global configuration options for UI Toolkit input. Use this method to activate one of the two input backends available for UIToolkit events at runtime. The new Input System compatible backend allows the Input System package to send its input to UI Toolkit directly, removing the need for an UnityEngine.EventSystems.EventSystem in the user scene, and will automatically fall back to Input Manager input if the Input System package input isn't enabled in the Player Settings active input handling. Alternatively, use the legacy backend to always rely on Input Manager input only. In that case, if the Input Manager is not enabled as an active input handler, UI Toolkit runtime events will not work. The input backend to be used as the source of input for UI Toolkit events at runtime. Makes a text field for entering an unsigned integer. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Applies the values of a 3D delta and a speed from an input device. A vector used to compute the value change. A multiplier for the value change. The start value. Constructor. Constructor. Maximum number of characters the field can take. Constructor. Maximum number of characters the field can take. Converts a string to an unsigned integer. The string to convert. The unsigned integer parsed from the string. Instantiates an UnsignedIntegerField using the data read from a UXML file. Defines UxmlTraits for the UnsignedIntegerField. Converts the given unsigned integer to a string. The unsigned integer to be converted to string. The unsigned integer as string. Makes a text field for entering unsigned long integers. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Applies the values of a 3D delta and a speed from an input device. A vector used to compute the value change. A multiplier for the value change. The start value. Constructor. Constructor. Maximum number of characters the field can take. Constructor. Maximum number of characters the field can take. Converts a string to a unsigned long integer. The string to convert. The unsigned long integer parsed from the string. Instantiates a UnsignedLongField using the data read from a UXML file. Defines UxmlTraits for the UnsignedLongField. Converts the given unsigned long integer to a string. The unsigned long integer to be converted to string. The ulong integer as string. UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy. See UQuery for further information. Utility Object that constructs a set of selection rules to be run on a root visual element. Selects all elements that are active. A QueryBuilder with the selection rules. Convenience overload, shorthand for Build().AtIndex(). Compiles the selection rules into a QueryState object. Selects all elements that are checked. Selects all direct child elements of elements matching the previous rules. Selects all direct child elements of elements matching the previous rules. Selects all elements with the specified class in the class list, as specified with the class attribute in a UXML file or added with VisualElement.AddToClassList method. The class to use in the query. Initializes a QueryBuilder. The root element on which to conduct the search query. Selects all elements that are descendants of currently matching ancestors. Selects all elements that are descendants of currently matching ancestors. Selects all elements that are enabled. Convenience overload, shorthand for Build().First(). The first element matching all the criteria, or null if none was found. Selects all elements that are focused. Convenience overload, shorthand for Build().ForEach(). Each return value will be added to this list. The function to be invoked with each matching element. Convenience overload, shorthand for Build().ForEach(). The function to be invoked with each matching element. Convenience overload, shorthand for Build().ForEach(). The function to be invoked with each matching element. Selects all elements that are hovered. Convenience overload, shorthand for Build().Last(). The last element matching all the criteria, or null if none was found. Selects element with this name. Selects all elements that are not active. Selects all elements that not checked. Selects all elements that are not enabled. Selects all elements that don't currently own the focus. Selects all elements that are not hovered. Selects all elements that are not selected. Selects all elements that are not visible. Selects all elements of the specified Type (eg: Label, Button, ScrollView, etc). If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). QueryBuilder configured with the associated selection rules. Selects all elements of the specified Type (eg: Label, Button, ScrollView, etc). If specified, will select elements with this name. If specified, will select elements with the given class (not to be confused with Type). QueryBuilder configured with the associated selection rules. Selects all elements that are not selected. Convenience method. shorthand for Build().ToList. A list containing elements satisfying selection rules. Convenience method. Shorthand gor Build().ToList(). Adds all elements satisfying selection rules to the list. Selects all elements that are visible. Selects all elements satifying the predicate. Predicate that must return true for selected elements. QueryBuilder configured with the associated selection rules. UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy. For more information, refer to. Convenience overload, shorthand for UQueryExtensions.Query|Query().UQueryBuilder_1.Build|Build().UQueryBuilder_1.First|First() Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If provided, it selects elements with the specified class (case sensitive, to be distinguished from Type). The first element matching all the criteria, or null if none was found. Convenience overload, shorthand for UQueryExtensions.Query|Query().UQueryBuilder_1.Build|Build().UQueryBuilder_1.First|First() Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If provided, it selects elements with the specified class (case sensitive, to be distinguished from Type). The first element matching all the criteria, or null if none was found. Convenience overload, shorthand for UQueryExtensions.Query|Query().UQueryBuilder_1.Build|Build().UQueryBuilder_1.First|First() Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If provided, it selects elements with the specified class (case sensitive, to be distinguished from Type). The first element matching all the criteria, or null if none was found. Convenience overload, shorthand for Query<T>.Build().First(). Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If provided, it selects elements with the specified class (case sensitive, to be distinguished from Type). The first element matching all the criteria, or null if none was found. Initializes a QueryBuilder with the specified selection rules. Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If provided, it selects elements with the specified class (case sensitive, to be distinguished from Type). QueryBuilder configured with the associated selection rules. Initializes a QueryBuilder with the specified selection rules. Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If provided, it selects elements with the specified class (case sensitive, to be distinguished from Type). QueryBuilder configured with the associated selection rules. Initializes a QueryBuilder with the specified selection rules. Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If provided, it selects elements with the specified class (case sensitive, to be distinguished from Type). QueryBuilder configured with the associated selection rules. Initializes a QueryBuilder with the specified selection rules. Root VisualElement on which the selector will be applied. If specified, will select elements with this name. If provided, it selects elements with the specified class (case sensitive, to be distinguished from Type). QueryBuilder configured with the associated selection rules. Initializes a QueryBuilder with the specified selection rules. Root VisualElement on which the selector will be applied. QueryBuilder configured with the associated selection rules. Query object containing all the selection rules. The object can be saved and rerun later without re-allocating memory. Selects the nth element matching all the criteria, or null if not enough elements were found. The index of the matched element. The match element at the specified index. The first element matching all the criteria, or null if none was found. The first element matching all the criteria, or null if none was found. Invokes function on all elements matching the query. The action to be invoked with each matching element. Invokes function on all elements matching the query. Each return value will be added to this list. The function to be invoked with each matching element. Invokes function on all elements matching the query. The action to be invoked with each matching element. Allows traversing the results of the query with foreach without creating GC allocations. A UQueryState_1.Enumerator instance configured to traverse the results. The last element matching all the criteria, or null if none was found. The last element matching all the criteria, or null if none was found. Creates a new QueryState with the same selection rules, applied on another VisualElement. The element on which to apply the selection rules. A new QueryState with the same selection rules, applied on this element. Adds all elements satisfying selection rules to the list. Adds all elements satisfying selection rules to the list. Returns a list containing elements satisfying selection rules. A list containing elements satisfying selection rules. Offers a set of options that describe the intended usage patterns of a VisualElement. These options serve as guidance for optimizations. You can set multiple usage hints on an element. For example, if both position and color change, you can set both DynamicTransform and DynamicColor. Note: Set the usage hints at edit time or before you add the VisualElement to a panel. In the case of transition, when it starts, the system might automatically add missing relevant usage hints to avoid regenerating geometry in every frame. However, this causes a one-frame performance penalty because the rendering data for the VisualElement and its descendants is regenerated. Optimizes rendering of a VisualElement for frequent color changes, such as a built-in style color being animated. Optimizes rendering of a VisualElement for frequent position and transformation changes. Optimizes rendering of a VisualElement that changes its transformation and position frequently, and has many descendants that have their hints set to DynamicTransform. Optimizes rendering of a VisualElement that has multiple descendants with nested masks. No particular hints applicable. Describes a UXML Object attribute referencing an asset in the project. In UXML, this is referenced as a string URI. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return null. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Declares that a field or property is associated with a UXML attribute. Provides a custom UXML name to the attribute. Provides support for obsolete UXML attribute names. Declares that a field or property is associated with a UXML attribute. Declares that a field or property is associated with a UXML attribute. The name of the UXML attribute. Declares that a field or property is associated with a UXML attribute. The name of the UXML attribute. The Obsolete UXML attribute names. Base class for describing an XML attribute. The default value for the attribute, as a string. The attribute name. A list of obsolete names for this attribute. Restrictions on the possible values of the attribute. Attribute type. Attribute namespace. Whether the attribute is optional, required or prohibited. Get the attribute value from the attribute bag. A bag containing attributes and their values as strings. The context in which the values are retrieved. A function to convert a string value to type T. The value to return if the attribute is not found in the bag. The attribute value from the bag, or defaultValue if the attribute is not found. Tries to get the attribute value from the attribute bag. A bag contains attributes and their values as strings. The context in which the values are retrieved. A function to convert a string value to type T. The value to return if the attribute is not found in the bag. If the attribute could be retrieved, the retrieved value converted by the conversion function or the default value if the retrieved value could not de converted. True if the value is found, false otherwise. An enum to describe attribute use. There is no restriction on the use of this attribute with the element. The attribute is optional for the element. The attribute should not appear for the element. The attribute must appear in the element tag. Holds the description data of a UXML attribute. The field name of the UXML attribute The obsolete names of the UXML attribute. The type reference of the UXML attribute. The uxml name of the UXML attribute. Creates a new instance of UxmlAttributeNames. The field name of the UXML attribute. The type reference of the UXML attribute. The type reference of the UXML attribute. The obsolete names of the UXML attribute. Factory for the root AttributeOverrides element. Defines UxmlTraits for the AttributeOverrides tag. Describes a UXML bool attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Describe an allowed child element for an element. The name of the allowed child element. The namespace name of the allowed child element. Constructor. Describes a UXML attribute representing a Color as a string. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Contains pre-processed information about UXML attribute descriptions to avoid relying on reflection. Registers pre-processed UXML attribute descriptions. The type to register. The pre-processed UXML attribute information. Describes a UXML double attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Declares a custom control. Custom path to use when displaying the element in the UI Builder Library. Sub-paths can be created by using a forward slash (/). If no value is provided, the element namespace will be used. Provides a custom name for an element. Controls the visibility of the element in the UI Builder Library. Exposes a type of VisualElement to UXML and UI Builder Declares a custom control with a custom element name. Provides a custom name for the element. Describes a UXML attribute representing an enum as a string. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Restricts the value of an attribute to be taken from a list of values. The list of values the attribute can take. Indicates whether the current UxmlEnumeration object is equal to another object of the same type. The object to compare with. True if the otheer object is equal to this one. UxmlFactory specialization for classes that derive from VisualElement and that shares its traits, VisualElementTraits. Generic base class for UXML factories, which instantiate a VisualElement using the data read from a UXML file. Instantiate an object of type T0 and initialize it by calling T1 UxmlTraitsInit method. A bag of name-value pairs, one for each attribute of the UXML element. This can be used to initialize the properties of the created object. When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. The created element. Describes a UXML float attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Describes a UXML Hash128 attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Used for fields that are serialized but do not come from UXML data, such as UxmlSerializedData.uxmlAssetId. Describes a UXML int attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Describes a UXML long attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Declares that a class can be instantiated from UXML and contain UXML attributes. Declares that a field or property is associated with nested UXML objects. The name of the nested UXML element that the UXML Objects are serialized to. Note: A null or empty value will result in the objects being serialized into the root. In UI Builder, when adding a UXML Object to a field that has multiple derived types, a dropdown list appears with a selection of available types that can be added to the field. By default, this list comprises all types that inherit from the UXML object type. You can use a parameter to specify a list of accepted types to be displayed, rather than showing all available types Declares that a field or property is associated with nested UXML objects. Declares that a field or property is associated with nested UXML objects. The name of the nested UXML element that the UXML Objects are serialized to. Note: This field can not be null or empty. Declares that a field or property is associated with nested UXML objects. The name of the nested UXML element that the UXML Objects are serialized to. Note: A null or empty value will result in the objects being serialized into the root. In UI Builder, when adding a UXML Object to a field that has multiple derived types, a dropdown list appears with a selection of available types that can be added to the field. By default, this list comprises all types that inherit from the UXML object type. You can use a parameter to specify a list of accepted types to be displayed, rather than showing all available types. Factory for the root UXML element. Returns the empty string, as the root element can not appear anywhere else bit at the root of the document. Returns the empty string, as the root element can not appear anywhere else bit at the root of the document. Returns the empty string, as the root element can not appear anywhere else bit at the root of the document. Returns "UXML". Returns the qualified name for this element. Returns null. Defines UxmlTraits for the UXML root element. Returns an enumerable containing UxmlChildElementDescription(typeof(VisualElement)), since the root element can contain VisualElements. Generates an instance of the declaring element when the UxmlElementAttribute is used in a custom control. Returns an instance of the declaring element. The new instance of the declaring element. Applies serialized field values to a compatible visual element. The element to have the serialized data applied to. This is used by the code generator when a custom control is using the UxmlElementAttribute. You should not need to call it. Determines if an attribute should be applied during Deserialize. Used to indicate if a field is overridden in a UXML file. The serialized field contains the default value, it will be applied when editing in the UI Builder. The serialized field is ignored and not applied during Deserialize. The serialized field is overridden in a UXML file and will be applied during Deserialize. This is used by the code generator when a custom control is using the UxmlElementAttribute. This is used by the code generator when a custom control is using the UxmlElementAttribute. Describes a UXML string attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Factory for the root Style element. Defines UxmlTraits for the Style tag. Factory for the root Template element. Defines UxmlTraits for the Template tag. Describes a VisualElement derived class for the parsing of UXML files and the generation of UXML schema definition. Initialize a VisualElement instance with values from the UXML element attributes. The VisualElement to initialize. A bag of name-value pairs, one for each attribute of the UXML element. When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. Describes an XML System.Type attribute. The default value for the attribute, as a string. Constructor. Method that retrieves an attribute's value from an attribute bag. Returns it if it is found, otherwise return defaultValue. The attribute bag. The context in which the method retrieves attribute values. The attribute's value. If the method cannot find the value, returns defaultValue. Method that tries to retrieve an attribute's value from an attribute bag.. Returns true if it is found, otherwise returns false. The attribute bag. The context in which the method retrieves attribute values. The attribute's value. True if the method can retrieve the attribute's value. False otherwise. Provides information about the expected type when applied to a Type field or property that has the UxmlAttributeAttribute attribute. The base type that the value inherits from. Provides information about the expected type when applied to a Type field or property that has the UxmlAttributeAttribute attribute. Provides information about the expected type when applied to a Type field or property that has the UxmlAttributeAttribute attribute. The base type that the value inherits from. Base class to restricts the value of an attribute. Indicates whether the current UxmlTypeRestriction object is equal to another object of the same type. The object to compare with. True if the otheer object is equal to this one. Describes a UXML uint attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Describes a UXML ulong attribute. The default value for the attribute, as a string. Constructor. Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue. The bag of attributes. The context in which the values are retrieved. The value of the attribute. Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false. The bag of attributes. The context in which the values are retrieved. The value of the attribute. True if the value is found, false otherwise. Restricts the value of an attribute to be within the specified bounds. True if the bounds exclude max. True if the bounds exclude min. The maximum value for the attribute. The minimum value for the attribute. Indicates whether the current UxmlValueBounds object is equal to another object of the same type. The object to compare with. True if the otheer object is equal to this one. Restricts the value of an attribute to match a regular expression. The regular expression that should be matched by the value. Indicates whether the current UxmlValueMatches object is equal to another object of the same type. The object to compare with. True if the otheer object is equal to this one. This event is sent by the Editor while it determines whether the command will be handled by an element in the panel. A Vector2 field. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Initializes and returns an instance of Vector2Field. Initializes and returns an instance of Vector2Field. The text to use as a label. Instantiates a Vector2Field using the data read from a UXML file. Defines UxmlTraits for the Vector2Field. Initialize Vector2Field properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. A Vector2Int field. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Initializes and returns an instance of Vector2IntField. Initializes and returns an instance of Vector2IntField. The text to use as a label. Instantiates a Vector2IntField using the data read from a UXML file. Defines UxmlTraits for the Vector2IntField. Initializes the UxmlTraits for the Vector2IntField. <see cref="VisualElement" /> to initialize. Bag of attributes where to get them. Creation Context, unused. A Vector3 field. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Initializes and returns an instance of Vector3Field. Initializes and returns an instance of Vector3Field. The text to use as a label. Instantiates a Vector3Field using the data read from a UXML file. Defines UxmlTraits for the Vector3Field. Initialize Vector3Field properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. A Vector3Int field. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Initializes and returns an instance of Vector3IntField. Initializes and returns an instance of Vector3IntField. The text to use as a label. Instantiates a Vector3IntField using the data read from a UXML file. Defines UxmlTraits for the Vector3IntField. Initializes the UxmlTraits for the Vector3IntField. VisualElement to initialize. Bag of attributes where to get them. Context Creation, unused. A Vector4 field. For more information, refer to. USS class name of input elements in elements of this type. USS class name of labels in elements of this type. USS class name of elements of this type. Initializes and returns an instance of Vector4Field. Initializes and returns an instance of Vector4Field. The text to use as a label. Instantiates a Vector4Field using the data read from a UXML file. Defines UxmlTraits for the Vector4Field. Initialize Vector4Field properties using values from the attribute bag. The object to initialize. The attribute bag. An asset that represents a vector image. The height of the vector image. The width of the vector image. Value used to signify some changes in the VisualElement Add or remove a binding was requested Some data was bound changes to the border radis changes to the border width Some color of the element has changed (background-color, border-color, etc.) The data source of the element was changed The DisableRendering flag has changed The combined registered callbacks' EventCategory values has changed changes to hierarchy changes to properties that may have an impact on layout The opacity of the element have changed changes to the overflow Some property changed that potentially invalidates cached Picking results Some render hints were changed The visuals of the element have changed changes to the size of the element after layout has been performed, without taking the local transform into account changes to styles changes to StyleSheet, USS class changes that may impact the world transform (e.g. laid out position, local transform) The 'transition-property' style of the element has changed (impacts cancelling of ongoing style transitions) persistent data ready Represents a vertex of geometry for drawing content of VisualElement. A special value representing the near clipping plane. Always use this value as the vertex position's z component when building 2D (flat) UI geometry. Describes the vertex's position. A color value for the vertex. The UV coordinate of the vertex. Style value that specifies whether or not a VisualElement is visible. The VisualElement is hidden. Hidden VisualElements will take up space in their parent layout if their positionType is set to PositionType.Relative. Use the DisplayStyle style property to both hide and remove a VisualElement from the parent VisualElement layout. Note, this is the enum value used when setting styles via VisualElement.style.visibility. In C#, you can just use VisualElement.visible = false. The VisualElement is visible. Default Value. Base class for objects that are part of the UIElements visual tree. Number of child elements in this object's contentContainer. Child elements are added to it, usually this is the same as the element itself. The rectangle of the content area of the element, in the local space of the element. (Read Only) The custom style properties accessor of a VisualElement (Read Only). Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. Path from the data source to the value. The possible type of data source assignable to this VisualElement. This information is only used by the UI Builder as a hint to provide some completion to the data source path field when the effective data source cannot be specified at design time. USS class name of local disabled elements. 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. Returns true if the VisualElement is enabled in its own hierarchy. Returns true if the VisualElement is enabled locally. Returns the UIElements experimental interfaces. Delegate function to generate the visual content of a visual element. Access to this element physical hierarchy Indicates the directionality of the element's text. The value will propagate to the element's children. The position and size of the VisualElement relative to its parent, as computed by the layout system. (Read Only) Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the transform, but before applying the layout translation. The name of this VisualElement. The rectangle of the padding area of the element, in the local space of the element. The panel onto which this VisualElement is attached. The parent of this VisualElement. Determines if this element can be pick during mouseEvents or IPanel.Pick queries. The final rendered style values of a visual element, as it's rendered in the current frame.(Read Only) 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 Panel.scaledPixelsPerPoint. This should only be called on elements that are part of a panel. Retrieves this VisualElement's IVisualElementScheduler Sets the style values on a VisualElement. Returns a VisualElementStyleSheetSet that manipulates style sheets attached to this element. 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. Returns a transform object for this VisualElement. ITransform 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). This property can be used to associate application-specific user data with this VisualElement. Used for view data persistence, such as tree expanded states, scroll position, or zoom level. Indicates whether or not this element should be rendered. Stores the asset reference, if the generated element is cloned from a VisualTreeAsset. Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the world transform. Returns a matrix that cumulates the following operations (in order): -Local Scaling -Local Rotation -Local Translation -Layout Translation -Parent worldTransform (recursive definition - consider identity when there is no parent) Add an element to this element's contentContainer Adds a class to the class list of the element in order to assign styles from USS. Note the class name is case-sensitive. The name of the class to add to the list. Brings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements. Returns the elements from its contentContainer. Searches for a class in the class list of this element. The name of the class for the search query. Returns true if the class is part of the list. Otherwise, returns false. Remove all child elements from this element's contentContainer Removes a binding from the element. The id of the binding to unbind on this element. Removes all bindings from the element. Removes all classes from the class list of this element. AddToClassList Checks if this element is an ancestor of the specified child element. The child element to test against. Returns true if this element is a ancestor of the child element, false otherwise. Checks if the specified point intersects with this VisualElement's layout. The point in the local space of the element. Returns true if the point is contained within the element's layout. Otherwise, returns false. Initializes and returns an instance of VisualElement. Retrieves the child element at a specific index. The index of the element. Enables or disables the class with the given name. The name of the class to enable or disable. A boolean flag that adds or removes the class name from the class list. If true, EnableInClassList adds the class name to the class list. If false, EnableInClassList removes the class name from the class list. Searches up the hierarchy of this VisualElement and retrieves stored userData, if any is found. Finds the lowest common ancestor between two VisualElements inside the VisualTree hierarchy. Gets the binding instance for the provided targeted property. The binding ID. The binding instance, if it exists. Gets information on all the bindings of the current element. The bindings information. Retrieve the classes for this element. A class list. Queries the dataSource and dataSourcePath of a binding object. The binding ID to query. A context object with the data source and data source path of a binding object. Walks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type Walks up the hierarchy, starting from this element, and returns the first VisualElement of this type Queries the dataSource and dataSourcePath inherited from the hierarchy. A context object with the hierarchical data source and data source path. Allows to know if a target property has a binding associated to it. The binding ID. true if the property has a binding; false otherwise. Hierarchy is a struct allowing access to the hierarchy of visual elements Number of child elements in this object's contentContainer The physical parent of this element in the hierarchy. Add an element to this element's contentContainer Returns the elements from its contentContainer Remove all child elements from this element's contentContainer Retrieves the child element at position Compares instances of the Hierarchy struct for equality. The structure to compare with. Returns true if the two instances refer to the same element, false otherwise. Retrieves the index of the specified VisualElement in the Hierarchy. The element to return the index for. The index of the element, or -1 if the element is not found. Insert an element into this element's contentContainer Compares instances of the Hierarchy struct for equality. The left operand of the comparison. The right operand of the comparison. Returns true if the two instances refer to the same element, false otherwise. Compares instances of the Hierarchy struct for inequality. The left operand of the comparison. The right operand of the comparison. Returns false if the two instances refer to the same element, true otherwise. Removes this child from the hierarchy. Remove the child element located at this position from this element's contentContainer Reorders child elements from this VisualElement contentContainer. Sorting criteria. Returns the element at the specified index in the hierarchy The index of the child The VisualElement at this index Retrieves the child index of the specified VisualElement. The child element to retrieve. The index of the child, or -1 if the child is not found. Insert an element into this element's contentContainer Triggers a repaint of the VisualElement on the next frame. This method is called internally when a change occurs that requires a repaint, such as when UIElements.BaseField_1.value is changed or the text in a Label. If you are implementing a custom control, you can call this method to trigger a repaint when a change occurs that requires a repaint such as when using generateVisualContent to render a mesh and the mesh data has now changed. The modes available to measure VisualElement sizes. At Most. The element should give its preferred width/height but no more than the value passed. The element should give the width/height that is passed in and derive the opposite site from this value (for example, calculate text size from a fixed width). The element should give its preferred width/height without any constraint. 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. The sibling element. 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. The sibling element. Removes this child from the contentContainerhierarchy. Remove the child element located at this position from this element's contentContainer Removes a class from the class list of the element. The name of the class to remove to the list. Removes this element from its parent hierarchy. Sends an event to the event handler. The event to send. Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements. Assigns a binding between a target and a source. The binding ID. The binding object. Changes the VisualElement enabled state. A disabled visual element does not receive most events. New enabled state Reorders child elements from this VisualElement contentContainer. The sorting criteria. Retrieves the child element at a specific index. The index of the element. Toggles between adding and removing the given class name from the class list. The class name to add or remove from the class list. Gets the binding instance for the provided targeted property. The binding ID. When this method returns, contains the binding associated with the target property, if it exists; otherwise contains <see langword="null" /> true if the binding exists; false otherwise. Queries the dataSource and dataSourcePath of a binding object. The binding ID to query. The resulting context object. Returns true if a binding with the provided id was registered on the element; false otherwise. Returns the last BindingResult of a binding object from the UI to the data source. The ID of the binding object. The result of the last binding operation to the data source. true if the binding object has been updated; false otherwise. Returns the last BindingResult of a binding object from the data source to the UI. The ID of the binding object. The result of the last binding operation to the UI. true if the binding object has been updated; false otherwise. Instantiates a VisualElement using the data read from a UXML file. This is used by the code generator when a custom control is using the UxmlElementAttribute. This is used by the code generator when a custom control is using the UxmlElementAttribute. You should not need to call it. Defines UxmlTraits for the VisualElement. The focusable attribute. The focus index attribute. Returns an enumerable containing UxmlChildElementDescription(typeof(VisualElement)), since VisualElements can contain other VisualElements. Initialize VisualElement properties using values from the attribute bag. The object to initialize. The attribute bag. The creation context; unused. VisualElementExtensions is a set of extension methods useful for VisualElement. Add a manipulator associated to a VisualElement. VisualElement associated to the manipulator. Manipulator to be added to the VisualElement. Transforms a point from the local space of an element to the local space of another element. The element to use as a reference as the source local space. The element to use as a reference as the destination local space. The point to transform, in the local space of the source element. A point in the local space of destination element. Transforms a rectangle from the local space of an element to the local space of another element. The element to use as a reference as the source local space. The element to use as a reference as the destination local space. The rectangle to transform, in the local space of the source element. A rectangle in the local space of destination element. Transforms a point from the local space of the element to the world space. The element to use as a reference for the local space. The point to transform, in local space. A point in the world space. Transforms a rectangle from the local space of the element to the world space. The element to use as a reference for the local space. The rectangle to transform, in local space. A rectangle in the world space. Remove a manipulator associated to a VisualElement. VisualElement associated to the manipulator. Manipulator to be removed from the VisualElement. Aligns a VisualElement's left, top, right and bottom edges with the corresponding edges of its parent. The element to be aligned with its parent Aligns a VisualElement's left and right edges with the corresponding edges of its parent. The element to be aligned with its parent Transforms a point from the world space to the local space of the element. The element to use as a reference for the local space. The point to transform, in world space. A point in the local space of the element. Transforms a rectangle from the world space to the local space of the element. The element to use as a reference for the local space. The rectangle to transform, in world space. A rectangle in the local space of the element. Define focus change directions for the VisualElementFocusRing. Last value for the direction defined by this class. The focus is moving to the left. The focus is moving to the right. Implementation of a linear focus ring. Elements are sorted according to their focusIndex. The focus order for elements having 0 has a focusIndex. Constructor. The root of the element tree for which we want to build a focus ring. Default ordering of the elements in the ring. Ordering of elements in the focus ring. Order elements using a depth-first pre-order traversal of the element tree. Order elements according to their position, first by X, then by Y. Order elements according to their position, first by Y, then by X. Get the direction of the focus change for the given event. For example, when the Tab key is pressed, focus should be given to the element to the right in the focus ring. Get the next element in the given direction. This structure manipulates the set of StyleSheet objects attached to the owner VisualElement. Number of style sheets attached to the owner element. Adds a style sheet for the owner element. Removes all style sheets for the owner element. Looks for the specified StyleSheet Returns true if the style sheet is attached to the owner element, false otherwise. Compares instances of the VisualElementStyleSheetSet struct for equality. The structure to compare with. Returns true if the two instances refer to the same element, false otherwise. Adds a style sheet for the owner element at a specified index Compares instances of the VisualElementStyleSheetSet struct for equality. The left operand of the comparison The right operand of the comparison True if the two instances refer to the same element, false otherwise. Compares instances of the VisualElementStyleSheetSet struct for inequality. The left operand of the comparison The right operand of the comparison Returns false if the two instances refer to the same element, true otherwise. Removes a style sheet for the owner element. Reads the value at the specified index in the list of StyleSheet objects attached of the element The index of the StyleSheet An instance of this class holds a tree of VisualElementAsset's, created from a UXML file. Each node in the file corresponds to a VisualElementAsset. You can clone a VisualTreeAsset to create a tree of VisualElement's. Note: You can't generate a VisualTreeAsset from raw UXML at runtime. A hash value computed from the template content. Whether there were errors encountered while importing the UXML File Whether there were warnings encountered while importing the UXML File The stylesheets used by this VisualTreeAsset. The UXML templates used by this VisualTreeAsset. Build a tree of VisualElements from the asset. The root of the tree of VisualElements that was just cloned. Build a tree of VisualElements from the asset. The path to the property that you want to bind to the root of the cloned tree. The root of the tree of VisualElements that was just cloned. Builds a tree of VisualElements from the asset. A VisualElement that will act as the root of the cloned tree. Build a tree of VisualElements from the asset. The root of the tree of VisualElements that was just cloned. Build a tree of VisualElements from the asset. The path to the property that you want to bind to the root of the cloned tree. The root of the tree of VisualElements that was just cloned. This event is sent when the mouse wheel moves. The amount of scrolling applied with the mouse wheel. The magnitude of WheelEvent.delta that corresponds to exactly one tick of the scroll wheel. Constructor. Use GetPooled() to get an event from a pool of reusable events. Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them. A wheel IMGUI event. An initialized event. Resets the event members to their initial values. Controls how white space and line breaks within an element's text are handled. Sequences of whitespace will collapse into a single whitespace. Text will wrap when necessary. This is the default behavior. Sequences of whitespace will collapse into a single whitespace. Text will never wrap to the next line. Whitespace is preserved. Text will only wrap on line breaks. Whitespace is preserved. Text will wrap when necessary. By default, items will all try to fit onto one line. You can change that and allow the items to wrap as needed with this property. All items will be on one line. Default Value. All items will be on one line. Default Value. Items will wrap onto multiple lines from bottom to top. The UIElements module implements the UIElements retained mode UI framework.