WoW:API Region SetPoint - Revision history

Move page script: Move page script moved page API Region SetPoint to WoW:API Region SetPoint without leaving a redirect

2023-08-15T04:47:08Z

Move page script moved page API Region SetPoint to API Region SetPoint without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

WoWWiki>Dafrito: Clarified how relativeFrame works under a special case

2010-09-16T18:23:37Z

Clarified how relativeFrame works under a special case

← Older revision		Revision as of 18:23, 16 September 2010
Line 8:		Line 8:
	== Arguments ==		== Arguments ==
	; point : String - Point of the object to adjust based on the anchor.		; point : String - Point of the object to adjust based on the anchor.
	; relativeFrame : String/Widget - Name ~~of,~~ or reference to, a frame to attach obj to; defaults to the object's parent ~~(or the screen~~, if ~~object has no parent) if nil or omitted~~.		; relativeFrame : String/Widget - Name or reference to a frame to attach obj to. If omitted or nil, it typically defaults to the object's parent. However, if relativePoint is also not defined, relativeFrame will default to UIParent.
	; relativePoint : String - point of the relativeFrame to attach point of obj to. If not specified, defaults to the value of point.		; relativePoint : String - point of the relativeFrame to attach point of obj to. If not specified, defaults to the value of point.
	; ofsx : Number - x-offset (negative values will move ''obj'' left, positive values will move ''obj'' right), defaults to 0 if not specified.		; ofsx : Number - x-offset (negative values will move ''obj'' left, positive values will move ''obj'' right), defaults to 0 if not specified.
Line 34:		Line 34:
	* Offset units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, while screen width varies with aspect ratio.		* Offset units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, while screen width varies with aspect ratio.
	* <tt>ofsx</tt> and <tt>ofsy</tt> must both be passed as arguments for either to take effect; they default to 0 only when neither is given. That is, <tt>foo:SetPoint(bar, 40)</tt> will ignore the 40 rather than treat it as (+40,+0).		* <tt>ofsx</tt> and <tt>ofsy</tt> must both be passed as arguments for either to take effect; they default to 0 only when neither is given. That is, <tt>foo:SetPoint(bar, 40)</tt> will ignore the 40 rather than treat it as (+40,+0).
			* Secure frames will silently ignore calls to this function if the relative frame is a [[API FontString\|FontString]].

	=== Edge definitions ===		=== Edge definitions ===

WoWWiki>Farmbuyer: add note about offsets

2009-07-27T17:45:30Z

add note about offsets

← Older revision		Revision as of 17:45, 27 July 2009
Line 33:		Line 33:
	* Behavior of this function with multiple anchors is complex. Generally, you can override points by setting them again (so repeated assignment to the "TOPLEFT" point of a frame would move the frame, unless other anchor points interfere). If you're repositioning a frame, call <code>obj:[[API Region ClearAllPoints\|ClearAllPoints]]()</code> to eliminate unwanted interactions.		* Behavior of this function with multiple anchors is complex. Generally, you can override points by setting them again (so repeated assignment to the "TOPLEFT" point of a frame would move the frame, unless other anchor points interfere). If you're repositioning a frame, call <code>obj:[[API Region ClearAllPoints\|ClearAllPoints]]()</code> to eliminate unwanted interactions.
	* Offset units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, while screen width varies with aspect ratio.		* Offset units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, while screen width varies with aspect ratio.
			* <tt>ofsx</tt> and <tt>ofsy</tt> must both be passed as arguments for either to take effect; they default to 0 only when neither is given. That is, <tt>foo:SetPoint(bar, 40)</tt> will ignore the 40 rather than treat it as (+40,+0).

	=== Edge definitions ===		=== Edge definitions ===

WoWWiki>Starlightblunder: /* Points */

2009-07-23T18:00:18Z

Points

