Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

babylonjs-gui

Package Overview
Dependencies
Maintainers
1
Versions
641
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

babylonjs-gui - npm Package Compare versions

Comparing version 3.2.0-alpha0 to 3.2.0-alpha10

158

babylon.gui.d.ts

@@ -19,5 +19,11 @@

_lastPickedControl: Control;
_lastControlOver: Nullable<Control>;
_lastControlDown: Nullable<Control>;
_capturingControl: Nullable<Control>;
_lastControlOver: {
[pointerId: number]: Control;
};
_lastControlDown: {
[pointerId: number]: Control;
};
_capturingControl: {
[pointerId: number]: Control;
};
_shouldBlockPointer: boolean;

@@ -53,3 +59,3 @@ _layerToDispose: Nullable<Layer>;

private _render();
private _doPicking(x, y, type, buttonIndex);
private _doPicking(x, y, type, pointerId, buttonIndex);
attach(): void;

@@ -61,2 +67,13 @@ attachToMesh(mesh: AbstractMesh, supportPointerMove?: boolean): void;

static CreateForMesh(mesh: AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean): AdvancedDynamicTexture;
/**
* FullScreenUI is created in a layer. This allows it to be treated like any other layer.
* As such, if you have a multi camera setup, you can set the layerMask on the GUI as well.
* When the GUI is not Created as FullscreenUI it does not respect the layerMask.
* layerMask is set through advancedTexture.layer.layerMask
* @param name name for the Texture
* @param foreground render in foreground (default is true)
* @param scene scene to be rendered in
* @param sampling method for scaling to fit screen
* @returns AdvancedDynamicTexture
*/
static CreateFullscreenUI(name: string, foreground?: boolean, scene?: Nullable<Scene>, sampling?: number): AdvancedDynamicTexture;

@@ -158,2 +175,3 @@ }

private _isDirty;
_tempParentMeasure: Measure;
protected _cachedParentMeasure: Measure;

@@ -184,2 +202,3 @@ private _paddingLeft;

private _doNotRender;
private _downPointerIds;
isHitTestVisible: boolean;

@@ -244,2 +263,4 @@ isPointerBlocker: boolean;

fontStyle: string;
/** @ignore */
readonly _isFontSizeInPercentage: boolean;
readonly fontSizeInPixels: number;

@@ -272,2 +293,4 @@ fontSize: string | number;

protected _getTypeName(): string;
/** @ignore */
_resetFontCache(): void;
getLocalCoordinates(globalCoordinates: Vector2): Vector2;

@@ -293,10 +316,10 @@ getLocalCoordinatesToRef(globalCoordinates: Vector2, result: Vector2): Control;

contains(x: number, y: number): boolean;
_processPicking(x: number, y: number, type: number, buttonIndex: number): boolean;
_processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
_onPointerMove(target: Control, coordinates: Vector2): void;
_onPointerEnter(target: Control): boolean;
_onPointerOut(target: Control): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
forcePointerUp(): void;
_processObservables(type: number, x: number, y: number, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
forcePointerUp(pointerId?: Nullable<number>): void;
_processObservables(type: number, x: number, y: number, pointerId: number, buttonIndex: number): boolean;
private _prepareFont();

@@ -352,3 +375,3 @@ dispose(): void;

_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_processPicking(x: number, y: number, type: number, buttonIndex: number): boolean;
_processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
protected _clipForChildren(context: CanvasRenderingContext2D): void;

@@ -437,3 +460,15 @@ protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;

protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_moveToProjectedPosition(projectedPosition: Vector3): void;
/**
* Move one end of the line given 3D cartesian coordinates.
* @param position Targeted world position
* @param scene Scene
* @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
*/
moveToVector3(position: Vector3, scene: Scene, end?: boolean): void;
/**
* Move one end of the line to a position in screen absolute space.
* @param projectedPosition Position in screen absolute space (X, Y)
* @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
*/
_moveToProjectedPosition(projectedPosition: Vector3, end?: boolean): void;
}

@@ -454,2 +489,3 @@ }

private _isThumbCircle;
private _isThumbClamped;
onValueChangedObservable: Observable<number>;

@@ -466,2 +502,3 @@ borderColor: string;

isThumbCircle: boolean;
isThumbClamped: boolean;
constructor(name?: string | undefined);

@@ -472,5 +509,5 @@ protected _getTypeName(): string;

private _updateValueFromPointer(x, y);
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerMove(target: Control, coordinates: Vector2): void;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
}

@@ -495,3 +532,3 @@ }

_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
}

@@ -517,3 +554,3 @@ }

_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
}

@@ -525,2 +562,5 @@ }

