Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

GUILayoutUtility.GetRect

static function GetRect(content: GUIContent, style: GUIStyle): Rect;
static Rect GetRect(GUIContent content, GUIStyle style);
static def GetRect(content as GUIContent, style as GUIStyle) as Rect
static function GetRect(content: GUIContent, style: GUIStyle, params options: GUILayoutOption[]): Rect;
static Rect GetRect(GUIContent content, GUIStyle style, params GUILayoutOption[] options);
static def GetRect(content as GUIContent, style as GUIStyle, *options as GUILayoutOption[]) as Rect

Parameters

contentThe content to make room for displaying.
styleThe GUIStyle to layout for.
optionsAn optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Rect A rectangle that is large enough to contain content when rendered in style.

Description

Reserve layout space for a rectangle for displaying some contents with a specific style.

	// Shows the button rect properties in a label when the mouse is over it
	var buttonText : GUIContent = new GUIContent("some button"); 
	var buttonStyle : GUIStyle = GUIStyle.none; 
	
	function OnGUI() { 
		var rt : Rect = GUILayoutUtility.GetRect(buttonText, buttonStyle); 
		if (rt.Contains(Event.current.mousePosition)) { 
			GUI.Label(Rect(0,20,200,70), "PosX: " + rt.x + "\nPosY: " + rt.y + 
				  "\nWidth: " + rt.width + "\nHeight: " + rt.height);
		} 
		GUI.Button(rt, buttonText, buttonStyle); 
	}

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public GUIContent buttonText = new GUIContent("some button");
    public GUIStyle buttonStyle = GUIStyle.none;
    void OnGUI() {
        Rect rt = GUILayoutUtility.GetRect(buttonText, buttonStyle);
        if (rt.Contains(Event.current.mousePosition))
            GUI.Label(new Rect(0, 20, 200, 70), "PosX: " + rt.x + "\nPosY: " + rt.y + "\nWidth: " + rt.width + "\nHeight: " + rt.height);
        
        GUI.Button(rt, buttonText, buttonStyle);
    }
}

import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public buttonText as GUIContent = GUIContent('some button')

	public buttonStyle as GUIStyle = GUIStyle.none

	def OnGUI() as void:
		rt as Rect = GUILayoutUtility.GetRect(buttonText, buttonStyle)
		if rt.Contains(Event.current.mousePosition):
			GUI.Label(Rect(0, 20, 200, 70), ((((((('PosX: ' + rt.x) + '\nPosY: ') + rt.y) + '\nWidth: ') + rt.width) + '\nHeight: ') + rt.height))
		GUI.Button(rt, buttonText, buttonStyle)
static function GetRect(width: float, height: float): Rect;
static Rect GetRect(float width, float height);
static def GetRect(width as float, height as float) as Rect
static function GetRect(width: float, height: float, style: GUIStyle): Rect;
static Rect GetRect(float width, float height, GUIStyle style);
static def GetRect(width as float, height as float, style as GUIStyle) as Rect
static function GetRect(width: float, height: float, params options: GUILayoutOption[]): Rect;
static Rect GetRect(float width, float height, params GUILayoutOption[] options);
static def GetRect(width as float, height as float, *options as GUILayoutOption[]) as Rect
static function GetRect(width: float, height: float, style: GUIStyle, params options: GUILayoutOption[]): Rect;
static Rect GetRect(float width, float height, GUIStyle style, params GUILayoutOption[] options);
static def GetRect(width as float, height as float, style as GUIStyle, *options as GUILayoutOption[]) as Rect

Parameters

widthThe width of the area you want.
heightThe height of the area you want.
styleAn optional GUIStyle to layout for. If specified, the style's padding value will be added to your sizes & its margin value will be used for spacing.
optionsAn optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Rect The rectanlge to put your control in.

Description

Reserve layout space for a rectangle with a fixed content area.

static function GetRect(minWidth: float, maxWidth: float, minHeight: float, maxHeight: float): Rect;
static Rect GetRect(float minWidth, float maxWidth, float minHeight, float maxHeight);
static def GetRect(minWidth as float, maxWidth as float, minHeight as float, maxHeight as float) as Rect
static function GetRect(minWidth: float, maxWidth: float, minHeight: float, maxHeight: float, style: GUIStyle): Rect;
static Rect GetRect(float minWidth, float maxWidth, float minHeight, float maxHeight, GUIStyle style);
static def GetRect(minWidth as float, maxWidth as float, minHeight as float, maxHeight as float, style as GUIStyle) as Rect
static function GetRect(minWidth: float, maxWidth: float, minHeight: float, maxHeight: float, params options: GUILayoutOption[]): Rect;
static Rect GetRect(float minWidth, float maxWidth, float minHeight, float maxHeight, params GUILayoutOption[] options);
static def GetRect(minWidth as float, maxWidth as float, minHeight as float, maxHeight as float, *options as GUILayoutOption[]) as Rect
static function GetRect(minWidth: float, maxWidth: float, minHeight: float, maxHeight: float, style: GUIStyle, params options: GUILayoutOption[]): Rect;
static Rect GetRect(float minWidth, float maxWidth, float minHeight, float maxHeight, GUIStyle style, params GUILayoutOption[] options);
static def GetRect(minWidth as float, maxWidth as float, minHeight as float, maxHeight as float, style as GUIStyle, *options as GUILayoutOption[]) as Rect

Parameters

minWidthThe minimum width of the area passed back.
maxWidthThe maximum width of the area passed back.
minHeightThe minimum width of the area passed back.
maxHeightThe maximum width of the area passed back.
styleAn optional style. If specified, the style's padding value will be added to the sizes requested & the style's margin values will be used for spacing.
optionsAn optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Rect A rectangle with size between minWidth & maxWidth on both axes.

Description

Reserve layout space for a flexible rect.

The rectangle's size will be between the min & max values.

Copyright © 2014 Unity Technologies
UnityGalleryAsset StoreBuyDownload