DefaultBehavior

Class DefaultBehavior

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

since: 5.0.0

Hierarchy

DefaultBehavior

Implements

Behavior<Mesh>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DefaultBehavior(): DefaultBehavior

- Defined in .temp/docdirectory/doc.d.ts:102574
Instantiates the default behavior

Returns DefaultBehavior

Properties

attachedNodeSearch playground for attachedNode

attachedNode: Nullable<Mesh>

Attached node of this behavior

followBehaviorEnabledSearch playground for followBehaviorEnabled

followBehaviorEnabled: boolean

Enables the follow behavior

sixDofDragBehaviorEnabledSearch playground for sixDofDragBehaviorEnabled

sixDofDragBehaviorEnabled: boolean

Enables the six DoF drag behavior

surfaceMagnetismBehaviorEnabledSearch playground for surfaceMagnetismBehaviorEnabled

surfaceMagnetismBehaviorEnabled: boolean

Enables the surface magnetism behavior

Accessors

followBehavior

get followBehavior(): FollowBehavior

- Defined in .temp/docdirectory/doc.d.ts:102590
The follow behavior

Returns FollowBehavior

name

get name(): string

- Defined in .temp/docdirectory/doc.d.ts:102586
The name of the behavior

Returns string

sixDofDragBehavior

get sixDofDragBehavior(): SixDofDragBehavior

- Defined in .temp/docdirectory/doc.d.ts:102594
The six DoF drag behavior

Returns SixDofDragBehavior

surfaceMagnetismBehavior

get surfaceMagnetismBehavior(): SurfaceMagnetismBehavior

- Defined in .temp/docdirectory/doc.d.ts:102598
The surface magnetism behavior

Returns SurfaceMagnetismBehavior

Methods

attachSearch playground for attach

attach(ownerMesh: Mesh, draggablesMeshes?: Mesh[], sceneUnderstandingMeshes?: AbstractMesh[]): void

- Defined in .temp/docdirectory/doc.d.ts:102621
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

detachSearch playground for detach

detach(): void

Implementation of Behavior.detach
- Defined in .temp/docdirectory/doc.d.ts:102625
Detaches the behavior from the mesh

Returns void

initSearch playground for init

init(): void

Implementation of Behavior.init
- Defined in .temp/docdirectory/doc.d.ts:102614
Initializes the behavior

Returns void