Optionalwidth: numberThe width of the Size component. Default 0.
Optionalheight: numberThe height of the Size component. If not given, it will use the width. Default width.
OptionalaspectMode: numberThe aspect mode of the Size component. Defaults to 0, no mode. Default 0.
Optionalparent: anyThe parent of this Size component. Can be any object with public width and height properties. Dimensions are clamped to keep them within the parent bounds where possible. Default null.
ReadonlyaspectThe aspect mode this Size component will use when calculating its dimensions.
This property is read-only. To change it use the setAspectMode method.
ReadonlyaspectThe proportional relationship between the width and height.
This property is read-only and is updated automatically when either the width or height properties are changed,
depending on the aspect mode.
The height of this Size component.
This value is clamped to the range specified by minHeight and maxHeight, if enabled.
A height can never be less than zero.
Changing this value will automatically update the width if the aspect ratio lock is enabled.
You can also use the setHeight and getHeight methods.
ReadonlymaxThe maximum allowed height.
This value is read-only. To change it see the setMax method.
ReadonlymaxThe maximum allowed width.
This value is read-only. To change it see the setMax method.
ReadonlyminThe minimum allowed height.
Cannot be less than zero.
This value is read-only. To change it see the setMin method.
ReadonlyminThe minimum allowed width.
Cannot be less than zero.
This value is read-only. To change it see the setMin method.
ReadonlysnapA Vector2 containing the horizontal and vertical snap values, which the width and height are snapped to during resizing.
By default this is disabled.
This property is read-only. To change it see the setSnap method.
The width of this Size component.
This value is clamped to the range specified by minWidth and maxWidth, if enabled.
A width can never be less than zero.
Changing this value will automatically update the height if the aspect ratio lock is enabled.
You can also use the setWidth and getWidth methods.
Static ReadonlyENVELOPThe width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.
Static ReadonlyFITThe width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.
Static ReadonlyHEIGHT_The width is automatically adjusted based on the height.
Static ReadonlyNONEDo not make the size fit the aspect ratio. Change the ratio when the size changes.
Static ReadonlyWIDTH_The height is automatically adjusted based on the width.
The current width and height are adjusted to fit inside the given dimensions, while keeping the aspect ratio.
If fit is true there may be some space inside the target area which is not covered if its aspect ratio differs.
If fit is false the size may extend further out than the target area if the aspect ratios differ.
If this Size component has a parent set, then the width and height passed to this method will be clamped so it cannot exceed that of the parent.
Optionalwidth: numberThe new width of the Size component. Default 0.
Optionalheight: numberThe new height of the Size component. If not given, it will use the width value.
Optionalfit: booleanPerform a fit (true) constraint, or an envelop (false) constraint. Default true.
Destroys this Size component.
This clears the local properties and any parent object, if set.
A destroyed Size component cannot be re-used.
The current width and height are adjusted so that they fully envelope the given dimensions, while keeping the aspect ratio.
The size may extend further out than the target area if the aspect ratios differ.
If this Size component has a parent set, then the values are clamped so that it never exceeds the parent on the longest axis.
Optionalwidth: numberThe new width of the Size component. Default 0.
Optionalheight: numberThe new height of the Size component. If not given, it will use the width value.
The current width and height are adjusted to fit inside the given dimensions, while keeping the aspect ratio.
There may be some space inside the target area which is not covered if its aspect ratio differs.
If this Size component has a parent set, then the width and height passed to this method will be clamped so it cannot exceed that of the parent.
Optionalwidth: numberThe new width of the Size component. Default 0.
Optionalheight: numberThe new height of the Size component. If not given, it will use the width value.
Takes a new height and passes it through the min/max clamp and then checks it doesn't exceed the parent height.
The value to clamp and check.
OptionalcheckParent: booleanCheck the given value against the parent, if set. Default true.
Takes a new width and passes it through the min/max clamp and then checks it doesn't exceed the parent width.
The value to clamp and check.
OptionalcheckParent: booleanCheck the given value against the parent, if set. Default true.
Sets a new width and height for this Size component and updates the aspect ratio based on them.
It doesn't change the aspectMode and still factors in size limits such as the min max and parent bounds.
The new width of the Size component.
Optionalheight: numberThe new height of the Size component. If not given, it will use the width. Default width.
Sets the aspect mode of this Size component.
The aspect mode controls what happens when you modify the width or height properties, or call setSize.
It can be a number from 0 to 4, or a Size constant:
Calling this method automatically recalculates the width and the height, if required.
Optionalvalue: numberThe aspect mode value. Default 0.
Sets a new aspect ratio, overriding what was there previously.
It then calls setSize immediately using the current dimensions.
The new aspect ratio.
Sets the values of this Size component to the element.style.width and height
properties of the given DOM Element. The properties are set as px values.
The DOM Element to set the CSS style on.
Sets the height of this Size component.
Depending on the aspect mode, changing the height may also update the width and aspect ratio.
The new height of the Size component.
Set the maximum width and height values this Size component will allow.
Setting this will automatically adjust both the width and height properties to ensure they are within range.
Note that based on the aspect mode, and if this Size component has a parent set or not, the maximums set here can be exceed in some situations.
Optionalwidth: numberThe maximum allowed width of the Size component. Default Number.MAX_VALUE.
Optionalheight: numberThe maximum allowed height of the Size component. If not given, it will use the width. Default width.
Set the minimum width and height values this Size component will allow.
The minimum values can never be below zero, or greater than the maximum values.
Setting this will automatically adjust both the width and height properties to ensure they are within range.
Note that based on the aspect mode, and if this Size component has a parent set or not, the minimums set here can be exceed in some situations.
Optionalwidth: numberThe minimum allowed width of the Size component. Default 0.
Optionalheight: numberThe minimum allowed height of the Size component. If not given, it will use the width. Default width.
Sets, or clears, the parent of this Size component.
To clear the parent call this method with no arguments.
The parent influences the maximum extents to which this Size component can expand, based on the aspect mode:
NONE - The parent clamps both the width and height. WIDTH_CONTROLS_HEIGHT - The parent clamps just the width. HEIGHT_CONTROLS_WIDTH - The parent clamps just the height. FIT - The parent clamps whichever axis is required to ensure the size fits within it. ENVELOP - The parent is used to ensure the size fully envelops the parent.
Calling this method automatically calls setSize.
Optionalparent: anySets the parent of this Size component. Don't provide a value to clear an existing parent.
Sets the width and height of this Size component based on the aspect mode.
If the aspect mode is 'none' then calling this method will change the aspect ratio, otherwise the current aspect ratio is honored across all other modes.
If snapTo values have been set then the given width and height are snapped first, prior to any further adjustment via min/max values, or a parent.
If minimum and/or maximum dimensions have been specified, the values given to this method will be clamped into that range prior to adjustment, but may still exceed them depending on the aspect mode.
If this Size component has a parent set, and the aspect mode is fit or envelop, then the given sizes will
be clamped to the range specified by the parent.
Optionalwidth: numberThe new width of the Size component. Default 0.
Optionalheight: numberThe new height of the Size component. If not given, it will use the width. Default width.
By setting snap values, when this Size component is modified its dimensions will automatically be snapped to the nearest grid slice, using floor. For example, if you have snap value of 16, and the width changes to 68, then it will snap down to 64 (the closest multiple of 16 when floored)
Note that snapping takes place before adjustments by the parent, or the min / max settings. If these values are not multiples of the given snap values, then this can result in un-snapped dimensions.
Call this method with no arguments to reset the snap values.
Calling this method automatically recalculates the width and the height, if required.
OptionalsnapWidth: numberThe amount to snap the width to. If you don't want to snap the width, pass a value of zero. Default 0.
OptionalsnapHeight: numberThe amount to snap the height to. If not provided it will use the snapWidth value. If you don't want to snap the height, pass a value of zero. Default snapWidth.
Sets the width of this Size component.
Depending on the aspect mode, changing the width may also update the height and aspect ratio.
The new width of the Size component.
Returns a string representation of this Size component.
The Size component allows you to set
widthandheightproperties and define the relationship between them.The component can automatically maintain the aspect ratios between the two values, and clamp them to a defined min-max range. You can also control the dominant axis. When dimensions are given to the Size component that would cause it to exceed its min-max range, the dimensions are adjusted based on the dominant axis.