Skip to main content

Class: UIDockRegionSystem

Defined in: packages/iwsdk-uiextensions/src/systems/dock-region-system.ts:21

Extends​

  • System<SystemSchema, { docked: { required: ( | Component<{ billboardWhileDragging: { default: true; type: Boolean; }; closable: { default: false; type: Boolean; }; dockable: { default: false; type: Boolean; }; dockMode: { default: "world-locked"; enum: { BodyFollow: "body-follow"; HandLocked: "hand-locked"; HeadLocked: "head-locked"; WorldLocked: "world-locked"; }; type: Enum; }; dragDelay: { default: number; type: Float32; }; focusBias: { default: number; type: Float32; }; followOffset: { default: [number, number, number]; type: Vec3; }; followSpeed: { default: number; type: Float32; }; followTolerance: { default: number; type: Float32; }; hand: { default: Hand | "either"; enum: { Either: "either"; Left: "left"; Right: "right"; }; type: Enum; }; handAnchor: { default: HandMenuAnchor; enum: { Above: "above"; Inside: "inside"; Outside: "outside"; Wrist: "wrist"; }; type: Enum; }; handAnchorDistance: { default: number; type: Float32; }; handOffset: { default: [number, number, number]; type: Vec3; }; minimizable: { default: false; type: Boolean; }; movable: { default: true; type: Boolean; }; palmAngle: { default: number; type: Float32; }; palmGate: { default: boolean; type: Boolean; }; pinnable: { default: false; type: Boolean; }; targetHeight: { default: number; type: Float32; }; targetWidth: { default: number; type: Float32; }; title: { default: string; type: String; }; windowId: { default: string; type: String; }; }> | Component<{ regionId: { default: string; type: String; }; }>)[]; }; regions: { required: Component<{ capacity: { default: number; type: Float32; }; columns: { default: number; type: Float32; }; flow: { default: "column"; enum: { Column: "column"; Grid: "grid"; Row: "row"; }; type: Enum; }; pitch: { default: number; type: Float32; }; regionId: { default: string; type: String; }; snapRadius: { default: number; type: Float32; }; }>[]; }; }, this>

Constructors​

Constructor​

new UIDockRegionSystem(
   _w: World, 
   _qm: QueryManager, 
   _p: number
): UIDockRegionSystem;

Defined in: node_modules/elics/lib/system.d.ts:76

Parameters​

ParameterType
_wWorld
_qmQueryManager
_pnumber

Returns​

UIDockRegionSystem

Inherited from​

createSystem({
  regions: { required: [UIDockRegion] },
  docked: { required: [UIWindow, UIDockedTo] },
}).constructor

Methods​

init()​

init(): void;

Defined in: packages/iwsdk-uiextensions/src/systems/dock-region-system.ts:30

Returns​

void

Overrides​

createSystem({
  regions: { required: [UIDockRegion] },
  docked: { required: [UIWindow, UIDockedTo] },
}).init

update()​

update(): void;

Defined in: packages/iwsdk-uiextensions/src/systems/dock-region-system.ts:43

Per-frame tick. Both arguments are in seconds (Three.js Clock convention), not milliseconds.

Returns​

void

Overrides​

createSystem({
  regions: { required: [UIDockRegion] },
  docked: { required: [UIWindow, UIDockedTo] },
}).update