← Older revision		Revision as of 18:00, 23 July 2009
Line 14:		Line 14:

	=== Points ===		=== Points ===
	There are ~~eight~~ valid point values:		There are nine valid point values:
	* "TOP", "RIGHT" "BOTTOM" "LEFT": the center-points of the respective sides.		* "TOP", "RIGHT" "BOTTOM" "LEFT": the center-points of the respective sides.
	* "TOPRIGHT", "TOPLEFT", "BOTTOMLEFT", "BOTTOMRIGHT": corners of the frame rectangle.		* "TOPRIGHT", "TOPLEFT", "BOTTOMLEFT", "BOTTOMRIGHT": corners of the frame rectangle.
			* "CENTER": the center point of the frame rectangle.

	== Examples ==		== Examples ==

WoWWiki>Watchout: /* Details */ details on edges

2009-07-04T21:29:45Z

Details: details on edges

← Older revision		Revision as of 21:29, 4 July 2009
Line 32:		Line 32:
	* Behavior of this function with multiple anchors is complex. Generally, you can override points by setting them again (so repeated assignment to the "TOPLEFT" point of a frame would move the frame, unless other anchor points interfere). If you're repositioning a frame, call <code>obj:[[API Region ClearAllPoints\|ClearAllPoints]]()</code> to eliminate unwanted interactions.		* Behavior of this function with multiple anchors is complex. Generally, you can override points by setting them again (so repeated assignment to the "TOPLEFT" point of a frame would move the frame, unless other anchor points interfere). If you're repositioning a frame, call <code>obj:[[API Region ClearAllPoints\|ClearAllPoints]]()</code> to eliminate unwanted interactions.
	* Offset units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, while screen width varies with aspect ratio.		* Offset units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, while screen width varies with aspect ratio.

			=== Edge definitions ===
			The edge "points" (TOP, RIGHT, BOTTOM, LEFT) are not actual points, but... edges. To fully define a region position using edges alone, you will need to define all four (as opposed to using corners, where you only need two) edges.

			Therefore, defining an edge does not necessarily place a region relative to the center of that edge (For example, if you define TOP and RIGHT, the region will be placed at the TOPRIGHT corner). However, by default a region is "pulled" to the center if the number of points defined is insufficient.

			Example:
			Region:ClearAllPoints();
			Region:SetPoint("TOP", relativeframe);
			Region:SetWidth(100);
			Region:SetHeight(100);
			will place ''Region'' to the top center of the ''relativeframe'' while adding a
			Region:SetPoint("RIGHT", relativeframe);
			will place ''Region'' in the top right corner and now ''Region'' is fully defined.

WoWWiki>Starlightblunder: lead in, signature whitespace

2009-06-05T01:07:10Z

lead in, signature whitespace

@@ Line 1: / Line 1: @@
 {{widgetmethod}}
-Sets the current attachment point of an UI component.
+== Arguments ==
- obj:SetPoint(point [, frame] [, relativePoint] [, x [, y]]);
+; point : String - Point of the object to adjust based on the anchor.
+; relativeFrame : String/Widget - Name of, or reference to, a frame to attach obj to; defaults to the object's parent (or the screen, if object has no parent) if nil or omitted.
-== Parameters ==
+; relativePoint : String - point of the relativeFrame to attach point of obj to. If not specified, defaults to the value of point.
-=== Arguments ===
+; ofsx : Number - x-offset (negative values will move ''obj'' left, positive values will move ''obj'' right), defaults to 0 if not specified.
-; point : The point on your object to use for attaching the obj (see [[API Positions]])  (i.e.  bind the left side of your frame)
+; ofsy : Number - y-offset (negative values will move ''obj'' down, positive values will move ''obj'' up), defaults to 0 if not specified.
 == Examples ==
@@ Line 25: / Line 30: @@
 == Details ==
+* Behavior of this function with multiple anchors is complex. Generally, you can override points by setting them again (so repeated assignment to the "TOPLEFT" point of a frame would move the frame, unless other anchor points interfere). If you're repositioning a frame, call <code>obj:[[API Region ClearAllPoints|ClearAllPoints]]()</code> to eliminate unwanted interactions.
-* You will have to do a <code>obj:[[API Region ClearAllPoints|ClearAllPoints]]()</code> before using obj:SetPoint(...), if you expect the frame to actually move.
+* Offset units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, while screen width varies with aspect ratio.

WoWWiki>Moddington: /* Arguments */

