# Item 'use strict' assert = require 'src/assert' utils = require 'src/utils' signal = require 'src/signal' List = require 'src/list' {isArray} = Array {emitSignal} = signal.Emitter assert = assert.scope 'Renderer.Item' module.exports = (Renderer, Impl, itemUtils) -> class Item extends itemUtils.Object @__name__ = 'Item' @__path__ = 'Renderer.Item' ## *Item* Item.New([*Component* component, *Object* options]) @New = (component, opts) -> item = new Item itemUtils.Object.initialize item, component, opts item ## *Item* Item::constructor() This is a base class for everything which is visible. constructor: -> assert.instanceOf @, Item, 'ctor ...' super() @_$ = null @_parent = null @_children = null @_previousSibling = null @_nextSibling = null @_belowSibling = null @_aboveSibling = null @_width = 0 @_height = 0 @_x = 0 @_y = 0 @_z = 0 @_visible = true @_clip = false @_scale = 1 @_rotation = 0 @_opacity = 1 @_linkUri = '' @_anchors = null @_layout = null @_document = null @_keys = null @_pointer = null @_margin = null @_classes = null @_background = null @_defaultBackground = null ### Custom properties ```nml Item { id: main property $.currentLife: 0.8 Text { text: "Life: " + main.$.currentLife } } ``` ### Custom signals ```nml Item { signal $.onPlayerCollision $.onPlayerCollision: function(){ // boom! } } ``` ## *Signal* Item::on$Change(*String* property, *Any* oldValue) itemUtils.defineProperty constructor: @ name: '$' valueConstructor: itemUtils.CustomObject ## *Signal* Item::ready() Called when the Item is ready, that is, all properties have been set and it's ready to use. ```nml Rectangle { width: 200 height: 50 color: 'green' Rectangle { width: parent.width / 2 height: parent.height / 2 color: 'yellow' onReady: function(){ console.log(this.width, this.height); // 100, 25 } } } ``` signal.Emitter.createSignal @, 'onReady' ## *Signal* Item::onAnimationFrame(*Integer* miliseconds) signal.Emitter.createSignal @, 'onAnimationFrame', do -> now = Date.now() items = [] frame = -> oldNow = now now = Date.now() ms = now - oldNow for item in items emitSignal item, 'onAnimationFrame', ms requestAnimationFrame frame requestAnimationFrame? frame (item) -> items.push item ## ReadOnly *String* Item::id ## *Object* Item::children utils.defineProperty @::, 'children', null, -> @_children ||= new ChildrenObject(@) , (val) -> assert.isArray val, '::children setter ...' @clear() for item in val val.parent = @ return ## *Signal* Item::onChildrenChange(*Item* added, *Item* removed) signal.Emitter.createSignal @, 'onChildrenChange' class ChildrenObject extends itemUtils.MutableDeepObject constructor: (ref) -> @_layout = null @_target = null @_firstChild = null @_lastChild = null @_bottomChild = null @_topChild = null @_length = 0 super ref ### ReadOnly *Item* Item::children.firstChild utils.defineProperty @::, 'firstChild', null, -> @_firstChild , null ### ReadOnly *Item* Item::children.lastChild utils.defineProperty @::, 'lastChild', null, -> @_lastChild , null ### ReadOnly *Item* Item::children.bottomChild utils.defineProperty @::, 'bottomChild', null, -> @_bottomChild , null ### ReadOnly *Item* Item::children.topChild utils.defineProperty @::, 'topChild', null, -> @_topChild , null ### ReadOnly *Integer* Item::children.length utils.defineProperty @::, 'length', null, -> @_length , null ### *Item* Item::children.layout Item used to position children items. Can be e.g. *Flow*, *Grid* etc. ### *Signal* Item::children.onLayoutChange(*Item* oldValue) itemUtils.defineProperty constructor: @ name: 'layout' defaultValue: null developmentSetter: (val) -> if val? assert.instanceOf val, Item setter: (_super) -> (val) -> if @_layout?.effectItem @_layout.parent = null @_layout.effectItem = @_layout _super.call @, val if '_effectItem' of @_ref @_ref.effectItem = if val then null else @_ref if val? ref = @_ref setFakeParent val, ref, 0 if val.effectItem val.effectItem = ref return ### *Item* Item::children.target A new child trying to be added into the item with the `children.target` defined will be added into the `target` item. ### *Signal* Item::children.onTargetChange(*Item* oldValue) itemUtils.defineProperty constructor: @ name: 'target' defaultValue: null developmentSetter: (val) -> if val? assert.instanceOf val, Item ### *Item* Item::children.get(*Integer* index) Returns an item with the given index. get: (val) -> assert.operator val, '>=', 0 assert.operator val, '<', @length if val < @length/2 sibling = @firstChild while val > 0 sibling = sibling.nextSibling val-- else sibling = @lastChild while val > 0 sibling = sibling.previousSibling val-- sibling ### *Integer* Item::children.index(*Item* value) Returns an index of the given child in the children array. index: (val) -> if @has(val) val.index else -1 ### *Boolean* Item::children.has(*Item* value) Returns `true` if the given item is an item child. has: (val) -> @_ref is val._parent ### Item::children.clear() Removes all children from the item. clear: -> while last = @last last.parent = null return ## *Item* Item::parent = `null` ## *Signal* Item::onParentChange(*Item* oldParent) setFakeParent = (child, parent, index=-1) -> child.parent = null if index >= 0 and parent.children._length < index Impl.insertItemBefore.call child, parent.children[index] else Impl.setItemParent.call child, parent child._parent = parent emitSignal child, 'onParentChange', null return updateZSiblingsForAppendedItem = (item, z, newChildren) -> child = newChildren._topChild while child if child._z <= z if item._aboveSibling = child._aboveSibling item._aboveSibling._belowSibling = item item._belowSibling = child child._aboveSibling = item return unless nextChild = child._belowSibling item._aboveSibling = child child._belowSibling = item item._belowSibling = null return child = nextChild return insertItemInImpl = (item) -> if aboveSibling = item._aboveSibling Impl.insertItemBefore.call item, aboveSibling else Impl.setItemParent.call item, item._parent return itemUtils.defineProperty constructor: @ name: 'parent' defaultValue: null setter: (_super) -> (val=null) -> old = @_parent oldChildren = old?.children valChildren = val?.children if valChildren?._target # detect whether target is a child of this item containsItem = false tmpItem = valChildren._target while tmpItem if tmpItem is @ containsItem = true break tmpItem = tmpItem._parent unless containsItem val = valChildren._target valChildren = val.children if old is val return assert.isNot @, val if pointer = @_pointer pointer.hover = pointer.pressed = false if val isnt null assert.instanceOf val, Item, '::parent setter ...' # old siblings oldPreviousSibling = @_previousSibling oldNextSibling = @_nextSibling if oldPreviousSibling isnt null oldPreviousSibling._nextSibling = oldNextSibling if oldNextSibling isnt null oldNextSibling._previousSibling = oldPreviousSibling # new siblings if val isnt null if previousSibling = @_previousSibling = valChildren.lastChild previousSibling._nextSibling = @ else @_previousSibling = null if oldNextSibling isnt null @_nextSibling = null # children if oldChildren oldChildren._length -= 1 if oldChildren.firstChild is @ oldChildren._firstChild = oldNextSibling if oldChildren.lastChild is @ oldChildren._lastChild = oldPreviousSibling if valChildren if ++valChildren._length is 1 valChildren._firstChild = @ valChildren._lastChild = @ # old z-index siblings oldBelowSibling = @_belowSibling oldAboveSibling = @_aboveSibling if oldBelowSibling isnt null oldBelowSibling._aboveSibling = oldAboveSibling if oldAboveSibling isnt null oldAboveSibling._belowSibling = oldBelowSibling # new z-index siblings @_belowSibling = @_aboveSibling = null if valChildren updateZSiblingsForAppendedItem @, @_z, valChildren # z-index children if oldChildren unless oldAboveSibling oldChildren._topChild = oldBelowSibling unless oldBelowSibling oldChildren._bottomChild = oldAboveSibling if valChildren unless @_aboveSibling valChildren._topChild = @ unless @_belowSibling valChildren._bottomChild = @ # parent @_parent = val insertItemInImpl @ `//` assert.is @nextSibling, null if val assert.is val.children.lastChild, @ assert.isDefined val.children.firstChild assert.isDefined val.children.lastChild assert.isDefined val.children.topChild assert.isDefined val.children.bottomChild if old and old.children.length is 0 assert.isNotDefined old.children.firstChild assert.isNotDefined old.children.lastChild assert.isNotDefined old.children.topChild assert.isNotDefined old.children.bottomChild `//` # signals if old isnt null emitSignal old, 'onChildrenChange', null, @ if val isnt null emitSignal val, 'onChildrenChange', @, null emitSignal @, 'onParentChange', old if oldPreviousSibling isnt null emitSignal oldPreviousSibling, 'onNextSiblingChange', @ if oldNextSibling isnt null emitSignal oldNextSibling, 'onPreviousSiblingChange', @ if val isnt null or oldPreviousSibling isnt null if previousSibling emitSignal previousSibling, 'onNextSiblingChange', null emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling if oldNextSibling isnt null emitSignal @, 'onNextSiblingChange', oldNextSibling return ## *Item* Item::previousSibling utils.defineProperty @::, 'previousSibling', null, -> @_previousSibling , (val=null) -> assert.isNot @, val if val is @_previousSibling return if val assert.instanceOf val, Item nextSibling = val._nextSibling if not nextSibling and val._parent isnt @_parent @parent = val._parent else @nextSibling = nextSibling else assert.isDefined @_parent @nextSibling = @_parent.children.firstChild assert.is @_previousSibling, val return ## *Signal* Item::onPreviousSiblingChange(*Item* oldValue) signal.Emitter.createSignal @, 'onPreviousSiblingChange' ## *Item* Item::nextSibling isNextSibling = (item, sibling) -> while item nextItem = item._nextSibling if nextItem is sibling return true item = nextItem return false isPreviousSibling = (item, sibling) -> while item prevItem = item._previousSibling if prevItem is sibling return true item = prevItem return false updateZSiblingsForInsertedItem = (item, nextSibling, z, newChildren) -> if nextSibling._z is z # simple case - the same z-index as in nextSibling if item._belowSibling = nextSibling._belowSibling item._belowSibling._aboveSibling = item item._aboveSibling = nextSibling nextSibling._belowSibling = item else # hard case - different z-indexes nextChild = newChildren._bottomChild while child = nextChild nextChild = child._aboveSibling if child._z > z or (child._z is z and isNextSibling(item, child)) item._aboveSibling = child if item._belowSibling = child._belowSibling item._belowSibling._aboveSibling = item child._belowSibling = item break unless nextChild item._aboveSibling = null item._belowSibling = child child._aboveSibling = item return utils.defineProperty @::, 'nextSibling', null, -> @_nextSibling , (val=null) -> assert.isNot @, val if val assert.instanceOf val, Item assert.isDefined val._parent else assert.isDefined @_parent if val is @_nextSibling return oldParent = @_parent oldChildren = oldParent?._children oldPreviousSibling = @_previousSibling oldNextSibling = @_nextSibling if val newParent = val._parent newChildren = newParent._children else newParent = oldParent newChildren = oldChildren # new parent @_parent = newParent # current siblings oldPreviousSibling?._nextSibling = oldNextSibling oldNextSibling?._previousSibling = oldPreviousSibling # new siblings previousSibling = previousSiblingOldNextSibling = null nextSibling = nextSiblingOldPreviousSibling = null if val if previousSibling = val._previousSibling previousSiblingOldNextSibling = previousSibling._nextSibling previousSibling._nextSibling = @ nextSibling = val nextSiblingOldPreviousSibling = nextSibling._previousSibling nextSibling._previousSibling = @ else if previousSibling = newChildren.lastChild previousSibling._nextSibling = @ @_previousSibling = previousSibling @_nextSibling = nextSibling # children if oldChildren oldChildren._length -= 1 unless oldPreviousSibling oldChildren._firstChild = oldNextSibling unless oldNextSibling oldChildren._lastChild = oldPreviousSibling newChildren._length += 1 if newChildren.firstChild is val newChildren._firstChild = @ unless val newChildren._lastChild = @ # old z-index siblings oldBelowSibling = @_belowSibling oldAboveSibling = @_aboveSibling if oldBelowSibling isnt null oldBelowSibling._aboveSibling = oldAboveSibling if oldAboveSibling isnt null oldAboveSibling._belowSibling = oldBelowSibling # new z-index siblings @_belowSibling = @_aboveSibling = null if nextSibling updateZSiblingsForInsertedItem @, nextSibling, @_z, newChildren else updateZSiblingsForAppendedItem @, @_z, newChildren # z-index children if oldChildren unless oldAboveSibling oldChildren._topChild = oldBelowSibling unless oldBelowSibling oldChildren._bottomChild = oldAboveSibling unless @_aboveSibling newChildren._topChild = @ unless @_belowSibling newChildren._bottomChild = @ # implementation insertItemInImpl @ `//` assert.is @_nextSibling, val assert.is @_parent, newParent if val assert.is @_parent, val._parent if @_previousSibling assert.is @_previousSibling._nextSibling, @ if @_nextSibling assert.is @_nextSibling._previousSibling, @ if oldPreviousSibling assert.is oldPreviousSibling._nextSibling, oldNextSibling if oldNextSibling assert.is oldNextSibling._previousSibling, oldPreviousSibling `//` # children signal if oldParent isnt newParent if oldParent emitSignal oldParent, 'onChildrenChange', null, @ emitSignal newParent, 'onChildrenChange', @, null emitSignal @, 'onParentChange', oldParent else emitSignal newParent, 'onChildrenChange', null, null # current siblings signals if oldPreviousSibling emitSignal oldPreviousSibling, 'onNextSiblingChange', @ if oldNextSibling emitSignal oldNextSibling, 'onPreviousSiblingChange', @ # new siblings signals emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling if previousSibling emitSignal previousSibling, 'onNextSiblingChange', previousSiblingOldNextSibling emitSignal @, 'onNextSiblingChange', oldNextSibling if nextSibling emitSignal nextSibling, 'onPreviousSiblingChange', nextSiblingOldPreviousSibling return ## *Signal* Item::onNextSiblingChange(*Item* oldValue) signal.Emitter.createSignal @, 'onNextSiblingChange' ## ReadOnly *Item* Item::belowSibling utils.defineProperty @::, 'belowSibling', null, -> @_belowSibling , null ## ReadOnly *Item* Item::aboveSibling utils.defineProperty @::, 'aboveSibling', null, -> @_aboveSibling , null ## *Integer* Item::index utils.defineProperty @::, 'index', null, -> index = 0 sibling = @ while sibling = sibling.previousSibling index++ index , (val) -> assert.isInteger val assert.isDefined @_parent assert.operator val, '>=', 0 assert.operator val, '<=', @_parent._children.length {children} = @parent if val >= children.length @nextSibling = null else if (valItem = children.get(val)) isnt @ @nextSibling = valItem return ## *Boolean* Item::visible = `true` Determines whether an item is visible or not. ```nml Item { width: 100 height: 100 pointer.onClick: function(){ rect.visible = !rect.visible; text.text = rect.visible ? "Click to hide" : "Click to show"; } Rectangle { id: rect anchors.fill: parent color: 'blue' } Text { id: text text: "Click to hide" anchors.centerIn: parent } } ``` ## *Signal* Item::onVisibleChange(*Boolean* oldValue) itemUtils.defineProperty constructor: @ name: 'visible' defaultValue: true implementation: Impl.setItemVisible developmentSetter: (val) -> assert.isBoolean val, '::visible setter ...' ## *Boolean* Item::clip = `false` ## *Signal* Item::onClipChange(*Boolean* oldValue) itemUtils.defineProperty constructor: @ name: 'clip' defaultValue: false implementation: Impl.setItemClip developmentSetter: (val) -> assert.isBoolean val, '::clip setter ...' ## *Float* Item::width = `0` ## *Signal* Item::onWidthChange(*Float* oldValue) itemUtils.defineProperty constructor: @ name: 'width' defaultValue: 0 implementation: Impl.setItemWidth developmentSetter: (val) -> assert.isFloat val, '::width setter ...' ## *Float* Item::height = `0` ## *Signal* Item::onHeightChange(*Float* oldValue) itemUtils.defineProperty constructor: @ name: 'height' defaultValue: 0 implementation: Impl.setItemHeight developmentSetter: (val) -> assert.isFloat val, '::height setter ...' ## *Float* Item::x = `0` ## *Signal* Item::onXChange(*Float* oldValue) itemUtils.defineProperty constructor: @ name: 'x' defaultValue: 0 implementation: Impl.setItemX developmentSetter: (val) -> assert.isFloat val, '::x setter ...' ## *Float* Item::y = `0` ## *Signal* Item::onYChange(*Float* oldValue) itemUtils.defineProperty constructor: @ name: 'y' defaultValue: 0 implementation: Impl.setItemY developmentSetter: (val) -> assert.isFloat val, '::y setter ...' ## *Float* Item::z = `0` ## *Signal* Item::onZChange(*Float* oldValue) itemUtils.defineProperty constructor: @ name: 'z' defaultValue: 0 developmentSetter: (val) -> assert.isFloat val, '::z setter ...' setter: (_super) -> (val) -> oldVal = @_z if oldVal is val return _super.call @, val unless parent = @_parent return children = parent._children oldAboveSibling = @_aboveSibling oldBelowSibling = @_belowSibling # new siblings if val > oldVal nextChild = @_aboveSibling while child = nextChild nextChild = child._aboveSibling if child._z > val or (child._z is val and isNextSibling(@, child)) if oldAboveSibling is child break @_aboveSibling = child if @_belowSibling = child._belowSibling @_belowSibling._aboveSibling = @ child._belowSibling = @ break unless nextChild @_aboveSibling = null @_belowSibling = child child._aboveSibling = @ if val < oldVal prevChild = @_belowSibling while child = prevChild prevChild = child._belowSibling if child._z < val or (child._z is val and isPreviousSibling(@, child)) if oldBelowSibling is child break @_belowSibling = child aboveSibling = child._aboveSibling if @_aboveSibling = child._aboveSibling @_aboveSibling._belowSibling = @ child._aboveSibling = @ break unless prevChild @_belowSibling = null @_aboveSibling = child child._belowSibling = @ # clean old siblings if oldBelowSibling and oldBelowSibling isnt @_belowSibling oldBelowSibling._aboveSibling = oldAboveSibling if oldAboveSibling and oldAboveSibling isnt @_aboveSibling oldAboveSibling._belowSibling = oldBelowSibling # new children if @_belowSibling if children._bottomChild is @ children._bottomChild = oldAboveSibling else children._bottomChild = @ if @_aboveSibling if children._topChild is @ children._topChild = oldBelowSibling else children._topChild = @ # implementation if oldAboveSibling isnt @_aboveSibling insertItemInImpl @ `//` assert.isNot @_belowSibling, @ assert.isNot @_belowSibling?._belowSibling, @ assert.isNot @_aboveSibling, @ assert.isNot @_aboveSibling?._aboveSibling, @ if @_belowSibling assert.is @_belowSibling._aboveSibling, @ if @_aboveSibling assert.is @_aboveSibling._belowSibling, @ `//` return ## *Float* Item::scale = `1` ## *Signal* Item::onScaleChange(*Float* oldValue) itemUtils.defineProperty constructor: @ name: 'scale' defaultValue: 1 implementation: Impl.setItemScale developmentSetter: (val) -> assert.isFloat val, '::scale setter ...' ## *Float* Item::rotation = `0` ```nml Rectangle { width: 100 height: 100 color: 'red' rotation: Math.PI / 4 } ``` ## *Signal* Item::onRotationChange(*Float* oldValue) itemUtils.defineProperty constructor: @ name: 'rotation' defaultValue: 0 implementation: Impl.setItemRotation developmentSetter: (val) -> assert.isFloat val, '::rotation setter ...' ## *Float* Item::opacity = `1` ## *Signal* Item::onOpacityChange(*Float* oldValue) itemUtils.defineProperty constructor: @ name: 'opacity' defaultValue: 1 implementation: Impl.setItemOpacity developmentSetter: (val) -> assert.isFloat val, '::opacity setter ...' ## *String* Item::linkUri = `''` Points to the URI which will be used when user clicks on this item. ## *Signal* Item::onLinkUriChange(*String* oldValue) itemUtils.defineProperty constructor: @ name: 'linkUri' defaultValue: '' implementation: Impl.setItemLinkUri developmentSetter: (val) -> assert.isString val, '::linkUri setter ...' ## *Item* Item::background An item used as a background for the item. By default, background is filled to his parent. ## *Signal* Item::onBackgroundChange(*Item* oldValue) defaultBackgroundClass = do -> ext = Renderer.Class.New new Renderer.Component ext.priority = -1 ext.changes.setAttribute 'anchors.fill', ['parent'] ext createDefaultBackground = (parent) -> rect = Renderer.Rectangle.New parent._component ext = defaultBackgroundClass.clone parent._component ext.target = rect ext.enable() rect itemUtils.defineProperty constructor: @ name: 'background' defaultValue: null developmentSetter: (val) -> if val? assert.instanceOf val, Item getter: (_super) -> -> unless @_background @_defaultBackground ||= createDefaultBackground @ @background = @_defaultBackground _super.call @ setter: (_super) -> (val) -> val ||= @_defaultBackground oldVal = @_background if val is oldVal return if oldVal and oldVal._parent is @ oldVal._parent = null emitSignal oldVal, 'onParentChange', @ if val oldParent = val._parent if val._previousSibling or val._nextSibling val.parent = null val._parent = @ emitSignal val, 'onParentChange', oldParent Impl.setItemBackground.call @, val _super.call @, val ## Item::overlap(*Item* item) Returns `true` if two items overlaps. overlap: (item) -> assert.instanceOf item, Item Impl.doItemOverlap.call @, item @createSpacing = require('./item/spacing') Renderer, Impl, itemUtils, Item @createAlignment = require('./item/alignment') Renderer, Impl, itemUtils, Item @createAnchors = require('./item/anchors') Renderer, Impl, itemUtils, Item @createLayout = require('./item/layout') Renderer, Impl, itemUtils, Item @createMargin = require('./item/margin') Renderer, Impl, itemUtils, Item @createPointer = require('./item/pointer') Renderer, Impl, itemUtils, Item @createKeys = require('./item/keys') Renderer, Impl, itemUtils, Item @createDocument = require('./item/document') Renderer, Impl, itemUtils, Item ## *Item.Anchors* Item::anchors ## *Signal* Item::onAnchorsChange(*String* property, *Array* oldValue) @createAnchors @ ## *Item.Layout* Item::layout ## *Signal* Item::onLayoutChange(*String* property, *Any* oldValue) @createLayout @ ## *Item.Pointer* Item::pointer @Pointer = @createPointer @ ## *Item.Margin* Item::margin ## *Signal* Item::onMarginChange(*String* property, *Any* oldValue) @createMargin @ ## *Item.Keys* Item::keys @Keys = @createKeys @ ## *Item.Document* Item::document @Document = @createDocument @ Item