Preparing search index...

    Visual component for stretching and deforming face meshes with named features.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    enabled: boolean

    Whether the component is active.

    faceIndex: number

    Index of the face mesh to deform.

    horizontalAlignment: Horizontal

    Horizontal alignment of the mesh visual.

    id: Uuid

    The unique id of the entity.

    meshShadowMode: MeshShadowMode

    Shadow rendering mode for the mesh.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    name: string

    Name of the component.

    renderOrder: number

    Determines the order in which this visual component is rendered relative to others.

    sceneObject: SceneObject

    Scene object this component is attached to.

    shadowColor: vec4

    Color of the mesh shadow.

    shadowDensity: number

    Opacity of the mesh shadow.

    stretchMode: StretchMode

    How the mesh stretches to fit its container.

    type: string

    The entity's type.

    verticalAlignment: Vertical

    Vertical alignment of the mesh visual.

    Methods

    • Register a new stretch feature by name.

      Parameters

      • name: string

      Returns void

    • Remove all registered stretch features.

      Returns void

    • Get all registered feature names.

      Returns string[]

    • Get the stretch points for a named feature.

      Parameters

      • name: string

      Returns StretchPoint[]

    • Get the blend weight for a named feature.

      Parameters

      • name: string

      Returns number

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Unregister a stretch feature by name.

      Parameters

      • name: string

      Returns void

    • Set the blend weight for a named feature.

      Parameters

      • name: string
      • weight: number

      Returns void

    • Update the stretch points for a named feature.

      Parameters

      Returns void