Preparing search index...

    Low Level Layout Component Set a base CellSize in local space Define a number of Rows And Columns And it will create a list or grid in the specified shape

    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.

    cellPadding: vec4 = ...
    cellSize: vec2 = ...
    columns: number = 2
    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.

    layoutBy: LayoutDirection
    name: string
    positionCallback: PositionCallback = null

    callback for each child on layout

    row, column use for advanced positioning per item

    rows: number = 3
    sceneObject: SceneObject

    The SceneObject this component is on.

    transform: Transform = ...
    uniqueIdentifier: string
    updatePriority: number

    Accessors

    • get isInitialized(): boolean

      Returns boolean

    • get totalColumns(): number

      Returns number

      total number of columns in grid

    • get totalRows(): number

      Returns number

      total number of rows in grid

    Methods

    • Parameters

      • gridColumn: number

        of target cell

      • gridRow: number

        of target cell

      Returns vec3

      position of cell at column and row

    • Parameters

      • x: number

        x index of target

      • y: number

        y index of target

      Returns SceneObject

      SceneObject at x, y in grid

    • initialization function call on next line after programmatically creating component to prevent a flash of unstyled content

      Returns void

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

      Parameters

      • type: string

      Returns boolean

    • call this function to lay out the children of this scene object according to the parameters set in the component will change their local transform

      Returns void

    • Returns void