Type:Rect: Difference between revisions

From Resonite Wiki
m a edit that shows that a person is a NERD who wants to manually do a type themselves
cat and remove unnecessary paragraphs
 
Line 1: Line 1:
A '''Rect''' represents a [[Value Type|value type]] of a 2-dimensional rectangle. It consists of a starting x and y coordinate, and a width and height. Most, if not all, components will have these as proportions of the total bounds, between 0 and 1.
'''Rect''' is a [[Value Type|value type]] that represents a 2-dimensional rectangle. It consists of an x and y coordinate along with a width and height. Most components will interpret these values as proportions of the total bounds, i.e. between 0 and 1.


For dynamic variables and other components requiring a type, the type for Rect is <code>rect</code> or the non-pretty named type <code>Elements.Core.Rect</code>.
== Examples ==


== Examples ==
* For the [[SpriteProvider (Component)|SpriteProvider]] component, the Rect property bounds the sprite to be rendered, with the values being proportions of the total width and height of the sprite image.
* For the [[SpriteProvider (Component)|SpriteProvider]] component, the Rect property bounds the sprite to be rendered, with the values being proportions of the total width and height of the sprite image.
* Rects can be received from the component [[Component:RectTransformComputedProperties|RectTransformComputedProperties]] to get the elements inside a UIX Canvas, and the rect sizes and positions from those elements.
* Rects can be received from the component [[Component:RectTransformComputedProperties|RectTransformComputedProperties]] to get the elements inside a UIX Canvas, and the rect sizes and positions from those elements.
== See Also ==
=== How Other Places Define Rects ===
* Unity's documentation on [https://docs.unity3d.com/ScriptReference/Rect.html Rects] & [https://docs.unity3d.com/ScriptReference/RectTransform.html RectTransforms]
* Wikipedia's definition on the [https://en.wikipedia.org/wiki/Rectangle rectangle]
* Microsoft's documentation on [https://learn.microsoft.com/en-us/dotnet/api/system.windows.rect?view=windowsdesktop-8.0 Rect Struct]


[[Category:Type]]
[[Category:Type]]
[[Category:Value types]]

Latest revision as of 18:35, 14 October 2025

Rect is a value type that represents a 2-dimensional rectangle. It consists of an x and y coordinate along with a width and height. Most components will interpret these values as proportions of the total bounds, i.e. between 0 and 1.

Examples

  • For the SpriteProvider component, the Rect property bounds the sprite to be rendered, with the values being proportions of the total width and height of the sprite image.
  • Rects can be received from the component RectTransformComputedProperties to get the elements inside a UIX Canvas, and the rect sizes and positions from those elements.