Size

.Structs. Size

`大小`组件允许您设置 `width` 和 `height` 属性,并定义它们之间的关系. 该组件可以自动保持这两个值之间的纵横比,并将其夹紧 到定义的最小-最大范围.也可以控制主导轴.给定尺寸组件的尺寸时 这将导致它超出其最小-最大范围,尺寸根据主轴进行调整.

Constructor

new Size(widthopt, heightopt, aspectModeopt, parentopt)

Since:
  • 3.16.0
Parameters:
Name Type Attributes Default Description
width number <optional>
0 尺寸组件的宽度.
height number <optional>
width 尺寸组件的高度.如果没有给出,它将使用 `width` .
aspectMode number <optional>
0 尺寸组件的外观模式.默认为0,无模式.
parent any <optional>
null 此大小组件的父组件.可以是任何具有公共 `width` 和 `height` 属性的对象.尺寸被夹紧以尽可能保持在父边界内.

Members

(static, constant) ENVELOP :number

Since:
  • 3.16.0
宽度和高度会自动调整,以使大小覆盖整个目标区域,同时保持纵横比.这可能会超出目标大小.
Type:
  • number

(static, constant) FIT :number

Since:
  • 3.16.0
宽度和高度会自动调整以适合给定的目标区域,同时保持纵横比.根据长宽比,该区域内部可能有一些未被覆盖的空间.
Type:
  • number

(static, constant) HEIGHT_CONTROLS_WIDTH :number

Since:
  • 3.16.0
宽度会根据高度自动调整.
Type:
  • number

(static, constant) NONE :number

Since:
  • 3.16.0
不要使大小适合纵横比.当尺寸改变时改变比例.
Type:
  • number

(static, constant) WIDTH_CONTROLS_HEIGHT :number

Since:
  • 3.16.0
高度会根据宽度自动调整.
Type:
  • number

(readonly) aspectMode :number

Since:
  • 3.16.0
计算尺寸时,此尺寸组件将使用的方面模式. 该属性是只读的.要更改它,请使用 `setAspectMode` 方法.
Type:
  • number

(readonly) aspectRatio :number

Since:
  • 3.16.0
宽度和高度的比例关系. 此属性是只读的,当 `width` 或 `height` 属性更改时会自动更新, 这取决于方面模式.
Type:
  • number

height :number

Since:
  • 3.16.0
此大小组件的高度. 如果启用,该值将被限制在 `minHeight` 和 `maxHeight` 指定的范围内. 高度永远不能小于零. 如果启用纵横比锁定,更改此值将自动更新 `width` . 您也可以使用 `setHeight` 和 `getHeight` 方法.
Type:
  • number

(readonly) maxHeight :number

Since:
  • 3.16.0
最大允许高度. 该值是只读的.要更改它,请参见 `setMax` 方法.
Type:
  • number

(readonly) maxWidth :number

Since:
  • 3.16.0
允许的最大宽度. 该值是只读的.要更改它,请参见 `setMax` 方法.
Type:
  • number

(readonly) minHeight :number

Since:
  • 3.16.0
最小允许高度. 不能小于零. 该值是只读的.要更改它,请参见 `setMin` 方法.
Type:
  • number

(readonly) minWidth :number

Since:
  • 3.16.0
允许的最小宽度. 不能小于零. 该值是只读的.要更改它,请参见 `setMin` 方法.
Type:
  • number

(readonly) snapTo :Phaser.Math.Vector2

Since:
  • 3.16.0
包含水平和垂直捕捉值的矢量2,在调整大小时宽度和高度被捕捉到该矢量. 默认情况下,这是禁用的. 该属性是只读的.要更改它,请参见 `setSnap` 方法.
Type:

width :number

Since:
  • 3.16.0
此大小组件的宽度. 如果启用,该值将被限制在 `minWidth` 和 `maxWidth` 指定的范围内. 宽度不能小于零. 如果启用了纵横比锁定,更改此值将自动更新 `height` . 您也可以使用 `setWidth` 和 `getWidth` 方法.
Type:
  • number

