Fix-width sizer

Introduction¶

Layout children game objects into lines.

Author: Rex
Game object

Live demos¶

Usage¶

Sample code

Install plugin¶

Load minify file¶

Load plugin (minify file) in preload stage

scene.load.scenePlugin('rexuiplugin', 'https://raw.githubusercontent.com/rexrainbow/phaser3-rex-notes/master/dist/rexuiplugin.min.js', 'rexUI', 'rexUI');

Add sizer object

var sizer = scene.rexUI.add.fixWidthSizer(config);

Import plugin¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Install plugin in configuration of game

import UIPlugin from 'phaser3-rex-plugins/templates/ui/ui-plugin.js';
var config = {
    // ...
    plugins: {
        scene: [{
            key: 'rexUI',
            plugin: UIPlugin,
            mapping: 'rexUI'
        },
        // ...
        ]
    }
    // ...
};
var game = new Phaser.Game(config);

Add sizer object

var sizer = scene.rexUI.add.fixWidthSizer(config);

Import class¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Import class

import { FixWidthSizer } from 'phaser3-rex-plugins/templates/ui/ui-components.js';

Add sizer object

var sizer = new FixWidthSizer(scene, config);
scene.add.existing(sizer);

Add sizer object¶

var sizer = scene.rexUI.add.fixWidthSizer({
    // x: 0,
    // y: 0,
    // anchor: undefined,    
    // width: undefined,
    // height: undefined,
    // origin: 0.5
    // originX:
    // originY:
    // orientation: 0,

    // space: {
    //     left: 0, right: 0, top: 0, bottom: 0,
    //     item: 0, line: 0, 
    //     indentLeftOdd: 0, indentLeftEven: 0,
    // },

    // rtl: false,
    // align: 0,

    // name: '',
    // draggable: false,
    // sizerEvents: false,
    // enableLayer: false,
});

or

var sizer = scene.rexUI.add.fixWidthSizer(x, y, {
    // width: 2,
    // height: 2
    // orientation: 0,

    // space: {
    //     left: 0, right: 0, top: 0, bottom: 0,
    //     item: 0, line: 0,
    //     indentLeftOdd: 0, indentLeftEven: 0,
    //     indentTopOdd: 0, indentTopEven: 0,
    // },

    // rtl: false,
    // align: 0,

    // name: '',
    // draggable: false
});

or

var sizer = scene.rexUI.add.fixWidthSizer(x, y, width, height, {
    // orientation: 0,
    // space: {
    //     left: 0, right: 0, top: 0, bottom: 0,
    //     item: 0, line: 0
    // },

    // rtl: false,
    // align: 0,

    // name: '',
    // draggable: false
});

x, y : Position of this object, it is valid when this object is the top object.
anchor : See anchor.
- left, right, centerX, x, top, bottom, centerY, y, aspectRatio : Position based on visible window, which composed of
  - Percentage of visible width/height : 'p%', p: 0 ~ 100.
    - 'left'(=0%), 'center'(=50%), 'right'(=100%)
    - 'top'(=0%), 'center'(=50%), 'bottom'(=100%)
  - Offset : '+n', or '-n'.
- width, height : Set size (invoke onResizeCallback) based on visible window, which composed of
  - Percentage of visible width/height : 'p%', p: 0 ~ 100.
  - Padding : '+n', or '-n'.
- aspectRatio :
  - undefined, or false : Does not keep aspect ratio. Default behavior.
  - true : Use the current width and height as the aspect ratio.
  - A number : Use given number as the aspect ratio.
- onResizeCallback : A default resize callback will be assigned interanlly.
width, height : Minimum width, minimum height.
origin, originX, originY : Set origin of this sizer. Default value is (0.5, 0.5).
orientation : Orientation of the sizer.
- 'left-to-right', 'horizontal','h', 'x', or 0 : Arrange game objects from left ot right. Default value is 0.
- 'top-to-bottom', 'vertical','v', 'y', or 1 : Arrange game objects from top to bottom.
space : Pads spaces
- space.left, space.right, space.top, space.bottom : Space of bounds.
- space.item : Space betwen each child of a line.
- space.line : Space between each line.
- space.indentLeftOdd, space.indentLeftEven : Indent at each odd/even line.
- space.indentTopOdd, space.indentTopEven : Indent at each odd/even item.
rtl : Order of children in each line.
- false : Place children from left-to-right/top-to-bottom, default value.
- true : Place children from right-to-left/bottom-to-top.
align : Align children of a line.
- 0, 'left' : Align children of a line to left/top side.
- 1, 'right' : Align children of a line to right/bottom side.
- 2, 'center' : Align children of a line to ceter.
- 3, 'justify', 'justify-left' : If remainder space is less or equal than 25%, then justify children. Else align children to left/top side.
- 4, 'justify-right' : If remainder space is less or equal than 25%, then justify children. Else align children to right/bottom side.
- 5, 'justify-cneter' : If remainder space is less or equal than 25%, then justify children. Else align children to center.
name : Set name of this game object.
draggable : Set true to drag top-most object.
sizerEvents : Set true to fire sizer events. Default value is false.
enableLayer :
- false : Add child game objects into scene's display list. Default behavior.
- true : Add child game objects into an internal layer game object. See also.

