Component:RectTransform: Difference between revisions

Latest revision as of 23:30, 12 November 2024

Component image

**RectTransform** component as seen in the Scene Inspector

The RectTransform component defines what space a slot with UIX components on it will use, based on the total amount of space that has been provided. This is mostly used to encapsulate elements with inside it, then provides options to anchor, offset, and pivot the placement of the RectTransform container.

Fields

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.
`AnchorMin`	Float2	The normalized position (0 to 1) in the parent object that the lower left corner is anchored to.
`AnchorMax`	Float2	The normalized position (0 to 1) in the parent object that the upper right corner is anchored to.
`OffsetMin`	Float2	The offset of the lower left corner of the rectangle relative to the lower left anchor, in pixels.
`OffsetMax`	Float2	The offset of the upper right corner of the rectangle relative to the upper right anchor, in pixels.
`Pivot`	Float2	The normalized position in this rectangle that it rotates around.

Usage

This can be used for placements inside your canvas or other upper elements, for your images or other lower elements for this container component.

When attempting to duplicate a RectTransform, the new RectTransform will remove itself from the slot.

Examples

Here is a video from ProbablePrime's tutorial on RectTransforms:

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=RectTransformComponent.png
@@ Line 9: / Line 8: @@
 <!--T:2-->
-== Intoduction ==
+The '''RectTransform''' component defines what space a slot with [[UIX]] components on it will use, based on the total amount of space that has been provided. This is mostly used to encapsulate elements with inside it, then provides options to anchor, offset, and pivot the placement of the RectTransform container.
-A RectTransform defines what space a slot with [[UIX]] components on it will use, based on the total amount of space that has been provided.
 <!--T:3-->
-== Usage ==
+== Fields ==
 {{Table ComponentFields
 |AnchorMin|Float2|The normalized position (0 to 1) in the parent object that the lower left corner is anchored to.
 |AnchorMax|Float2|The normalized position (0 to 1) in the parent object that the upper right corner is anchored to.
 |OffsetMin|Float2|The offset of the lower left corner of the rectangle relative to the lower left anchor, in pixels.
@@ Line 24: / Line 21: @@
 <!--T:4-->
-== Behavior ==
+== Usage ==
+This can be used for placements inside your canvas or other upper elements, for your images or other lower elements for this container component.
+{{Note|When attempting to duplicate a RectTransform, the new RectTransform will remove itself from the [[Slot|slot]].|information}}
 <!--T:5-->
 == Examples ==
+Here is a video from [[User:ProbablePrime|ProbablePrime]]'s tutorial on RectTransforms:
+<youtube>cLtD7uWrduI</youtube>
 <!--T:6-->
-== Related Components ==
+== See Also ==
+The [[Component:RectTransformComputedProperties|RectTransformComputedProperties]] component is useful when using this component as a reference, returning you the size of the actual rect transform for your calculations.
 </translate>
-[[Category:Components{{#translation:}}|RectTransform (Component){{#translation:}}]]
+[[Category:Components{{#translation:}}|Rect Transform]]
-[[Category:ComponentStubs]]
+[[Category:Components:UIX{{#translation:}}|Rect Transform]]
-[[Category:Components:UIX{{#translation:}}|RectTransform (Component){{#translation:}}]]