Text

findCharacterPos

• findCharacterPos(this: Text, index: number): Vector2f

  返回指定字符的世界坐标，index 按 Unicode 码点计数。

  参数

  this

  Text

  index

  number

  返回值

  Vector2f

  已被弃用

  使用 getShapedGlyphs() 获取完整布局。

  源码与继承

getCharacterSize

• getCharacterSize(): number

  返回像素字号。

  返回值

  number

  源码与继承

getClusterGrouping

• getClusterGrouping(): ClusterGrouping

  返回字形簇分组策略。

  返回值

  ClusterGrouping

  源码与继承

getFillColor

• getFillColor(): Color

  返回填充颜色副本。

  返回值

  Color

  源码与继承

getFont

• getFont(): Readonly

  返回当前字体的只读引用。

  返回值

  Readonly

  源码与继承

getInverseTransform

• getInverseTransform(): ReadonlyValue<Transform>

  返回从父坐标系到局部的只读逆变换缓存；不可逆时为单位矩阵。

  返回值

  ReadonlyValue<Transform>

  源码与继承

getLetterSpacing

• getLetterSpacing(): number

  返回字间距倍率。

  返回值

  number

  源码与继承

getLineAlignment

• getLineAlignment(): LineAlignment

  返回行对齐方式。

  返回值

  LineAlignment

  源码与继承

getLineSpacing

• getLineSpacing(): number

  返回行间距倍率。

  返回值

  number

  源码与继承

getLocalBounds

• getLocalBounds(): FloatRect

  返回整形后文本的局部轴对齐包围框。

  返回值

  FloatRect

  源码与继承

getOrigin

• getOrigin(): Vector2f

  返回局部变换原点的独立副本。

  返回值

  Vector2f

  源码与继承

getOutlineColor

• getOutlineColor(): Color

  返回轮廓颜色副本。

  返回值

  Color

  源码与继承

getOutlineThickness

• getOutlineThickness(): number

  返回轮廓像素厚度。

  返回值

  number

  源码与继承

getOutlineVertexData

• getOutlineVertexData(): VertexArray

  返回可修改的轮廓顶点数据；下一次几何重建后需要重新获取。

  返回值

  VertexArray

  源码与继承

getPosition

• getPosition(): Vector2f

  返回位置的独立副本。

  返回值

  Vector2f

  源码与继承

getRotation

• getRotation(): Angle

  返回归一化到 [0°, 360°) 的旋转角度副本。

  返回值

  Angle

  源码与继承

getScale

• getScale(): Vector2f

  返回缩放因子的独立副本。

  返回值

  Vector2f

  源码与继承

getShapedGlyphs

• getShapedGlyphs(): readonly ShapedGlyph[]

  按需整形并返回字形布局视图；cluster 为 JS UTF-16 索引。

  返回值

  readonly ShapedGlyph[]

  源码与继承

getString

• getString(): string

  返回当前 JS 字符串。

  返回值

  string

  源码与继承

getStyle

• getStyle(): TextStyle

  返回文本样式位标志。

  返回值

  TextStyle

  源码与继承

getTextOrientation

• getTextOrientation(): TextOrientation

  返回文本排版方向。

  返回值

  TextOrientation

  源码与继承

getTransform

• getTransform(): ReadonlyValue<Transform>

  返回从局部到父坐标系的只读变换缓存；后续读取可更新同一对象。

  返回值

  ReadonlyValue<Transform>

  源码与继承

getVertexData

• getVertexData(): VertexArray

  返回可修改的填充顶点数据；下一次几何重建后需要重新获取。

  返回值

  VertexArray

  源码与继承

move

• move(this: TransformableHost, offset: ReadonlyValue<Vector2f>): void

  将 offset 加到当前位置。

  参数

  this

  TransformableHost

  offset

  ReadonlyValue<Vector2f>

  返回值

  void

  源码与继承

rotate

• rotate(this: TransformableHost, angle: ReadonlyValue<Angle>): void

  在当前旋转角度上累加 angle。

  参数

  this

  TransformableHost

  angle

  ReadonlyValue<Angle>

  返回值

  void

  源码与继承

scale

• scale(this: TransformableHost, factors: ReadonlyValue<Vector2f>): void

  将当前 X、Y 缩放因子分别乘以 factors。

  参数

  this

  TransformableHost

  factors

  ReadonlyValue<Vector2f>

  返回值

  void

  源码与继承

setCharacterSize

