Preparing search index...

    TextStylePresets is a utility component designed to standardize and easily apply consistent text styles (including font size and optionally font weight) to a Text component based on a selected "ranking" (such as Title1, Headline, Body, etc.) and a preset "distance" (Near or Far) that accounts for different viewing contexts in AR experiences.

    The component uses a predefined mapping from ranking and distance to font settings, ensuring design consistency throughout the UI.

    Intended usage: Attach to a SceneObject that already contains a Text component above this component. Select the desired ranking and distance using the inspector properties to instantly update styling to match design guidelines.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    name: string
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string
    updatePriority: number

    Accessors

    • get distance(): Distance

      get current viewing distance

      Returns Distance

    • set distance(value: Distance): void

      set current viewing distance

      Parameters

      Returns void

    • get ranking(): Ranking

      get current text ranking

      Returns Ranking

    • set ranking(value: Ranking): void

      set current text ranking

      Parameters

      Returns void

    Methods

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Returns the current distance style ("near" or "far") selected for the text.

      Returns void