class TextBlock extends Control {
/**
* Defines the name of the control
*/
name: string | undefined;

@@ -534,2 +574,4 @@ private _text;

private _lineSpacing;
private _outlineWidth;
private _outlineColor;
/**

@@ -540,12 +582,82 @@ * An event triggered after the text is changed

onTextChangedObservable: Observable<TextBlock>;
/**
* An event triggered after the text was broken up into lines
* @type {BABYLON.Observable}
*/
onLinesReadyObservable: Observable<TextBlock>;
/**
* Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
*/
readonly lines: any[];
/**
* Gets or sets an boolean indicating that the TextBlock will be resized to fit container
*/
/**
* Gets or sets an boolean indicating that the TextBlock will be resized to fit container
*/
resizeToFit: boolean;
/**
* Gets or sets a boolean indicating if text must be wrapped
*/
/**
* Gets or sets a boolean indicating if text must be wrapped
*/
textWrapping: boolean;
/**
* Gets or sets text to display
*/
/**
* Gets or sets text to display
*/
text: string;
/**
* Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
*/
/**
* Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
*/
textHorizontalAlignment: number;
/**
* Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
*/
/**
* Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
*/
textVerticalAlignment: number;
/**
* Gets or sets line spacing value
*/
/**
* Gets or sets line spacing value
*/
lineSpacing: string | number;
constructor(name?: string | undefined, text?: string);
/**
* Gets or sets outlineWidth of the text to display
*/
/**
* Gets or sets outlineWidth of the text to display
*/
outlineWidth: number;
/**
* Gets or sets outlineColor of the text to display
*/
/**
* Gets or sets outlineColor of the text to display
*/
outlineColor: string;
/**
* Creates a new TextBlock object
* @param name defines the name of the control
* @param text defines the text to display (emptry string by default)
*/
constructor(
/**
* Defines the name of the control
*/
name?: string | undefined, text?: string);
protected _getTypeName(): string;
private _drawText(text, textWidth, y, context);
/** @ignore */
_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
protected _applyStates(context: CanvasRenderingContext2D): void;
protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;

@@ -615,7 +727,7 @@ protected _parseLine(line: string | undefined, context: CanvasRenderingContext2D): object;

protected _getTypeName(): string;
_processPicking(x: number, y: number, type: number, buttonIndex: number): boolean;
_processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
_onPointerEnter(target: Control): boolean;
_onPointerOut(target: Control): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
static CreateImageButton(name: string, text: string, imageUrl: string): Button;

@@ -661,5 +773,5 @@ static CreateImageOnlyButton(name: string, imageUrl: string): Button;

private _isPointOnWheel(coordinates);
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerMove(target: Control, coordinates: Vector2): void;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
}

@@ -711,4 +823,4 @@ }

_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
dispose(): void;

@@ -715,0 +827,0 @@ }

/// <reference types="babylonjs"/>
declare module 'babylonjs-gui' {

@@ -24,5 +25,11 @@ export = BABYLON.GUI;

_lastPickedControl: Control;
_lastControlOver: Nullable<Control>;
_lastControlDown: Nullable<Control>;
_capturingControl: Nullable<Control>;
_lastControlOver: {
[pointerId: number]: Control;
};
_lastControlDown: {
[pointerId: number]: Control;
};
_capturingControl: {
[pointerId: number]: Control;
};
_shouldBlockPointer: boolean;

@@ -58,3 +65,3 @@ _layerToDispose: Nullable<Layer>;

private _render();
private _doPicking(x, y, type, buttonIndex);
private _doPicking(x, y, type, pointerId, buttonIndex);
attach(): void;

@@ -66,2 +73,13 @@ attachToMesh(mesh: AbstractMesh, supportPointerMove?: boolean): void;

static CreateForMesh(mesh: AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean): AdvancedDynamicTexture;
/**
* FullScreenUI is created in a layer. This allows it to be treated like any other layer.
* As such, if you have a multi camera setup, you can set the layerMask on the GUI as well.
* When the GUI is not Created as FullscreenUI it does not respect the layerMask.
* layerMask is set through advancedTexture.layer.layerMask
* @param name name for the Texture
* @param foreground render in foreground (default is true)
* @param scene scene to be rendered in
* @param sampling method for scaling to fit screen
* @returns AdvancedDynamicTexture
*/
static CreateFullscreenUI(name: string, foreground?: boolean, scene?: Nullable<Scene>, sampling?: number): AdvancedDynamicTexture;

@@ -163,2 +181,3 @@ }

private _isDirty;
_tempParentMeasure: Measure;
protected _cachedParentMeasure: Measure;

@@ -189,2 +208,3 @@ private _paddingLeft;

private _doNotRender;
private _downPointerIds;
isHitTestVisible: boolean;

@@ -249,2 +269,4 @@ isPointerBlocker: boolean;

fontStyle: string;
/** @ignore */
readonly _isFontSizeInPercentage: boolean;
readonly fontSizeInPixels: number;

@@ -277,2 +299,4 @@ fontSize: string | number;

protected _getTypeName(): string;
/** @ignore */
_resetFontCache(): void;
getLocalCoordinates(globalCoordinates: Vector2): Vector2;

@@ -298,10 +322,10 @@ getLocalCoordinatesToRef(globalCoordinates: Vector2, result: Vector2): Control;

