getpos

uiz_getpos_ x/y

This a generic set of functions used to calculate the position or size of an object. An object calls this function to know it's own size.

functions

• pos = uiz_getposx/y(value, valueType[px dp fc]): This function changes a position/distance from a value and value type pair to a usable single pixel value. uiz_getposx(1,fc) will return the objects width and uiz_getposx(0.5,fc) half of the parent's objects width. Useful if you are programming your own uiZ objects. Can only be called from a uiZ object.

  • pos: A value in pixels, coming from the converted value and valueType. This could be interpreted as a position or as a size.
  • value: What position/length should be calculated in combination with the value type
  • valueType: What type of value the first value is. This accepts:
    • px
    • pxmin
    • dp
    • dpmin
    • fc
    • fcx
    • fcy
    • fcm
    • fcmin
    • fcmax

• pos = uiz_getposx/y_self(value, valueType[px dp fc]): Gets a value using getposx/y but uses it's own object as a reference instead of it's parent. uiz_getposx_self(1,fc) will the objects width and uiz_getposx_self(0.5,fc) half of the objects width. Useful if you are programming your own uiz objects. Can only be called from a uiZ object.

  • pos: A value in pixels, coming from the converted value and valueType. This could be interpreted as a position or as a size.
  • value: What position/length should be calculated in combination with the value type
  • valueType: What type of value the first value is. This accepts:
    • px
    • pxmin
    • dp
    • dpmin
    • fc
    • fcx
    • fcy
    • fcm
    • fcmin
    • fcmax

• value = uiz_pixelsToValX/Y(valueType, valueInPx, instanceid): Script that takes a pos in pixels (as output by uiz_getpos) and reverts it back to value of given type.

  • value: The value of the provided pixel value in the newly provided unit (valueType).
  • valueType: what type you want to convert to. px, dp, fc, fcx, fcy and fcm are supported.
  • value in px: the value in pixels you want to convert from.
  • instanceid: The object to reverse the values for.

Value types

If you see references to the parent's width of parent's height of an object, those will refer to the inner width and inner height of the parent. The inner width means the width of the object minus the left and right inner margins (which are the framemargins and background margins)

You can find alternative explanations of these values here

px

This is the simpelest type and simply returns the given value, because it's already in pixel form. If you give a value of 3, the size/position you are trying to get is 3 pixels wide.

pxmin

The given pixel value subtracted from the parent's width (for the x function) or height (for the y function). This is useful if you want to put something inside an object with a pixel margin.

dp

Dp stands for "Density pixels". One dp equals 1 inch or 2.54 cm in real life.

dpmin

The given dp value subtracted from the parent's width (for the x function) or height (for the y function). This is useful if you want to put something inside an object with a dp margin.

fc

This function takes the parent's width (for the x function) or height (for the y function) and multiplies it by the value. You can make your object 50% of it's parent's size by setting a value of .5 and a valuetype of fc.

fcx

This function does the same as fc, but always takes the parent's width no matter if the x or y variant of this function is called.

fcy

This function does the same as fc, but always takes the parent's height no matter if the x or y variant of this function is called.

fcm

This function calculates both the fcx value and fcy value and takes the average between those values.

fcmin

This function looks at the parent's width and height. If the height is smaller than the width fcy is used, else fcx is used.

fcmax

This function looks at the parent's width and height. If the height is larger than the width fcy is used, else fcx is used.