• setCharacterSize(this: TextResource, size: number): void

  设置像素字号。

  参数

  this

  TextResource

  size

  number

  返回值

  void

  源码与继承

setClusterGrouping

• setClusterGrouping(this: TextResource, grouping: ClusterGrouping): void

  设置整形时的字形簇分组策略。

  参数

  this

  TextResource

  grouping

  ClusterGrouping

  返回值

  void

  源码与继承

setFillColor

• setFillColor(this: TextResource, color: ReadonlyValue<Color>): void

  复制填充颜色；已有几何仅重新着色。

  参数

  this

  TextResource

  color

  ReadonlyValue<Color>

  返回值

  void

  源码与继承

setFont

• setFont(this: TextResource, font: Readonly): void

  设置字体并保留其引用。

  参数

  this

  TextResource

  font

  Readonly

  返回值

  void

  源码与继承

setGlyphPreProcessor

• setGlyphPreProcessor(
      this: TextResource,
      processor: null | GlyphPreProcessor,
  ): void

  设置同步字形外观回调，null 取消；回调在几何重建时执行。

  参数

  this

  TextResource

  processor

  null | GlyphPreProcessor

  返回值

  void

  源码与继承

setLetterSpacing

• setLetterSpacing(this: TextResource, factor: number): void

  设置字间距倍率，1 为默认间距。

  参数

  this

  TextResource

  factor

  number

  返回值

  void

  源码与继承

setLineAlignment

• setLineAlignment(this: TextResource, alignment: LineAlignment): void

  设置多行文本的对齐方式。

  参数

  this

  TextResource

  alignment

  LineAlignment

  返回值

  void

  源码与继承

setLineSpacing

• setLineSpacing(this: TextResource, factor: number): void

  设置行间距倍率，1 为字体默认行距。

  参数

  this

  TextResource

  factor

  number

  返回值

  void

  源码与继承

setOrigin

• setOrigin(this: TransformableHost, origin: ReadonlyValue<Vector2f>): void

  设置局部坐标中的变换原点，旋转和缩放围绕该点进行。

  参数

  this

  TransformableHost

  origin

  ReadonlyValue<Vector2f>

  返回值

  void

  源码与继承

setOutlineColor

• setOutlineColor(this: TextResource, color: ReadonlyValue<Color>): void

  复制轮廓颜色；已有几何仅重新着色。

  参数

  this

  TextResource

  color

  ReadonlyValue<Color>

  返回值

  void

  源码与继承

setOutlineThickness

• setOutlineThickness(this: TextResource, thickness: number): void

  设置轮廓像素厚度。

  参数

  this

  TextResource

  thickness

  number

  返回值

  void

  源码与继承

setPosition

• setPosition(this: TransformableHost, position: ReadonlyValue<Vector2f>): void

  设置对象原点在父坐标系中的位置，复制 position 的值。

  参数

  this

  TransformableHost

  position

  ReadonlyValue<Vector2f>

  返回值

  void

  源码与继承

setRotation

• setRotation(this: TransformableHost, angle: ReadonlyValue<Angle>): void

  设置旋转角度；屏幕坐标中正角度为顺时针。

  参数

  this

  TransformableHost

  angle

  ReadonlyValue<Angle>

  返回值

  void

  源码与继承

setScale

• setScale(this: TransformableHost, factors: ReadonlyValue<Vector2f>): void

  设置 X、Y 缩放因子；(1, 1) 为原始大小，负值可翻转。

  参数

  this

  TransformableHost

  factors

  ReadonlyValue<Vector2f>

  返回值

  void

  源码与继承

setString

• setString(this: TextResource, value: string): void

  设置显示字符串，下次查询或绘制时重新整形。

  参数

  this

  TextResource

  value

  string

  返回值

  void

  源码与继承

setStyle

• setStyle(this: TextResource, style: TextStyle): void

  设置 TextStyle 位标志，可组合粗体、斜体等样式。

  参数

  this

  TextResource

  style

  TextStyle

  返回值

  void

  源码与继承

setTextOrientation

• setTextOrientation(this: TextResource, orientation: TextOrientation): void

  设置横排或竖排方向。

  参数

  this

  TextResource

  orientation

  TextOrientation

  返回值

  void

  源码与继承

只读[graphicsNative]

只读[mutableValue]

只读[transformableState]

[dispatchDrawable]

• "[dispatchDrawable]"(
      this: Text,
      target: RenderTarget,
      states: RenderStates,
  ): void

  参数

  this

  Text

  target

  RenderTarget

  states

  RenderStates

  返回值

  void

  源码与继承