API
API|
@babylonjs/core|
ISpatialAudioGizmo

Interface ISpatialAudioGizmo

Interface for a spatial audio gizmo.

interface ISpatialAudioGizmo {
    _rootMesh: Mesh;
    additionalTransformNode?: TransformNode;
    anchorPoint: GizmoAnchorPoint;
    attachedMesh: Nullable<AbstractMesh>;
    attachedNode: Nullable<Node>;
    coordinatesMode: GizmoCoordinatesMode;
    customRotationQuaternion: Nullable<Quaternion>;
    gizmoLayer: UtilityLayerRenderer;
    isHovered: boolean;
    material: StandardMaterial;
    onClickedObservable: Observable<AbstractSoundSource>;
    scaleRatio: number;
    soundSource: Nullable<AbstractSoundSource>;
    updateGizmoPositionToMatchAttachedMesh: boolean;
    updateGizmoRotationToMatchAttachedMesh: boolean;
    updateScale: boolean;
    dispose(): void;
    setCustomMesh(mesh: Mesh): void;
}

Hierarchy (View Summary)

Implemented by

Index
_rootMesh additionalTransformNode? anchorPoint attachedMesh attachedNode coordinatesMode customRotationQuaternion gizmoLayer isHovered material onClickedObservable scaleRatio soundSource updateGizmoPositionToMatchAttachedMesh updateGizmoRotationToMatchAttachedMesh updateScale
dispose setCustomMesh

_rootMesh

_rootMesh: Mesh

The root mesh of the gizmo

additionalTransformNode?: TransformNode

Additional transform applied to the gizmo. It's useful when the gizmo is attached to a bone: if the bone is part of a skeleton attached to a mesh, you should define the mesh as additionalTransformNode if you want the gizmo to be displayed at the bone's correct location. Otherwise, as the gizmo is relative to the skeleton root, the mesh transformation will not be taken into account.

anchorPoint: GizmoAnchorPoint

Defines where the gizmo will be positioned if updateGizmoPositionToMatchAttachedMesh is enabled. (Default: GizmoAnchorPoint.Origin)

attachedMesh: Nullable<AbstractMesh>

Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)

  • When set, interactions will be enabled
attachedNode: Nullable<Node>

Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)

  • When set, interactions will be enabled
coordinatesMode: GizmoCoordinatesMode

Set the coordinate mode to use. By default it's local.

customRotationQuaternion: Nullable<Quaternion>

Orientation that the gizmo will be displayed with. When set null, default value will be used (Quaternion(0, 0, 0, 1))

gizmoLayer: UtilityLayerRenderer

The utility layer the gizmo will be added to

isHovered: boolean

True when the mouse pointer is hovered a gizmo mesh

material: StandardMaterial

The material used to render the gizmo.

onClickedObservable: Observable<AbstractSoundSource>

Event that fires each time the gizmo is clicked.

scaleRatio: number

Ratio for the scale of the gizmo

soundSource: Nullable<AbstractSoundSource>

The sound source the gizmo is attached to.

updateGizmoPositionToMatchAttachedMesh: boolean

If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)

updateGizmoRotationToMatchAttachedMesh: boolean

If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)

updateScale: boolean

When set, the gizmo will always appear the same size no matter where the camera is (default: true)