.. _stdlib_ui_frame_component:

=======
UIFrame
=======


+++++++
Classes
+++++++

.. _struct-ui_frame_component-UIFrame:

.. das:attribute:: UIFrame : NativeComponent

Base class for UI components. All UI components uses UIFrame to store their size and pivot. Interactive frames can be used to handle input events.


:Properties:

.. _function-ui_frame_component__dot__rq_localPosition2D_UIFrame:

.. das:operator:: UIFrame.localPosition2D() : float2



.. _function-ui_frame_component__dot__rq_localPosition2D_rq_clone_UIFrame_float2:

.. das:operator:: UIFrame.localPosition2D =(value: float2)

Local position of the frame relative to the parent frame in 2D space.

Unlike `localPosition`, which represents a 3D world position with Y axis pointing up, `localPosition2D` represents a 2D/UI position where the Y axis points down.

:Arguments: * **value** : float2

.. _function-ui_frame_component__dot__rq_size_UIFrame:

.. das:operator:: UIFrame.size() : float2



.. _function-ui_frame_component__dot__rq_size_rq_clone_UIFrame_float2:

.. das:operator:: UIFrame.size =(value: float2)

Size in pixels. This component is used to define a frame for UI elements.

:Arguments: * **value** : float2

.. _function-ui_frame_component__dot__rq_pivot_UIFrame:

.. das:operator:: UIFrame.pivot() : float2



.. _function-ui_frame_component__dot__rq_pivot_rq_clone_UIFrame_float2:

.. das:operator:: UIFrame.pivot =(value: float2)

Frame's origin relative to it's content. Left-top of the content is (0,0), right-bottom is (1,1). Default is (0.5, 0.5).

:Arguments: * **value** : float2