Methods

constrain(widthopt, heightopt, fitopt) → {this}

Since:
  • 3.16.0
当前的 `width` 和 `height` 被调整以适合给定的尺寸,同时保持纵横比. 如果`fit`为真,则目标区域内可能有一些空间,如果其纵横比不同,则不会被覆盖. 如果 `fit` 为假,则如果长宽比不同,尺寸可能会延伸到目标区域之外. 如果这个尺寸组件有一个父集合,那么传递给这个方法的宽度和高度将被夹紧 它不能超过父级.
Parameters:
Name Type Attributes Default Description
width number <optional>
0 尺寸组件的新宽度.
height number <optional>
尺寸组件的新高度.如果没有给定,它将使用宽度值.
fit boolean <optional>
true 请执行 `fit`( true)约束或 `envelop` (false)约束.
Returns:
此大小组件实例.
Type
this

copy(destination) → {Phaser.Structs.Size}

Since:
  • 3.16.0
从该大小组件复制纵横比模式,纵横比,宽度和高度 到给定的大小组件.请注意,如果设置了父级,则不会跨级复制.
Parameters:
Name Type Description
destination Phaser.Structs.Size 要将值复制到的大小组件.
Returns:
更新的目标大小组件.
Type
Phaser.Structs.Size

destroy()

Since:
  • 3.16.0
销毁此大小组件. 这将清除本地属性和任何父对象(如果已设置). 损坏的尺寸组件不能重复使用.

envelop(widthopt, heightopt) → {this}

Since:
  • 3.16.0
调整当前的 `width` 和 `height` ,使它们完全包围给定的尺寸,同时保持纵横比. 如果长宽比不同,尺寸可能比目标区域延伸得更远. 如果此`尺寸`组件有一个父集,则这些值将被钳制,使其永远不会超过父集 在最长的轴上.
Parameters:
Name Type Attributes Default Description
width number <optional>
0 尺寸组件的新宽度.
height number <optional>
尺寸组件的新高度.如果没有给定,它将使用宽度值.
Returns:
此大小组件实例.
Type
this

fitTo(widthopt, heightopt) → {this}

Since:
  • 3.16.0
当前的 `width` 和 `height` 被调整以适合给定的尺寸,同时保持纵横比. 如果长宽比不同,目标区域内可能会有一些未被覆盖的空间. 如果这个尺寸组件有一个父集合,那么传递给这个方法的宽度和高度将被夹紧 它不能超过父级.
Parameters:
Name Type Attributes Default Description
width number <optional>
0 尺寸组件的新宽度.
height number <optional>
尺寸组件的新高度.如果没有给定,它将使用宽度值.
Returns:
此大小组件实例.
Type
this

getNewHeight(value, checkParentopt) → {number}

Since:
  • 3.16.0
取一个新的高度,通过最小/最大夹具,然后检查它没有超过父高度.
Parameters:
Name Type Attributes Default Description
value number 要钳制和检查的值.
checkParent boolean <optional>
true 根据父项检查给定值(如果已设置).
Returns:
修改后的高度值.
Type
number

getNewWidth(value, checkParentopt) → {number}

Since:
  • 3.16.0
取一个新的宽度,通过最小/最大夹具,然后检查它没有超过父宽度.
Parameters:
Name Type Attributes Default Description
value number 要钳制和检查的值.
checkParent boolean <optional>
true 根据父项检查给定值(如果已设置).
Returns:
修改后的宽度值.
Type
number

resize(width, heightopt) → {this}

Since:
  • 3.16.0
为此大小组件设置新的宽度和高度,并根据它们更新纵横比. 它不会改变 `aspectMode` 的大小,但仍会影响大小限制,如最小最大值和父边界.
Parameters:
Name Type Attributes Default Description
width number 尺寸组件的新宽度.
height number <optional>
width 尺寸组件的新高度.如果没有给出,它将使用 `width` .
Returns:
此大小组件实例.
Type
this

