Preparing search index...

    Visual component for rendering an inset region of a face mesh with customizable borders.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    enabled: boolean

    Whether the component is active.

    faceIndex: number

    Index of the face to render the inset from.

    faceRegion: FaceInsetRegion

    Region of the face defining the inset boundaries.

    flipX: boolean

    Flip the inset horizontally.

    flipY: boolean

    Flip the inset vertically.

    horizontalAlignment: Horizontal

    Horizontal alignment of the mesh visual.

    id: Uuid

    The unique id of the entity.

    innerBorderRadius: number

    Radius of the inner border curve.

    mainMaterial: Material

    Primary material used for rendering.

    materials: Material[]

    Array of all materials on this mesh visual.

    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.

    offset: vec2

    Position offset of the inset relative to its pivot.

    outerBorderRadius: number

    Radius of the outer border curve.

    pivot: vec2

    Origin point for scaling and rotation transforms.

    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.

    sourceScale: vec2

    Scale factor applied to the source face region.

    stretchMode: StretchMode

    How the mesh stretches to fit its container.

    subDivisionCount: number

    Number of mesh geometry subdivisions.

    type: string

    The entity's type.

    verticalAlignment: Vertical

    Vertical alignment of the mesh visual.

    Methods

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

      Parameters

      • type: string

      Returns boolean

    • Move a material from one index to another.

      Parameters

      • origin: number
      • destination: number

      Returns void