contains(x: number, y: number): boolean;
_processPicking(x: number, y: number, type: number, buttonIndex: number): boolean;
_processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
_onPointerMove(target: Control, coordinates: Vector2): void;
_onPointerEnter(target: Control): boolean;
_onPointerOut(target: Control): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
forcePointerUp(): void;
_processObservables(type: number, x: number, y: number, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
forcePointerUp(pointerId?: Nullable<number>): void;
_processObservables(type: number, x: number, y: number, pointerId: number, buttonIndex: number): boolean;
private _prepareFont();

@@ -357,3 +381,3 @@ dispose(): void;

_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_processPicking(x: number, y: number, type: number, buttonIndex: number): boolean;
_processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
protected _clipForChildren(context: CanvasRenderingContext2D): void;

@@ -442,3 +466,15 @@ protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;

protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_moveToProjectedPosition(projectedPosition: Vector3): void;
/**
* Move one end of the line given 3D cartesian coordinates.
* @param position Targeted world position
* @param scene Scene
* @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
*/
moveToVector3(position: Vector3, scene: Scene, end?: boolean): void;
/**
* Move one end of the line to a position in screen absolute space.
* @param projectedPosition Position in screen absolute space (X, Y)
* @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
*/
_moveToProjectedPosition(projectedPosition: Vector3, end?: boolean): void;
}

@@ -459,2 +495,3 @@ }

private _isThumbCircle;
private _isThumbClamped;
onValueChangedObservable: Observable<number>;

@@ -471,2 +508,3 @@ borderColor: string;

isThumbCircle: boolean;
isThumbClamped: boolean;
constructor(name?: string | undefined);

@@ -477,5 +515,5 @@ protected _getTypeName(): string;

private _updateValueFromPointer(x, y);
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerMove(target: Control, coordinates: Vector2): void;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
}

@@ -500,3 +538,3 @@ }

_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
}

@@ -522,3 +560,3 @@ }

_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
}

@@ -530,2 +568,5 @@ }

class TextBlock extends Control {
/**
* Defines the name of the control
*/
name: string | undefined;

@@ -539,2 +580,4 @@ private _text;

private _lineSpacing;
private _outlineWidth;
private _outlineColor;
/**

@@ -545,12 +588,82 @@ * An event triggered after the text is changed

onTextChangedObservable: Observable<TextBlock>;
/**
* An event triggered after the text was broken up into lines
* @type {BABYLON.Observable}
*/
onLinesReadyObservable: Observable<TextBlock>;
/**
* Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
*/
readonly lines: any[];
/**
* Gets or sets an boolean indicating that the TextBlock will be resized to fit container
*/
/**
* Gets or sets an boolean indicating that the TextBlock will be resized to fit container
*/
resizeToFit: boolean;
/**
* Gets or sets a boolean indicating if text must be wrapped
*/
/**
* Gets or sets a boolean indicating if text must be wrapped
*/
textWrapping: boolean;
/**
* Gets or sets text to display
*/
/**
* Gets or sets text to display
*/
text: string;
/**
* Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
*/
/**
* Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
*/
textHorizontalAlignment: number;
/**
* Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
*/
/**
* Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
*/
textVerticalAlignment: number;
/**
* Gets or sets line spacing value
*/
/**
* Gets or sets line spacing value
*/
lineSpacing: string | number;
constructor(name?: string | undefined, text?: string);
/**
* Gets or sets outlineWidth of the text to display
*/
/**
* Gets or sets outlineWidth of the text to display
*/
outlineWidth: number;
/**
* Gets or sets outlineColor of the text to display
*/
/**
* Gets or sets outlineColor of the text to display
*/
outlineColor: string;
/**
* Creates a new TextBlock object
* @param name defines the name of the control
* @param text defines the text to display (emptry string by default)
*/
constructor(
/**
* Defines the name of the control
*/
name?: string | undefined, text?: string);
protected _getTypeName(): string;
private _drawText(text, textWidth, y, context);
/** @ignore */
_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
protected _applyStates(context: CanvasRenderingContext2D): void;
protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;

@@ -620,7 +733,7 @@ protected _parseLine(line: string | undefined, context: CanvasRenderingContext2D): object;

protected _getTypeName(): string;
_processPicking(x: number, y: number, type: number, buttonIndex: number): boolean;
_processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
_onPointerEnter(target: Control): boolean;
_onPointerOut(target: Control): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
static CreateImageButton(name: string, text: string, imageUrl: string): Button;

@@ -666,5 +779,5 @@ static CreateImageOnlyButton(name: string, imageUrl: string): Button;

private _isPointOnWheel(coordinates);
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerMove(target: Control, coordinates: Vector2): void;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
}

@@ -716,4 +829,4 @@ }

_draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
_onPointerDown(target: Control, coordinates: Vector2, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, buttonIndex: number): void;
_onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
_onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): void;
dispose(): void;

@@ -720,0 +833,0 @@ }

4

package.json

@@ -7,3 +7,3 @@ {

"description": "The Babylon.js GUI library is an extension you can use to generate interactive user interface. It is build on top of the DynamicTexture.",
"version": "3.2.0-alpha0",
"version": "3.2.0-alpha10",
"repository": {

@@ -32,3 +32,3 @@ "type": "git",

"peerDependencies": {
"babylonjs": ">=3.1.0-alpha"
"babylonjs": ">=3.2.0-alpha"
},

@@ -35,0 +35,0 @@ "engines": {

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc