Component:RectTransformComputedProperties: Difference between revisions

From Resonite Wiki
small correction, a slot contains the rect transform needed for it.
This page is no longer a stub. Added descriptions.
 
Line 3: Line 3:
|Name=Rect Transform Computed Properties
|Name=Rect Transform Computed Properties
}}
}}
{{stub}}


The '''RectTransformComputedProperties''' component is used to get the size of a [[UIX]] element that is contained in a [[Slot|slot]] that has a  [[Component:RectTransform|RectTransform]]. It takes in the RectTransform reference, and then returns a <code>LocalComputerRect</code>, which is the local bounds of the element, and returns the <code>BoundingRect</code>, which is the bounding rect itself (which can be larger than the local elements from within). Most of the time, both values would be the same, except for some situations.
The '''RectTransformComputedProperties''' component is used to get the size of a [[UIX]] element that is contained in a [[Slot|slot]] that has a  [[Component:RectTransform|RectTransform]]. It takes in the RectTransform reference, and then returns a <code>LocalComputerRect</code>, which is the local bounds of the element, and returns the <code>BoundingRect</code>, which is the bounding rect itself (which can be larger than the local elements from within). Most of the time, both values would be the same, except for some situations.


== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Rect|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv0=true|
|Rect|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv0=true|The rect transform component to reference from
|LocalComputeRect|{{RootFieldType|RawOutput`1|[[Type:Rect|Rect]]}}|TypeAdv1=true|
|LocalComputeRect|{{RootFieldType|RawOutput`1|[[Type:Rect|Rect]]}}|TypeAdv1=true|The local bounds of the element
|BoundingRect|{{RootFieldType|RawOutput`1|[[Type:Rect|Rect]]}}|TypeAdv2=true|
|BoundingRect|{{RootFieldType|RawOutput`1|[[Type:Rect|Rect]]}}|TypeAdv2=true|The bounding rect itself
}}
}}


== Behavior ==
== Usage ==
This is used to get the size of the bounds of whatever is inside the [[Component:RectTransform|RectTransform]].


== Examples ==
== Examples ==

Latest revision as of 21:46, 20 July 2024

Component image 
Rect Transform Computed Properties component as seen in the Scene Inspector


The RectTransformComputedProperties component is used to get the size of a UIX element that is contained in a slot that has a RectTransform. It takes in the RectTransform reference, and then returns a LocalComputerRect, which is the local bounds of the element, and returns the BoundingRect, which is the bounding rect itself (which can be larger than the local elements from within). Most of the time, both values would be the same, except for some situations.

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
Rect RectTransform The rect transform component to reference from
LocalComputeRect raw output of Rect The local bounds of the element
BoundingRect raw output of Rect The bounding rect itself

Usage

This is used to get the size of the bounds of whatever is inside the RectTransform.

Examples

See Also

The RectTransform component is needed for this component to work.