Custom class¶

Define class

class MySizer extends RexPlugins.UI.FixWidthSizer {
    constructor(scene, x, y, minWidth, minHeight, orientation, space, config) {
        super(scene, x, y, minWidth, minHeight, orientation, space, config);
        // ...
        scene.add.existing(this);
    }
    // ...
}

Create instance

var sizer = new MySizer(scene, x, y, minWidth, minHeight, orientation, space, config);

Add background¶

sizer.addBackground(child);

or

sizer.addBackground(child, {left: 0, right: 0, top: 0, bottom: 0}, key);

left, right, top, bottom : Extra padded space. Default is 0.
key : Add this child into childMap, which could be read back by sizer.getElement(key).
- undefined : Don't add this child. Default value.

Add child¶

Add a game obejct to sizer

sizer.add(child);

or

sizer.add(child,
    {
        padding: {left: 0, right: 0, top: 0, bottom: 0},
        key: undefined,
        index: undefined,
        offsetX: 0,
        offsetY: 0,
        offsetOriginX: 0,
        offsetOriginY: 0,
    }
);

or

sizer.add(child, padding, key, index);

child : A game object
padding : Add space between bounds. Default is 0.
- A number for left/right/top/bottom bounds
- Or a plain object
```
{
    left: 0,
    right: 0,
    top: 0,
    bottom: 0
}
```
key : Add this child into childMap, which could be read back by sizer.getElement(key).
- undefined : Don't add this child. Default value.
- items : Reserved key, for all children item.
offsetX, offsetOriginX : Apply offset offsetX + offsetOriginY * width to x coordinate after alignment.
offsetY, offsetOriginY : Apply offset offsetY + offsetOriginY * height to y coordinate after alignment.
index : Insert child to.
- undefined : Insert child at last.

Add multiple¶

sizer.add(gameObjects, config);

gameObjects : Array of child game objects
config : See config of add-child

Insert child¶

sizer.insert(index, child, 
    {
        padding: {left: 0, right: 0, top: 0, bottom: 0},
        key: undefined,
    }
);

or

sizer.insert(index, child, padding, key);

Insert at position¶

sizer.insertAtPosition(x, y, 
    child, 
    {
        padding: {left: 0, right: 0, top: 0, bottom: 0},
        key: undefined,
    }
);

or

sizer.insertAtPosition(x, y, index, child, padding, key);

Add new line¶

sizer.addNewLine();

Layout children¶

Arrange position of all children.

sizer.layout();

Hide¶

Set invisible, won't layout it
```
sizer.hide();
```
or
```
sizer.hide(gameObject);
```
Set visible, will layout it
```
sizer.show();
```
or
```
sizer.show(gameObject);
```

Remove child¶

Remove a child
```
sizer.remove(child);
```
Remove and destroy a child
```
sizer.remove(child, true);
```
Remove all children
```
sizer.removeAll();
```
Remove and destroy all children
```
sizer.removeAll(true);
```
Remove all children and backgrounds
```
sizer.clear();
```
Remove and destroy all children and backgrounds
```
sizer.clear(true);
```
Remove from parent sizer
```
sizer.removeFromParentSizer();
```

Sort children¶

Sort by data
```
sizer.sortChildrenByData(key, descending).layout();
```
- key : Data key
- descending :
  - true : Descending order
  - false : Ascending order, default behavior.
Sort by property of child
```
sizer.sortChildrenByProperty(key, descending).layout();
```
- key : Property key
- descending :
  - true : Descending order
  - false : Ascending order, default behavior.

Sort by callback

sizer.sortChildren(function(childA, childB){
    // var valueA = childA.getData(key);
    // var valueB = childB.getData(key);
    // return valueB - valueA
}).layout();

childA, childB : 2 children of this size

Get element¶

Get element
- All children items
```
var items = sizer.getElement('items');
```

Get by name

var gameObject = sizer.getElement('#' + name);
// var gameObject = sizer.getElement('#' + name, recursive);

or

var gameObject = sizer.getByName(name);
// var gameObject = sizer.getByName(name, recursive);

recursive : Set true to search all children recursively.

Get child index¶

var index = sizer.getChildIndex(child);

index : A number, or null.

Other properties¶

See base-sizer object.