diff --git a/src/FancyButton.ts b/src/FancyButton.ts index da998dc4..57892ad9 100644 --- a/src/FancyButton.ts +++ b/src/FancyButton.ts @@ -1,3 +1,4 @@ +/* eslint-disable max-len */ import { Container, isMobile, NineSliceSprite, ObservablePoint, Rectangle, Texture, Ticker } from 'pixi.js'; import { Group, Tween } from 'tweedle.js'; import { ButtonContainer } from './Button'; @@ -63,6 +64,8 @@ export type ButtonOptions = ViewsInput & { iconOffset?: Offset; defaultTextScale?: Pos | number; defaultIconScale?: Pos | number; + defaultTextAnchor?: Pos | number; + defaultIconAnchor?: Pos | number; animations?: StateAnimations; nineSliceSprite?: [number, number, number, number]; ignoreRefitting?: boolean; @@ -144,6 +147,12 @@ export class FancyButton extends ButtonContainer /** Base icon scaling to take into account when fitting inside the button */ protected _defaultIconScale: Pos = { x: 1, y: 1 }; + /** Base text anchor to take into account when fitting and placing inside the button */ + protected _defaultTextAnchor: Pos = { x: 0.5, y: 0.5 }; + + /** Base icon anchor to take into account when fitting and placing inside the button */ + protected _defaultIconAnchor: Pos = { x: 0.5, y: 0.5 }; + /** * Creates a button with a lot of tweaks. * @param {object} options - Button options. @@ -162,6 +171,8 @@ export class FancyButton extends ButtonContainer * when all animations scales will be applied to the inner view. * @param {number} options.defaultTextScale - Base text scaling to take into account when fitting inside the button. * @param {number} options.defaultIconScale - Base icon scaling to take into account when fitting inside the button. + * @param {number} options.defaultTextAnchor - Base text anchor to take into account when fitting and placing inside the button. + * @param {number} options.defaultIconAnchor - Base icon anchor to take into account when fitting and placing inside the button. * @param {number} options.anchor - Anchor point of the button. * @param {number} options.anchorX - Horizontal anchor point of the button. * @param {number} options.anchorY - Vertical anchor point of the button. @@ -185,6 +196,8 @@ export class FancyButton extends ButtonContainer iconOffset, defaultTextScale: textScale, defaultIconScale: iconScale, + defaultTextAnchor: textAnchor, + defaultIconAnchor: iconAnchor, scale, anchor, anchorX, @@ -206,6 +219,8 @@ export class FancyButton extends ButtonContainer this.iconOffset = iconOffset; this.defaultTextScale = textScale; this.defaultIconScale = iconScale; + this.defaultTextAnchor = textAnchor; + this.defaultIconAnchor = iconAnchor; this.scale.set(scale ?? 1); if (animations) @@ -323,7 +338,6 @@ export class FancyButton extends ButtonContainer this._defaultTextScale = { x, y }; } - this._views.textView.anchor.set(0); this.innerView.addChild(this._views.textView); this.adjustTextView(this.state); @@ -395,6 +409,7 @@ export class FancyButton extends ButtonContainer if (!this.text) return; const activeView = this.getStateView(this.state); + const { x: anchorX, y: anchorY } = this._defaultTextAnchor; if (activeView) { @@ -409,7 +424,7 @@ export class FancyButton extends ButtonContainer this._views.textView.y = activeView.y + (activeView.height / 2); } - this._views.textView.anchor.set(0.5); + this._views.textView.anchor.set(anchorX, anchorY); this.setOffset(this._views.textView, state, this.textOffset); } @@ -437,12 +452,24 @@ export class FancyButton extends ButtonContainer this._views.iconView.scale.set(this._defaultIconScale.x, this._defaultIconScale.y); } + const { x: anchorX, y: anchorY } = this._defaultIconAnchor; + fitToView(activeView, this._views.iconView, this.padding, false); - (this._views.iconView as Sprite).anchor?.set(0); + if ('anchor' in this._views.iconView) + { + (this._views.iconView.anchor as ObservablePoint).set(anchorX, anchorY); + } + else + { + this._views.iconView.pivot.set( + anchorX * (this._views.iconView.width / this._views.iconView.scale.x), + anchorY * (this._views.iconView.height / this._views.iconView.scale.y) + ); + } - this._views.iconView.x = activeView.x + (activeView.width / 2) - (this._views.iconView.width / 2); - this._views.iconView.y = activeView.y + (activeView.height / 2) - (this._views.iconView.height / 2); + this._views.iconView.x = activeView.x + (activeView.width / 2); + this._views.iconView.y = activeView.y + (activeView.height / 2); this.setOffset(this._views.iconView, state, this.iconOffset); } @@ -888,6 +915,50 @@ export class FancyButton extends ButtonContainer return this.defaultIconScale; } + /** + * Sets the base anchor for the text view to take into account when fitting and placing inside the button. + * @param {Pos | number} anchor - base anchor of the text view. + */ + set defaultTextAnchor(anchor: Pos | number) + { + if (anchor === undefined) return; + // Apply to the options so that the manual anchor is prioritized. + this.options.defaultTextAnchor = anchor; + const isNumber = typeof anchor === 'number'; + + this._defaultTextAnchor.x = isNumber ? anchor : anchor.x ?? 1; + this._defaultTextAnchor.y = isNumber ? anchor : anchor.y ?? 1; + this.adjustTextView(this.state); + } + + /** Returns the text view base anchor. */ + get defaultTextAnchor(): Pos + { + return this.defaultTextAnchor; + } + + /** + * Sets the base anchor for the icon view to take into account when fitting and placing inside the button. + * @param {Pos | number} anchor - base anchor of the icon view. + */ + set defaultIconAnchor(anchor: Pos | number) + { + if (anchor === undefined) return; + // Apply to the options so that the manual anchor is prioritized. + this.options.defaultIconAnchor = anchor; + const isNumber = typeof anchor === 'number'; + + this._defaultIconAnchor.x = isNumber ? anchor : anchor.x ?? 1; + this._defaultIconAnchor.y = isNumber ? anchor : anchor.y ?? 1; + this.adjustIconView(this.state); + } + + /** Returns the icon view base anchor. */ + get defaultIconAnchor(): Pos + { + return this.defaultIconAnchor; + } + /** * Sets width of a FancyButtons state views. * If nineSliceSprite is set, then width will be set to nineSliceSprites of a views. diff --git a/src/ScrollBox.ts b/src/ScrollBox.ts index 8e7defd9..5ba3849b 100644 --- a/src/ScrollBox.ts +++ b/src/ScrollBox.ts @@ -28,6 +28,8 @@ export type ScrollBoxOptions = { globalScroll?: boolean; shiftScroll?: boolean; proximityRange?: number; + proximityDebounce?: number; + disableProximityCheck?: boolean; } & Omit; type ProximityEventData = { @@ -36,9 +38,6 @@ type ProximityEventData = { inRange: boolean; }; -const scrollerBounds = new Bounds(); -const itemBounds = new Bounds(); - /** * Scrollable view, for arranging lists of Pixi container-based elements. * @@ -89,9 +88,10 @@ export class ScrollBox extends Container protected isOver = false; protected proximityRange: number; - protected proximityCache: boolean[] = []; - private lastScrollX!: number | null; - private lastScrollY!: number | null; + protected proximityStatusCache: boolean[] = []; + protected lastScrollX!: number | null; + protected lastScrollY!: number | null; + protected proximityCheckFrameCounter = 0; public onProximityChange = new Signal<(data: ProximityEventData) => void>(); /** @@ -202,7 +202,7 @@ export class ScrollBox extends Container /** Remove all items from a scrollable list. */ removeItems() { - this.proximityCache.length = 0; + this.proximityStatusCache.length = 0; this.list.removeChildren(); } @@ -228,7 +228,7 @@ export class ScrollBox extends Container child.eventMode = 'static'; this.list.addChild(child); - this.proximityCache.push(false); + this.proximityStatusCache.push(false); if (!this.options.disableDynamicRendering) { @@ -248,15 +248,16 @@ export class ScrollBox extends Container removeItem(itemID: number) { this.list.removeItem(itemID); - this.proximityCache.splice(itemID, 1); + this.proximityStatusCache.splice(itemID, 1); this.resize(); } /** * Checks if the item is visible or scrolled out of the visible part of the view.* Adds an item to a scrollable list. * @param {Container} item - item to check. + * @param padding - proximity padding to consider the item visible. */ - isItemVisible(item: Container): boolean + isItemVisible(item: Container, padding = 0): boolean { const isVertical = this.options.type === 'vertical' || !this.options.type; let isVisible = false; @@ -266,10 +267,7 @@ export class ScrollBox extends Container { const posY = item.y + list.y; - if ( - posY + item.height + this.list.bottomPadding >= 0 - && posY - this.list.topPadding <= this.options.height - ) + if (posY + item.height >= -padding && posY <= this.options.height + padding) { isVisible = true; } @@ -278,7 +276,7 @@ export class ScrollBox extends Container { const posX = item.x + list.x; - if (posX + item.width >= 0 && posX <= this.options.width) + if (posX + item.width >= -padding && posX <= this.options.width + padding) { isVisible = true; } @@ -758,43 +756,28 @@ export class ScrollBox extends Container this.list[type] = this._trackpad[type]; } - if (this._trackpad.x !== this.lastScrollX || this._trackpad.y !== this.lastScrollY) + if (!this.options.disableProximityCheck && ( + this._trackpad.x !== this.lastScrollX || this._trackpad.y !== this.lastScrollY + )) { - /** - * Wait a frame to ensure that the transforms of the scene graph are up-to-date. - * Since we are skipping this step on the 'getBounds' calls for performance's sake, - * this is necessary to ensure that the bounds are accurate. - */ - requestAnimationFrame(() => this.items.forEach((item, index) => this.checkItemProximity(item, index))); - this.lastScrollX = this._trackpad.x; - this.lastScrollY = this._trackpad.y; - } - } - - private checkItemProximity(item: Container, index: number): void - { - /** Get the item bounds, capping the width and height to at least 1 for the purposes of intersection checking. */ - item.getBounds(true, itemBounds); - itemBounds.width = Math.max(itemBounds.width, 1); - itemBounds.height = Math.max(itemBounds.height, 1); - - // Get the scroller bounds, expanding them by the defined max distance. - this.getBounds(true, scrollerBounds); - - scrollerBounds.x -= this.proximityRange; - scrollerBounds.y -= this.proximityRange; - scrollerBounds.width += this.proximityRange * 2; - scrollerBounds.height += this.proximityRange * 2; - - // Check for intersection - const inRange = scrollerBounds.rectangle.intersects(itemBounds.rectangle); - const wasInRange = this.proximityCache[index]; + this.proximityCheckFrameCounter++; + if (this.proximityCheckFrameCounter >= (this.options.proximityDebounce ?? 10)) + { + this.items.forEach((item, index) => + { + const inRange = this.isItemVisible(item, this.proximityRange); + const wasInRange = this.proximityStatusCache[index]; - // If the item's proximity state has changed, emit the event - if (inRange !== wasInRange) - { - this.proximityCache[index] = inRange; - this.onProximityChange.emit({ item, index, inRange }); + if (inRange !== wasInRange) + { + this.proximityStatusCache[index] = inRange; + this.onProximityChange.emit({ item, index, inRange }); + } + }); + this.lastScrollX = this._trackpad.x; + this.lastScrollY = this._trackpad.y; + this.proximityCheckFrameCounter = 0; + } } } diff --git a/src/stories/fancyButton/FancyButtonBitmapText.stories.ts b/src/stories/fancyButton/FancyButtonBitmapText.stories.ts index 9674bee4..fecb241d 100644 --- a/src/stories/fancyButton/FancyButtonBitmapText.stories.ts +++ b/src/stories/fancyButton/FancyButtonBitmapText.stories.ts @@ -14,6 +14,8 @@ const args = { textOffsetX: 0, textOffsetY: -7, defaultTextScale: 0.99, + defaultTextAnchorX: 0.5, + defaultTextAnchorY: 0.5, anchorX: 0.5, anchorY: 0.5, animationDuration: 100, @@ -31,9 +33,11 @@ export const UsingSpriteAndBitmapText: StoryFn = ( textOffsetX, textOffsetY, defaultTextScale, + defaultTextAnchorX, + defaultTextAnchorY, anchorX, anchorY, - animationDuration + animationDuration, }, context ) => @@ -54,14 +58,13 @@ export const UsingSpriteAndBitmapText: StoryFn = ( name: 'TitleFont', style: { ...defaultTextStyle, - fill: textColor || defaultTextStyle.fill, }, }); const title = new BitmapText({ text, - style: { fontFamily: 'TitleFont' }, + style: { fontFamily: 'TitleFont', fontSize: defaultTextStyle.fontSize }, }); // Component usage !!! @@ -74,6 +77,7 @@ export const UsingSpriteAndBitmapText: StoryFn = ( padding, textOffset: { x: textOffsetX, y: textOffsetY }, defaultTextScale, + defaultTextAnchor: { x: defaultTextAnchorX, y: defaultTextAnchorY }, animations: { hover: { props: { diff --git a/src/stories/fancyButton/FancyButtonDynamicUpdate.stories.ts b/src/stories/fancyButton/FancyButtonDynamicUpdate.stories.ts index fea13287..a6c078f0 100644 --- a/src/stories/fancyButton/FancyButtonDynamicUpdate.stories.ts +++ b/src/stories/fancyButton/FancyButtonDynamicUpdate.stories.ts @@ -13,6 +13,10 @@ const args = { textColor: '#FFFFFF', defaultTextScale: 0.99, defaultIconScale: 0.2, + defaultTextAnchorX: 0.5, + defaultTextAnchorY: 0.5, + defaultIconAnchorX: 0.5, + defaultIconAnchorY: 0.5, padding: 11, anchorX: 0.5, anchorY: 0.5, @@ -25,6 +29,10 @@ export const DynamicUpdate: StoryFn = ({ textColor, defaultTextScale, defaultIconScale, + defaultTextAnchorX, + defaultTextAnchorY, + defaultIconAnchorX, + defaultIconAnchorY, disabled, onPress, padding, @@ -50,6 +58,7 @@ export const DynamicUpdate: StoryFn = ({ button.iconView = Sprite.from(icon); button.defaultIconScale = defaultIconScale; + button.defaultIconAnchor = { x: defaultIconAnchorX, y: defaultIconAnchorY }; button.iconOffset = { x: -100, y: -7 }; button.textView = new Text({ @@ -59,6 +68,7 @@ export const DynamicUpdate: StoryFn = ({ } }); button.defaultTextScale = defaultTextScale; + button.defaultTextAnchor = { x: defaultTextAnchorX, y: defaultTextAnchorY }; button.textOffset = { x: 30, y: -7 }; button.padding = padding; diff --git a/src/stories/fancyButton/FancyButtonGraphics.stories.ts b/src/stories/fancyButton/FancyButtonGraphics.stories.ts index 8b67596b..3c039405 100644 --- a/src/stories/fancyButton/FancyButtonGraphics.stories.ts +++ b/src/stories/fancyButton/FancyButtonGraphics.stories.ts @@ -26,6 +26,10 @@ const args = { textOffsetY: 140, defaultTextScale: 0.99, defaultIconScale: 0.99, + defaultTextAnchorX: 0.5, + defaultTextAnchorY: 0.5, + defaultIconAnchorX: 0.5, + defaultIconAnchorY: 0.5, defaultOffsetY: 0, hoverOffsetY: -1, pressedOffsetY: 5, @@ -57,6 +61,10 @@ export const UseGraphics: StoryFn = ({ textOffsetY, defaultTextScale, defaultIconScale, + defaultTextAnchorX, + defaultTextAnchorY, + defaultIconAnchorX, + defaultIconAnchorY, defaultOffsetY, hoverOffsetY, pressedOffsetY, @@ -113,6 +121,8 @@ export const UseGraphics: StoryFn = ({ }, defaultTextScale, defaultIconScale, + defaultTextAnchor: { x: defaultTextAnchorX, y: defaultTextAnchorY }, + defaultIconAnchor: { x: defaultIconAnchorX, y: defaultIconAnchorY }, animations: { default: { props: { diff --git a/src/stories/fancyButton/FancyButtonHTMLText.stories.ts b/src/stories/fancyButton/FancyButtonHTMLText.stories.ts index b6674f3b..436c4c68 100644 --- a/src/stories/fancyButton/FancyButtonHTMLText.stories.ts +++ b/src/stories/fancyButton/FancyButtonHTMLText.stories.ts @@ -14,6 +14,8 @@ const args = { textOffsetX: 0, textOffsetY: -7, defaultTextScale: 0.99, + defaultTextAnchorX: 0.5, + defaultTextAnchorY: 0.5, anchorX: 0.5, anchorY: 0.5, animationDuration: 100, @@ -31,6 +33,8 @@ export const UsingSpriteAndHTMLText: StoryFn = ( textOffsetX, textOffsetY, defaultTextScale, + defaultTextAnchorX, + defaultTextAnchorY, anchorX, anchorY, animationDuration @@ -68,6 +72,7 @@ export const UsingSpriteAndHTMLText: StoryFn = ( padding, textOffset: { x: textOffsetX, y: textOffsetY }, defaultTextScale, + defaultTextAnchor: { x: defaultTextAnchorX, y: defaultTextAnchorY }, animations: { hover: { props: { diff --git a/src/stories/fancyButton/FancyButtonIcon.stories.ts b/src/stories/fancyButton/FancyButtonIcon.stories.ts index 5c175a10..777d5ac9 100644 --- a/src/stories/fancyButton/FancyButtonIcon.stories.ts +++ b/src/stories/fancyButton/FancyButtonIcon.stories.ts @@ -19,6 +19,8 @@ const args = { iconOffsetX: 0, iconOffsetY: 0, defaultIconScale: 0.99, + defaultIconAnchorX: 0.5, + defaultIconAnchorY: 0.5, defaultOffset: 0, hoverOffset: -1, pressedOffset: 5, @@ -43,6 +45,8 @@ export const UseIcon: StoryFn = ({ iconOffsetX, iconOffsetY, defaultIconScale, + defaultIconAnchorX, + defaultIconAnchorY, defaultOffset, hoverOffset, pressedOffset, @@ -86,6 +90,7 @@ export const UseIcon: StoryFn = ({ y: iconOffsetY }, defaultIconScale, + defaultIconAnchor: { x: defaultIconAnchorX, y: defaultIconAnchorY }, animations: { hover: { props: { diff --git a/src/stories/fancyButton/FancyButtonNineSliceSprite.stories.ts b/src/stories/fancyButton/FancyButtonNineSliceSprite.stories.ts index 362158e2..17cf4790 100644 --- a/src/stories/fancyButton/FancyButtonNineSliceSprite.stories.ts +++ b/src/stories/fancyButton/FancyButtonNineSliceSprite.stories.ts @@ -16,6 +16,10 @@ const args = { height: 137, defaultTextScale: 0.99, defaultIconScale: 0.2, + defaultTextAnchorX: 0.5, + defaultTextAnchorY: 0.5, + defaultIconAnchorX: 0.5, + defaultIconAnchorY: 0.5, anchorX: 0.5, anchorY: 0.5, animationDuration: 100, @@ -36,6 +40,10 @@ export const UseNineSliceSprite: StoryFn = ({ height, defaultTextScale, defaultIconScale, + defaultTextAnchorX, + defaultTextAnchorY, + defaultIconAnchorX, + defaultIconAnchorY }, context) => new PixiStory({ context, @@ -69,7 +77,11 @@ export const UseNineSliceSprite: StoryFn = ({ }), padding, textOffset: { x: 30, y: -5 }, + iconOffset: { x: -100, y: -7 }, defaultTextScale, + defaultIconScale, + defaultTextAnchor: { x: defaultTextAnchorX, y: defaultTextAnchorY }, + defaultIconAnchor: { x: defaultIconAnchorX, y: defaultIconAnchorY }, animations: { hover: { props: { @@ -94,8 +106,6 @@ export const UseNineSliceSprite: StoryFn = ({ borderWidth: 10, borderColor: 0xFFFFFF }); - button.defaultIconScale = defaultIconScale; - button.iconOffset = { x: -100, y: -7 }; button.anchor.set(anchorX, anchorY); diff --git a/src/stories/fancyButton/FancyButtonSprite.stories.ts b/src/stories/fancyButton/FancyButtonSprite.stories.ts index 8cf14399..def5a422 100644 --- a/src/stories/fancyButton/FancyButtonSprite.stories.ts +++ b/src/stories/fancyButton/FancyButtonSprite.stories.ts @@ -14,6 +14,8 @@ const args = { textOffsetX: 0, textOffsetY: -7, defaultTextScale: 0.99, + defaultTextAnchorX: 0.5, + defaultTextAnchorY: 0.5, anchorX: 0.5, anchorY: 0.5, animationDuration: 100, @@ -30,6 +32,8 @@ export const UseSprite: StoryFn = ({ textOffsetX, textOffsetY, defaultTextScale, + defaultTextAnchorX, + defaultTextAnchorY, anchorX, anchorY, animationDuration @@ -57,6 +61,7 @@ export const UseSprite: StoryFn = ({ padding, textOffset: { x: textOffsetX, y: textOffsetY }, defaultTextScale, + defaultTextAnchor: { x: defaultTextAnchorX, y: defaultTextAnchorY }, animations: { hover: { props: { diff --git a/src/stories/scrollBox/ScrollBoxProximity.stories.ts b/src/stories/scrollBox/ScrollBoxProximity.stories.ts index 7c1ff71f..ba4196ea 100644 --- a/src/stories/scrollBox/ScrollBoxProximity.stories.ts +++ b/src/stories/scrollBox/ScrollBoxProximity.stories.ts @@ -9,6 +9,7 @@ import { action } from '@storybook/addon-actions'; const args = { proximityRange: 100, + proximityDebounce: 10, width: 320, height: 420, radius: 20, @@ -34,6 +35,7 @@ export const ProximityEvent: StoryFn @@ -85,6 +87,7 @@ export const ProximityEvent: StoryFn