2009-05-09T03:54:00Z

Arguments

← Older revision		Revision as of 03:54, 9 May 2009
Line 7:		Line 7:
	=== Arguments ===		=== Arguments ===
	; point : The point on your object to use for attaching the obj (see [[API Positions]]) (i.e. bind the left side of your frame)		; point : The point on your object to use for attaching the obj (see [[API Positions]]) (i.e. bind the left side of your frame)
	; frame : Name of, or reference to, a frame to attach obj to; or nil to anchor relative to obj's parent (if no parent exists, anchor ~~reative~~ to the whole screen).		; frame : Name of, or reference to, a frame to attach obj to; or nil to anchor relative to obj's parent (if no parent exists, anchor relative to the whole screen).
	; relativePoint : The relative point of ''frame'' to attach ''obj'' to (see [[API Positions]]); if not specified, defaults to the value of ''point'' when not specified.		; relativePoint : The relative point of ''frame'' to attach ''obj'' to (see [[API Positions]]); if not specified, defaults to the value of ''point'' when not specified.
	; x : x-offset (negative values will move ''obj'' left, positive values will move ''obj'' right), defaults to 0 if not specified.		; x : x-offset (negative values will move ''obj'' left, positive values will move ''obj'' right), defaults to 0 if not specified.
	; y : y-offset (negative values will move ''obj'' down, positive values will move ''obj'' up), defaults to 0 if not specified.		; y : y-offset (negative values will move ''obj'' down, positive values will move ''obj'' up), defaults to 0 if not specified.


	== Examples ==		== Examples ==

WoWWiki>Egingell: /* Exponential time */

2009-02-24T07:55:28Z

Exponential time

← Older revision		Revision as of 07:55, 24 February 2009
Line 34:		Line 34:

	== Exponential time ==		== Exponential time ==
			:''The validity of this claim has been questioned on the [[{{TALKPAGENAME}}\|talk page]].''

	As of approximately v1.11, creating a chain of relative positioning, where more than one SetPoint() call is done on a number of frames (i.e. the next frame has its size ''and'' position dependent on the previous one), causes '''exponential execution time''' during SetPoint() calls.		As of approximately v1.11, creating a chain of relative positioning, where more than one SetPoint() call is done on a number of frames (i.e. the next frame has its size ''and'' position dependent on the previous one), causes '''exponential execution time''' during SetPoint() calls.

WoWWiki>Sky2042: tweak header

2008-11-02T01:19:39Z

tweak header

@@ Line 29: / Line 29: @@
 * x and y units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, width varies with aspect ratio.
-* As of 1.11 or so, there seems to be an [[API Region SetPoint/Exponential time|exponential-time increase]] if you anchor chains of objects with more than one point.
+* As of 1.11 or so, there seems to be an [[API Region SetPoint#Exponential time|exponential-time increase]] if you anchor chains of objects with more than one point.
 * As of 2.2 the screen coordinates are no longer relative to the TOPLEFT instead they are relative to closest screen position which can be TOPLEFT, TOP, TOPRIGHT, LEFT, CENTER, RIGHT, BOTTOMLEFT, BOTTOM and BOTTOMRIGHT be sure to specify the relativePoint argument, wich you can get via [[API Region GetPoint|GetPoint()]], or your frames will appear at the wrong place and even off the screen.

WoWWiki>Adys: /* Details */

2008-09-14T02:36:14Z

Details

← Older revision		Revision as of 02:36, 14 September 2008
Line 25:		Line 25:
	== Details ==		== Details ==

	* You will have to do a <code>obj:[[API Region ClearAllPoints\|ClearAllPoints]]()</code> before using obj:SetPoint(...), if you expect the frame to actually move. ~~-- [[User:Maisha\|Maisha]]~~		* You will have to do a <code>obj:[[API Region ClearAllPoints\|ClearAllPoints]]()</code> before using obj:SetPoint(...), if you expect the frame to actually move.

	* x and y units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, width varies with aspect ratio.		* x and y units are relative to the screen's effective scale. WoW's screen always has a height of 768 units, width varies with aspect ratio.