setAspectMode(valueopt) → {this}

Since:
  • 3.16.0
设置此尺寸组件的外观模式. 外观模式控制当您修改 `width` 或 `height` 属性或调用 `setSize` 时会发生什么. 它可以是从0到4的数字,也可以是大小常数: 0. NONE = 不要使大小适合纵横比.当尺寸改变时改变比例. 1. WIDTH_CONTROLS_HEIGHT = 高度会根据宽度自动调整. 2. HEIGHT_CONTROLS_WIDTH = 宽度会根据高度自动调整. 3. FIT = 宽度和高度会自动调整以适合给定的目标区域,同时保持纵横比.根据长宽比,该区域内部可能有一些未被覆盖的空间. 4. ENVELOP = 宽度和高度会自动调整,以使大小覆盖整个目标区域,同时保持纵横比.这可能会超出目标大小. 如果需要,调用此方法会自动重新计算 `width` 和 `height` .
Parameters:
Name Type Attributes Default Description
value number <optional>
0 方面模式值.
Returns:
此大小组件实例.
Type
this

setAspectRatio(ratio) → {this}

Since:
  • 3.16.0
设置一个新的纵横比,覆盖以前的纵横比. 然后,它立即使用当前维度调用 `setSize` .
Parameters:
Name Type Description
ratio number 新的长宽比.
Returns:
此大小组件实例.
Type
this

setCSS(element)

Since:
  • 3.17.0
将此大小组件的值设置为 `element.style.width` 和 `height` 给定的DOM元素的属性.属性设置为 `px` 值.
Parameters:
Name Type Description
element HTMLElement 用来设置CSS样式的DOM元素.

setHeight(height) → {this}

Since:
  • 3.16.0
设置该尺寸组件的高度. 根据纵横比模式,更改高度也可能会更新宽度和纵横比.
Parameters:
Name Type Description
height number 尺寸组件的新高度.
Returns:
此大小组件实例.
Type
this

setMax(widthopt, heightopt) → {this}

Since:
  • 3.16.0
设置此大小组件允许的最大宽度和高度值. 设置此选项将自动调整 `width` 和 `height` 属性,以确保它们在范围内. 请注意,根据方面模式,如果此大小组件有父集或没有父集,则此处设置最大值 在某些情况下可以超过.
Parameters:
Name Type Attributes Default Description
width number <optional>
Number.MAX_VALUE 尺寸组件的最大允许宽度.
height number <optional>
width 尺寸组件的最大允许高度.如果没有给出,它将使用 `width` .
Returns:
此大小组件实例.
Type
this

setMin(widthopt, heightopt) → {this}

Since:
  • 3.16.0
设置此大小组件允许的最小宽度和高度值. 最小值不能低于零,也不能大于最大值. 设置此选项将自动调整 `width` 和 `height` 属性,以确保它们在范围内. 请注意,基于方面模式,如果这个大小组件有一个父集或没有,这里设置的最小值 在某些情况下可以超过.
Parameters:
Name Type Attributes Default Description
width number <optional>
0 尺寸组件的最小允许宽度.
height number <optional>
width 尺寸组件的最小允许高度.如果没有给出,它将使用 `width` .
Returns:
此大小组件实例.
Type
this

setParent(parentopt) → {this}

Since:
  • 3.16.0
设置或清除此大小组件的父级. 若要清除父级,请在没有参数的情况下调用此方法. 父级影响该大小组件可以扩展的最大范围, 基于方面模式: NONE - 父母夹紧宽度和高度. WIDTH_CONTROLS_HEIGHT - 父母只是夹紧宽度. HEIGHT_CONTROLS_WIDTH - 父母只夹紧高度. FIT - 母夹具夹住任何需要的轴,以确保尺寸适合其中. ENVELOP - 父项用于确保大小完全包围父项. 调用此方法会自动调用 `setSize` .
Parameters:
Name Type Attributes Description
parent any