Options
All
  • Public
  • Public/Protected
  • All
Menu

Default behavior for 3D UI elements. Handles a BABYLON.FollowBehavior, SixDofBehavior and BABYLON.SurfaceMagnetismBehavior

since

5.0.0

Hierarchy

  • DefaultBehavior

Implements

Index

Constructors

  • Instantiates the default behavior

    Returns DefaultBehavior

Properties

attachedNode: Nullable<Mesh>

Attached node of this behavior

followBehaviorEnabled: boolean

Enables the follow behavior

sixDofDragBehaviorEnabled: boolean

Enables the six DoF drag behavior

surfaceMagnetismBehaviorEnabled: boolean

Enables the surface magnetism behavior

Accessors

  • The follow behavior

    Returns FollowBehavior

  • get name(): string
  • The name of the behavior

    Returns string

  • The six DoF drag behavior

    Returns SixDofDragBehavior

Methods

  • Attaches the default behavior

    Parameters

    • ownerMesh: Mesh

      The top level mesh

    • Optional draggablesMeshes: Mesh[]

      Descendant meshes that can be used for dragging the owner mesh

    • Optional sceneUnderstandingMeshes: AbstractMesh[]

      Meshes from the scene understanding that will be used for surface magnetism

    Returns void

  • detach(): void
  • Detaches the behavior from the mesh

    Returns void

  • init(): void
  • Initializes the behavior

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme