Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEditor.Experimental.UIElements
/
Inherits from:Experimental.UIElements.VisualElement
Implements interfaces:INotifyValueChanged<T0>, IStyle, ITransform, IUIElementDataWatch, IVisualElementScheduler
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseMakes a field for editing an AnimationCurve.
ranges | Optional rectangle that the curve is restrained within. If the range width or height is < 0 then CurveField computes an automatic range, which encompasses the whole curve. |
value | The AnimationCurve currently being exposed by the field. |
CurveField | Constructor. |
OnValueChanged | Registers this callback to receive ChangeEvent<AnimationCurve> when value was changed by user input. |
SetValueAndNotify | Sets the value of the curve and, if different from the previous value, notifies the OnValueChanged event callback with a ChangeEvent<AnimationCurve> |
canGrabFocus | Return true if the element can be focused. |
focusController | Return the focus controller for this element. |
focusIndex | An integer used to sort focusables in the focus ring. A negative value means that the element can not be focused. |
childCount | Number of child elements in this object's contentContainer |
clippingOptions | Should this element clip painting to its boundaries. |
contentContainer | child elements are added to this element, usually this |
dataWatch | Access to this element data watch interface. |
enabledInHierarchy | Returns true if the VisualElement is enabled in its own hierarchy. |
enabledSelf | Returns true if the VisualElement is enabled locally. |
persistenceKey | Used for view data persistence (ie. tree expanded states, scroll position, zoom level). |
schedule | Retrieves this VisualElement's IVisualElementScheduler |
shadow | Access to this element physical hierarchy |
style | Reference to the style object of this element. |
this[int] | Access to this element physical hierarchy |
userData | This property can be used to associate application-specific user data with this VisualElement. |
HandleEvent | Handle an event, most often by executing the callbacks associated with the event. |
HasBubbleHandlers | Return true if event handlers for the event propagation bubble up phase have been attached on this object. |
HasCaptureHandlers | Return true if event handlers for the event propagation capture phase have been attached on this object. |
RegisterCallback | Add an event handler on the instance. If the handler has already been registered on the same phase (capture or bubbling), this will have no effect. |
UnregisterCallback | Remove callback from the instance. |
Blur | Tell the element to release the focus. |
Focus | Attempt to give the focus to this element. |
Add | Add an element to this element's contentContainer |
AddStyleSheetPath | Adds this stylesheet file to this element list of applied styles |
AnyDirty | Checks if any of the ChangeTypes have been marked dirty. |
BringToFront | Brings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements. |
Children | Returns the elements from its contentContainer |
Clear | Remove all child elements from this element's contentContainer |
Contains | Returns true if the element is a direct child of this VisualElement |
ElementAt | Retrieves the child element at position |
FindAncestorUserData | Searchs up the hierachy of this VisualElement and retrieves stored userData, if any is found. |
FindCommonAncestor | Finds the lowest commont ancestor between two VisualElements inside the VisualTree hierarchy |
GetEnumerator | Allows to iterate into this elements children |
GetFirstAncestorOfType | Walks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type |
GetFirstOfType | Walks up the hierarchy, starting from this element, and returns the first VisualElement of this type |
GetFullHierarchicalPersistenceKey | Combine this VisualElement's VisualElement.persistenceKey with those of its parents to create a more unique key for use with VisualElement.GetOrCreatePersistentData. |
GetOrCreatePersistentData | Takes a reference to an existing persisted object and a key and returns the object either filled with the persisted state or as-is. |
HasStyleSheetPath | Checks if this stylesheet file is in this element list of applied styles |
Insert | Insert an element into this element's contentContainer |
OnPersistentDataReady | Called when the persistent data is accessible and/or when the data or persistence key have changed (VisualElement is properly parented). |
OverwriteFromPersistedData | Overwrite object from the persistent data store. |
PlaceBehind | Places this element right before the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually behind of its sibling. |
PlaceInFront | Places this element right after the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually in front of its sibling. |
Remove | Removes this child from the hierarchy |
RemoveAt | Remove the child element located at this position from this element's contentContainer |
RemoveFromHierarchy | Removes this element from its parent hierarchy |
RemoveStyleSheetPath | Removes this stylesheet file from this element list of applied styles |
SavePersistentData | Write persistence data to file. |
SendToBack | Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements. |
SetEnabled | Changes the VisualElement enabled state. A disabled VisualElement does not receive most events. |
Sort | Reorders child elements from this VisualElement contentContainer. |
OnStyleResolved | Callback when the styles of an object have changed. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!