Link Search Menu Expand Document

arena-py API v1.0.1

arena.objects.text

class Text(arena.objects.arena_object.Object):

Text object class to manage its properties in the ARENA: Display text. More properties at https://aframe.io/docs/1.5.0/components/text.html A-Frame Text.

Parameters
  • str align: Multi-line text alignment. Allows [left, center, right] Defaults to 'left' (optional)
  • float alphaTest: Discard text pixels if alpha is less than this value. Defaults to '0.5' (optional)
  • str anchor: Horizontal positioning. Allows [left, right, center, align] Defaults to 'center' (optional)
  • str baseline: Vertical positioning. Allows [top, center, bottom] Defaults to 'center' (optional)
  • str color: Text color. Defaults to '#000000' (optional)
  • str font: Font to render text, either the name of one of A-Frame's stock fonts or a URL to a font file. Allows [aileronsemibold, dejavu, exo2bold, exo2semibold, kelsonsans, monoid, mozillavr, roboto, sourcecodepro] Defaults to 'roboto' (optional)
  • str fontImage: Font image texture path to render text. Defaults to the font's name with extension replaced to .png. Don't need to specify if using a stock font. (derived from font name). (optional)
  • float height: Height of text block. (derived from text size). (optional)
  • float letterSpacing: Letter spacing in pixels. Defaults to '0' (optional)
  • float lineHeight: Line height in pixels. (derived from font file). (optional)
  • float opacity: Opacity, on a scale from 0 to 1, where 0 means fully transparent and 1 means fully opaque. Defaults to '1' (optional)
  • str shader: Shader used to render text. Allows [portal, flat, standard, sdf, msdf, ios10hls, skyshader, gradientshader] Defaults to 'sdf' (optional)
  • str side: Side to render. Allows [front, back, double] Defaults to 'double' (optional)
  • float tabSize: Tab size in spaces. Defaults to '4' (optional)
  • str text: </strong>DEPRECATED: data.text is *</em>deprecated* for object_type</strong>: text, use data.value instead. (deprecated)</li>
  • bool transparent: Whether text is transparent. Defaults to 'True' (optional)
  • str value: The actual content of the text. Line breaks and tabs are supported with \n and \t. (optional)
  • str whiteSpace: How whitespace should be handled. Allows [normal, pre, nowrap] Defaults to 'normal' (optional)
  • float width: Width in meters. (derived from geometry if exists). Defaults to '5' (optional)
  • float wrapCount: Number of characters before wrapping text (more or less). Defaults to '40' (optional)
  • float wrapPixels: Number of pixels before wrapping text. (derived from wrapCount). (optional)
  • float xOffset: X-offset to apply to add padding. Defaults to '0' (optional)
  • float zOffset: Z-offset to apply to avoid Z-fighting if using with a geometry as a background. Defaults to '0.001' (optional)
    • </ul> </div>
    Text(**kwargs)
    object_type = 'text'
    text
    Inherited Members
    </section> </main> </div>