1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327 |
- declare module 'babylonjs-gui' {
- export = BABYLON.GUI;
- }
- declare module BABYLON.GUI {
- /**
- * Define a style used by control to automatically setup properties based on a template.
- * Only support font related properties so far
- */
- class Style implements BABYLON.IDisposable {
- private _fontFamily;
- private _fontStyle;
- /** @hidden */
- _host: AdvancedDynamicTexture;
- /** @hidden */
- _fontSize: ValueAndUnit;
- /**
- * Observable raised when the style values are changed
- */
- onChangedObservable: Observable<Style>;
- /**
- * Creates a new style object
- * @param host defines the AdvancedDynamicTexture which hosts this style
- */
- constructor(host: AdvancedDynamicTexture);
- /**
- * Gets or sets the font size
- */
- fontSize: string | number;
- /**
- * Gets or sets the font family
- */
- fontFamily: string;
- /**
- * Gets or sets the font style
- */
- fontStyle: string;
- /** Dispose all associated resources */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- class ValueAndUnit {
- unit: number;
- negativeValueAllowed: boolean;
- private _value;
- ignoreAdaptiveScaling: boolean;
- constructor(value: number, unit?: number, negativeValueAllowed?: boolean);
- readonly isPercentage: boolean;
- readonly isPixel: boolean;
- readonly internalValue: number;
- getValueInPixel(host: AdvancedDynamicTexture, refValue: number): number;
- getValue(host: AdvancedDynamicTexture): number;
- toString(host: AdvancedDynamicTexture): string;
- fromString(source: string | number): boolean;
- private static _Regex;
- private static _UNITMODE_PERCENTAGE;
- private static _UNITMODE_PIXEL;
- static readonly UNITMODE_PERCENTAGE: number;
- static readonly UNITMODE_PIXEL: number;
- }
- }
- declare module BABYLON.GUI {
- interface IFocusableControl {
- onFocus(): void;
- onBlur(): void;
- processKeyboard(evt: KeyboardEvent): void;
- }
- class AdvancedDynamicTexture extends DynamicTexture {
- private _isDirty;
- private _renderObserver;
- private _resizeObserver;
- private _preKeyboardObserver;
- private _pointerMoveObserver;
- private _pointerObserver;
- private _canvasPointerOutObserver;
- private _background;
- _rootContainer: Container;
- _lastPickedControl: Control;
- _lastControlOver: {
- [pointerId: number]: Control;
- };
- _lastControlDown: {
- [pointerId: number]: Control;
- };
- _capturingControl: {
- [pointerId: number]: Control;
- };
- _shouldBlockPointer: boolean;
- _layerToDispose: Nullable<Layer>;
- _linkedControls: Control[];
- private _isFullscreen;
- private _fullscreenViewport;
- private _idealWidth;
- private _idealHeight;
- private _useSmallestIdeal;
- private _renderAtIdealSize;
- private _focusedControl;
- private _blockNextFocusCheck;
- private _renderScale;
- /**
- * Gets or sets a boolean defining if alpha is stored as premultiplied
- */
- premulAlpha: boolean;
- renderScale: number;
- background: string;
- idealWidth: number;
- idealHeight: number;
- useSmallestIdeal: boolean;
- renderAtIdealSize: boolean;
- readonly layer: Nullable<Layer>;
- readonly rootContainer: Container;
- focusedControl: Nullable<IFocusableControl>;
- isForeground: boolean;
- constructor(name: string, width: number | undefined, height: number | undefined, scene: Nullable<Scene>, generateMipMaps?: boolean, samplingMode?: number);
- executeOnAllControls(func: (control: Control) => void, container?: Container): void;
- markAsDirty(): void;
- /**
- * Helper function used to create a new style
- */
- createStyle(): Style;
- addControl(control: Control): AdvancedDynamicTexture;
- removeControl(control: Control): AdvancedDynamicTexture;
- dispose(): void;
- private _onResize();
- _getGlobalViewport(scene: Scene): Viewport;
- getProjectedPosition(position: Vector3, worldMatrix: Matrix): Vector2;
- private _checkUpdate(camera);
- private _render();
- private _doPicking(x, y, type, pointerId, buttonIndex);
- _cleanControlAfterRemovalFromList(list: {
- [pointerId: number]: Control;
- }, control: Control): void;
- _cleanControlAfterRemoval(control: Control): void;
- attach(): void;
- attachToMesh(mesh: AbstractMesh, supportPointerMove?: boolean): void;
- moveFocusToControl(control: IFocusableControl): void;
- private _manageFocus();
- private _attachToOnPointerOut(scene);
- 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;
- }
- }
- declare module BABYLON.GUI {
- class Measure {
- left: number;
- top: number;
- width: number;
- height: number;
- constructor(left: number, top: number, width: number, height: number);
- copyFrom(other: Measure): void;
- isEqualsTo(other: Measure): boolean;
- static Empty(): Measure;
- }
- }
- declare module BABYLON.GUI {
- class Vector2WithInfo extends Vector2 {
- buttonIndex: number;
- constructor(source: Vector2, buttonIndex?: number);
- }
- class Matrix2D {
- m: Float32Array;
- constructor(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number);
- fromValues(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number): Matrix2D;
- determinant(): number;
- invertToRef(result: Matrix2D): Matrix2D;
- multiplyToRef(other: Matrix2D, result: Matrix2D): Matrix2D;
- transformCoordinates(x: number, y: number, result: Vector2): Matrix2D;
- static Identity(): Matrix2D;
- static TranslationToRef(x: number, y: number, result: Matrix2D): void;
- static ScalingToRef(x: number, y: number, result: Matrix2D): void;
- static RotationToRef(angle: number, result: Matrix2D): void;
- private static _TempPreTranslationMatrix;
- private static _TempPostTranslationMatrix;
- private static _TempRotationMatrix;
- private static _TempScalingMatrix;
- private static _TempCompose0;
- private static _TempCompose1;
- private static _TempCompose2;
- static ComposeToRef(tx: number, ty: number, angle: number, scaleX: number, scaleY: number, parentMatrix: Nullable<Matrix2D>, result: Matrix2D): void;
- }
- }
- declare module BABYLON.GUI {
- class MultiLinePoint {
- private _multiLine;
- private _x;
- private _y;
- private _control;
- private _mesh;
- private _controlObserver;
- private _meshObserver;
- _point: Vector2;
- constructor(multiLine: MultiLine);
- x: string | number;
- y: string | number;
- control: Nullable<Control>;
- mesh: Nullable<AbstractMesh>;
- translate(): Vector2;
- private _translatePoint();
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- class Control {
- name: string | undefined;
- private _alpha;
- private _alphaSet;
- private _zIndex;
- _root: Nullable<Container>;
- _host: AdvancedDynamicTexture;
- parent: Nullable<Container>;
- _currentMeasure: Measure;
- private _fontFamily;
- private _fontStyle;
- private _fontSize;
- private _font;
- _width: ValueAndUnit;
- _height: ValueAndUnit;
- protected _fontOffset: {
- ascent: number;
- height: number;
- descent: number;
- };
- private _color;
- private _style;
- private _styleObserver;
- protected _horizontalAlignment: number;
- protected _verticalAlignment: number;
- private _isDirty;
- _tempParentMeasure: Measure;
- protected _cachedParentMeasure: Measure;
- private _paddingLeft;
- private _paddingRight;
- private _paddingTop;
- private _paddingBottom;
- _left: ValueAndUnit;
- _top: ValueAndUnit;
- private _scaleX;
- private _scaleY;
- private _rotation;
- private _transformCenterX;
- private _transformCenterY;
- private _transformMatrix;
- protected _invertTransformMatrix: Matrix2D;
- protected _transformedPosition: Vector2;
- private _onlyMeasureMode;
- private _isMatrixDirty;
- private _cachedOffsetX;
- private _cachedOffsetY;
- private _isVisible;
- _linkedMesh: Nullable<AbstractMesh>;
- private _fontSet;
- private _dummyVector2;
- private _downCount;
- private _enterCount;
- private _doNotRender;
- private _downPointerIds;
- isHitTestVisible: boolean;
- isPointerBlocker: boolean;
- isFocusInvisible: boolean;
- shadowOffsetX: number;
- shadowOffsetY: number;
- shadowBlur: number;
- shadowColor: string;
- protected _linkOffsetX: ValueAndUnit;
- protected _linkOffsetY: ValueAndUnit;
- readonly typeName: string;
- /**
- * An event triggered when the pointer move over the control.
- */
- onPointerMoveObservable: Observable<Vector2>;
- /**
- * An event triggered when the pointer move out of the control.
- */
- onPointerOutObservable: Observable<Control>;
- /**
- * An event triggered when the pointer taps the control
- */
- onPointerDownObservable: Observable<Vector2WithInfo>;
- /**
- * An event triggered when pointer up
- */
- onPointerUpObservable: Observable<Vector2WithInfo>;
- /**
- * An event triggered when a control is clicked on
- */
- onPointerClickObservable: Observable<Vector2WithInfo>;
- /**
- * An event triggered when pointer enters the control
- */
- onPointerEnterObservable: Observable<Control>;
- /**
- * An event triggered when the control is marked as dirty
- */
- onDirtyObservable: Observable<Control>;
- /**
- * An event triggered after the control is drawn
- */
- onAfterDrawObservable: Observable<Control>;
- /** Gets or set information about font offsets (used to render and align text) */
- fontOffset: {
- ascent: number;
- height: number;
- descent: number;
- };
- alpha: number;
- scaleX: number;
- scaleY: number;
- rotation: number;
- transformCenterY: number;
- transformCenterX: number;
- horizontalAlignment: number;
- verticalAlignment: number;
- width: string | number;
- readonly widthInPixels: number;
- height: string | number;
- readonly heightInPixels: number;
- fontFamily: string;
- fontStyle: string;
- style: BABYLON.Nullable<Style>;
- /** @hidden */
- readonly _isFontSizeInPercentage: boolean;
- readonly fontSizeInPixels: number;
- fontSize: string | number;
- color: string;
- zIndex: number;
- notRenderable: boolean;
- isVisible: boolean;
- readonly isDirty: boolean;
- paddingLeft: string | number;
- readonly paddingLeftInPixels: number;
- paddingRight: string | number;
- readonly paddingRightInPixels: number;
- paddingTop: string | number;
- readonly paddingTopInPixels: number;
- paddingBottom: string | number;
- readonly paddingBottomInPixels: number;
- left: string | number;
- readonly leftInPixels: number;
- top: string | number;
- readonly topInPixels: number;
- linkOffsetX: string | number;
- readonly linkOffsetXInPixels: number;
- linkOffsetY: string | number;
- readonly linkOffsetYInPixels: number;
- readonly centerX: number;
- readonly centerY: number;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- /** @hidden */
- _resetFontCache(): void;
- getLocalCoordinates(globalCoordinates: Vector2): Vector2;
- getLocalCoordinatesToRef(globalCoordinates: Vector2, result: Vector2): Control;
- getParentLocalCoordinates(globalCoordinates: Vector2): Vector2;
- moveToVector3(position: Vector3, scene: Scene): void;
- linkWithMesh(mesh: Nullable<AbstractMesh>): void;
- _moveToProjectedPosition(projectedPosition: Vector3): void;
- _markMatrixAsDirty(): void;
- _markAsDirty(): void;
- _markAllAsDirty(): void;
- _link(root: Nullable<Container>, host: AdvancedDynamicTexture): void;
- protected _transform(context: CanvasRenderingContext2D): void;
- protected _applyStates(context: CanvasRenderingContext2D): void;
- protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
- protected _clip(context: CanvasRenderingContext2D): void;
- _measure(): void;
- protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- contains(x: number, y: 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, pointerId: number, buttonIndex: number): boolean;
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- forcePointerUp(pointerId?: Nullable<number>): void;
- _processObservables(type: number, x: number, y: number, pointerId: number, buttonIndex: number): boolean;
- private _prepareFont();
- dispose(): void;
- private static _HORIZONTAL_ALIGNMENT_LEFT;
- private static _HORIZONTAL_ALIGNMENT_RIGHT;
- private static _HORIZONTAL_ALIGNMENT_CENTER;
- private static _VERTICAL_ALIGNMENT_TOP;
- private static _VERTICAL_ALIGNMENT_BOTTOM;
- private static _VERTICAL_ALIGNMENT_CENTER;
- static readonly HORIZONTAL_ALIGNMENT_LEFT: number;
- static readonly HORIZONTAL_ALIGNMENT_RIGHT: number;
- static readonly HORIZONTAL_ALIGNMENT_CENTER: number;
- static readonly VERTICAL_ALIGNMENT_TOP: number;
- static readonly VERTICAL_ALIGNMENT_BOTTOM: number;
- static readonly VERTICAL_ALIGNMENT_CENTER: number;
- private static _FontHeightSizes;
- static _GetFontOffset(font: string): {
- ascent: number;
- height: number;
- descent: number;
- };
- static AddHeader(control: Control, text: string, size: string | number, options: {
- isHorizontal: boolean;
- controlFirst: boolean;
- }): StackPanel;
- protected static drawEllipse(x: number, y: number, width: number, height: number, context: CanvasRenderingContext2D): void;
- }
- }
- declare module BABYLON.GUI {
- class Container extends Control {
- name: string | undefined;
- protected _children: Control[];
- protected _measureForChildren: Measure;
- protected _background: string;
- protected _adaptWidthToChildren: boolean;
- protected _adaptHeightToChildren: boolean;
- adaptHeightToChildren: boolean;
- adaptWidthToChildren: boolean;
- background: string;
- readonly children: Control[];
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- getChildByName(name: string): Nullable<Control>;
- getChildByType(name: string, type: string): Nullable<Control>;
- containsControl(control: Control): boolean;
- addControl(control: Control): Container;
- removeControl(control: Control): Container;
- _reOrderControl(control: Control): void;
- _markMatrixAsDirty(): void;
- _markAllAsDirty(): void;
- protected _localDraw(context: CanvasRenderingContext2D): void;
- _link(root: Nullable<Container>, host: AdvancedDynamicTexture): void;
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _processPicking(x: number, y: number, type: number, pointerId: number, buttonIndex: number): boolean;
- protected _clipForChildren(context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- class StackPanel extends Container {
- name: string | undefined;
- private _isVertical;
- private _manualWidth;
- private _manualHeight;
- private _doNotTrackManualChanges;
- private _tempMeasureStore;
- isVertical: boolean;
- width: string | number;
- height: string | number;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- }
- }
- declare module BABYLON.GUI {
- class Rectangle extends Container {
- name: string | undefined;
- private _thickness;
- private _cornerRadius;
- thickness: number;
- cornerRadius: number;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _localDraw(context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _drawRoundedRect(context, offset?);
- protected _clipForChildren(context: CanvasRenderingContext2D): void;
- }
- }
- declare module BABYLON.GUI {
- class Ellipse extends Container {
- name: string | undefined;
- private _thickness;
- thickness: number;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- protected _localDraw(context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _clipForChildren(context: CanvasRenderingContext2D): void;
- }
- }
- declare module BABYLON.GUI {
- class Line extends Control {
- name: string | undefined;
- private _lineWidth;
- private _x1;
- private _y1;
- private _x2;
- private _y2;
- private _dash;
- private _connectedControl;
- private _connectedControlDirtyObserver;
- dash: Array<number>;
- connectedControl: Control;
- x1: string | number;
- y1: string | number;
- x2: string | number;
- y2: string | number;
- lineWidth: number;
- horizontalAlignment: number;
- verticalAlignment: number;
- private readonly _effectiveX2;
- private readonly _effectiveY2;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _measure(): void;
- protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): 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;
- }
- }
- declare module BABYLON.GUI {
- class Slider extends Control {
- name: string | undefined;
- private _thumbWidth;
- private _minimum;
- private _maximum;
- private _value;
- private _background;
- private _borderColor;
- private _barOffset;
- private _isThumbCircle;
- private _isThumbClamped;
- onValueChangedObservable: Observable<number>;
- borderColor: string;
- background: string;
- barOffset: string | number;
- readonly barOffsetInPixels: number;
- thumbWidth: string | number;
- readonly thumbWidthInPixels: number;
- minimum: number;
- maximum: number;
- value: number;
- isThumbCircle: boolean;
- isThumbClamped: boolean;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _pointerIsDown;
- private _updateValueFromPointer(x, y);
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- _onPointerMove(target: Control, coordinates: Vector2): void;
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- }
- }
- declare module BABYLON.GUI {
- class Checkbox extends Control {
- name: string | undefined;
- private _isChecked;
- private _background;
- private _checkSizeRatio;
- private _thickness;
- thickness: number;
- onIsCheckedChangedObservable: Observable<boolean>;
- checkSizeRatio: number;
- background: string;
- isChecked: boolean;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- }
- }
- declare module BABYLON.GUI {
- class RadioButton extends Control {
- name: string | undefined;
- private _isChecked;
- private _background;
- private _checkSizeRatio;
- private _thickness;
- thickness: number;
- group: string;
- onIsCheckedChangedObservable: Observable<boolean>;
- checkSizeRatio: number;
- background: string;
- isChecked: boolean;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- }
- }
- declare module BABYLON.GUI {
- class TextBlock extends Control {
- /**
- * Defines the name of the control
- */
- name: string | undefined;
- private _text;
- private _textWrapping;
- private _textHorizontalAlignment;
- private _textVerticalAlignment;
- private _lines;
- private _resizeToFit;
- private _lineSpacing;
- private _outlineWidth;
- private _outlineColor;
- /**
- * An event triggered after the text is changed
- */
- onTextChangedObservable: Observable<TextBlock>;
- /**
- * An event triggered after the text was broken up into lines
- */
- 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;
- /**
- * 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);
- /** @hidden */
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _applyStates(context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _parseLine(line: string | undefined, context: CanvasRenderingContext2D): object;
- protected _parseLineWithTextWrapping(line: string | undefined, context: CanvasRenderingContext2D): object;
- protected _renderLines(context: CanvasRenderingContext2D): void;
- dispose(): void;
- }
- }
- declare var DOMImage: new (width?: number | undefined, height?: number | undefined) => HTMLImageElement;
- declare module BABYLON.GUI {
- class Image extends Control {
- name: string | undefined;
- private _domImage;
- private _imageWidth;
- private _imageHeight;
- private _loaded;
- private _stretch;
- private _source;
- private _autoScale;
- private _sourceLeft;
- private _sourceTop;
- private _sourceWidth;
- private _sourceHeight;
- private _cellWidth;
- private _cellHeight;
- private _cellId;
- sourceLeft: number;
- sourceTop: number;
- sourceWidth: number;
- sourceHeight: number;
- autoScale: boolean;
- stretch: number;
- domImage: HTMLImageElement;
- private _onImageLoaded();
- source: Nullable<string>;
- cellWidth: number;
- cellHeight: number;
- cellId: number;
- constructor(name?: string | undefined, url?: Nullable<string>);
- protected _getTypeName(): string;
- synchronizeSizeWithContent(): void;
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private static _STRETCH_NONE;
- private static _STRETCH_FILL;
- private static _STRETCH_UNIFORM;
- private static _STRETCH_EXTEND;
- static readonly STRETCH_NONE: number;
- static readonly STRETCH_FILL: number;
- static readonly STRETCH_UNIFORM: number;
- static readonly STRETCH_EXTEND: number;
- }
- }
- declare module BABYLON.GUI {
- class Button extends Rectangle {
- name: string | undefined;
- pointerEnterAnimation: () => void;
- pointerOutAnimation: () => void;
- pointerDownAnimation: () => void;
- pointerUpAnimation: () => void;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- _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, pointerId: number, buttonIndex: number): boolean;
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- static CreateImageButton(name: string, text: string, imageUrl: string): Button;
- static CreateImageOnlyButton(name: string, imageUrl: string): Button;
- static CreateSimpleButton(name: string, text: string): Button;
- static CreateImageWithCenterTextButton(name: string, text: string, imageUrl: string): Button;
- }
- }
- declare module BABYLON.GUI {
- class ColorPicker extends Control {
- name: string | undefined;
- private _colorWheelCanvas;
- private _value;
- private _tmpColor;
- private _pointerStartedOnSquare;
- private _pointerStartedOnWheel;
- private _squareLeft;
- private _squareTop;
- private _squareSize;
- private _h;
- private _s;
- private _v;
- onValueChangedObservable: Observable<Color3>;
- value: Color3;
- width: string | number;
- height: string | number;
- size: string | number;
- constructor(name?: string | undefined);
- protected _getTypeName(): string;
- private _updateSquareProps();
- private _drawGradientSquare(hueValue, left, top, width, height, context);
- private _drawCircle(centerX, centerY, radius, context);
- private _createColorWheelCanvas(radius, thickness);
- private _RGBtoHSV(color, result);
- private _HSVtoRGB(hue, saturation, value, result);
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- private _pointerIsDown;
- private _updateValueFromPointer(x, y);
- private _isPointOnSquare(coordinates);
- private _isPointOnWheel(coordinates);
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- _onPointerMove(target: Control, coordinates: Vector2): void;
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- }
- }
- declare module BABYLON.GUI {
- class InputText extends Control implements IFocusableControl {
- name: string | undefined;
- private _text;
- private _placeholderText;
- private _background;
- private _focusedBackground;
- private _placeholderColor;
- private _thickness;
- private _margin;
- private _autoStretchWidth;
- private _maxWidth;
- private _isFocused;
- private _blinkTimeout;
- private _blinkIsEven;
- private _cursorOffset;
- private _scrollLeft;
- private _textWidth;
- private _clickedCoordinate;
- promptMessage: string;
- onTextChangedObservable: Observable<InputText>;
- onFocusObservable: Observable<InputText>;
- onBlurObservable: Observable<InputText>;
- maxWidth: string | number;
- readonly maxWidthInPixels: number;
- margin: string;
- readonly marginInPixels: number;
- autoStretchWidth: boolean;
- thickness: number;
- focusedBackground: string;
- background: string;
- placeholderColor: string;
- placeholderText: string;
- text: string;
- width: string | number;
- constructor(name?: string | undefined, text?: string);
- onBlur(): void;
- onFocus(): void;
- protected _getTypeName(): string;
- processKey(keyCode: number, key?: string): void;
- processKeyboard(evt: KeyboardEvent): void;
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number): boolean;
- _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- class KeyPropertySet {
- width?: string;
- height?: string;
- paddingLeft?: string;
- paddingRight?: string;
- paddingTop?: string;
- paddingBottom?: string;
- color?: string;
- background?: string;
- }
- class VirtualKeyboard extends StackPanel {
- onKeyPressObservable: Observable<string>;
- defaultButtonWidth: string;
- defaultButtonHeight: string;
- defaultButtonPaddingLeft: string;
- defaultButtonPaddingRight: string;
- defaultButtonPaddingTop: string;
- defaultButtonPaddingBottom: string;
- defaultButtonColor: string;
- defaultButtonBackground: string;
- shiftButtonColor: string;
- selectedShiftThickness: number;
- shiftState: number;
- protected _getTypeName(): string;
- private _createKey(key, propertySet);
- addKeysRow(keys: Array<string>, propertySets?: Array<KeyPropertySet>): void;
- applyShiftState(shiftState: number): void;
- private _connectedInputText;
- private _onFocusObserver;
- private _onBlurObserver;
- private _onKeyPressObserver;
- readonly connectedInputText: Nullable<InputText>;
- connect(input: InputText): void;
- disconnect(): void;
- static CreateDefaultLayout(): VirtualKeyboard;
- }
- }
- declare module BABYLON.GUI {
- class MultiLine extends Control {
- name: string | undefined;
- private _lineWidth;
- private _dash;
- private _points;
- private _minX;
- private _minY;
- private _maxX;
- private _maxY;
- constructor(name?: string | undefined);
- dash: Array<number>;
- getAt(index: number): MultiLinePoint;
- onPointUpdate: () => void;
- add(...items: (AbstractMesh | Control | {
- x: string | number;
- y: string | number;
- })[]): MultiLinePoint[];
- push(item?: (AbstractMesh | Control | {
- x: string | number;
- y: string | number;
- })): MultiLinePoint;
- remove(value: number | MultiLinePoint): void;
- lineWidth: number;
- horizontalAlignment: number;
- verticalAlignment: number;
- protected _getTypeName(): string;
- _draw(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- _measure(): void;
- protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to manage 3D user interface
- */
- class GUI3DManager implements BABYLON.IDisposable {
- private _scene;
- private _sceneDisposeObserver;
- private _utilityLayer;
- private _rootContainer;
- private _pointerObserver;
- _lastPickedControl: Control3D;
- /** @hidden */
- _lastControlOver: {
- [pointerId: number]: Control3D;
- };
- /** @hidden */
- _lastControlDown: {
- [pointerId: number]: Control3D;
- };
- /** Gets the hosting scene */
- readonly scene: Scene;
- readonly utilityLayer: Nullable<UtilityLayerRenderer>;
- /**
- * Creates a new GUI3DManager
- * @param scene
- */
- constructor(scene?: Scene);
- private _doPicking(type, pointerEvent);
- /**
- * Gets the root container
- */
- readonly rootContainer: Container3D;
- /**
- * Gets a boolean indicating if the given control is in the root child list
- * @param control defines the control to check
- * @returns true if the control is in the root child list
- */
- containsControl(control: Control3D): boolean;
- /**
- * Adds a control to the root child list
- * @param control defines the control to add
- * @returns the current manager
- */
- addControl(control: Control3D): GUI3DManager;
- /**
- * Removes the control from the root child list
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control3D): GUI3DManager;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to render controls with fluent desgin
- */
- class FluentMaterial extends PushMaterial {
- private _emissiveTexture;
- emissiveTexture: BaseTexture;
- private _renderId;
- /**
- * Creates a new Fluent material
- * @param name defines the name of the material
- * @param scene defines the hosting scene
- */
- constructor(name: string, scene: Scene);
- needAlphaBlending(): boolean;
- needAlphaTesting(): boolean;
- getAlphaTestTexture(): Nullable<BaseTexture>;
- isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
- bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
- getActiveTextures(): BaseTexture[];
- hasTexture(texture: BaseTexture): boolean;
- dispose(forceDisposeEffect?: boolean): void;
- clone(name: string): FluentMaterial;
- serialize(): any;
- getClassName(): string;
- static Parse(source: any, scene: Scene, rootUrl: string): FluentMaterial;
- }
- }
- declare module BABYLON.GUI {
- class Vector3WithInfo extends Vector3 {
- buttonIndex: number;
- constructor(source: Vector3, buttonIndex?: number);
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used as base class for controls
- */
- class Control3D implements IDisposable, IBehaviorAware<Control3D> {
- /** Defines the control name */
- name: string | undefined;
- /** @hidden */
- _host: GUI3DManager;
- private _node;
- private _downCount;
- private _enterCount;
- private _downPointerIds;
- private _isVisible;
- /** Gets or sets the control position */
- position: Vector3;
- /** Gets or sets the control scaling */
- scaling: Vector3;
- /** Callback used to start pointer enter animation */
- pointerEnterAnimation: () => void;
- /** Callback used to start pointer out animation */
- pointerOutAnimation: () => void;
- /** Callback used to start pointer down animation */
- pointerDownAnimation: () => void;
- /** Callback used to start pointer up animation */
- pointerUpAnimation: () => void;
- /**
- * An event triggered when the pointer move over the control.
- */
- onPointerMoveObservable: Observable<Vector3>;
- /**
- * An event triggered when the pointer move out of the control.
- */
- onPointerOutObservable: Observable<Control3D>;
- /**
- * An event triggered when the pointer taps the control
- */
- onPointerDownObservable: Observable<Vector3WithInfo>;
- /**
- * An event triggered when pointer up
- */
- onPointerUpObservable: Observable<Vector3WithInfo>;
- /**
- * An event triggered when a control is clicked on
- */
- onPointerClickObservable: Observable<Vector3WithInfo>;
- /**
- * An event triggered when pointer enters the control
- */
- onPointerEnterObservable: Observable<Control3D>;
- /**
- * Gets or sets the parent container
- */
- parent: Nullable<Container3D>;
- private _behaviors;
- /**
- * Gets the list of attached behaviors
- * @see http://doc.babylonjs.com/features/behaviour
- */
- readonly behaviors: Behavior<Control3D>[];
- /**
- * Attach a behavior to the control
- * @see http://doc.babylonjs.com/features/behaviour
- * @param behavior defines the behavior to attach
- * @returns the current control
- */
- addBehavior(behavior: Behavior<Control3D>): Control3D;
- /**
- * Remove an attached behavior
- * @see http://doc.babylonjs.com/features/behaviour
- * @param behavior defines the behavior to attach
- * @returns the current control
- */
- removeBehavior(behavior: Behavior<Control3D>): Control3D;
- /**
- * Gets an attached behavior by name
- * @param name defines the name of the behavior to look for
- * @see http://doc.babylonjs.com/features/behaviour
- * @returns null if behavior was not found else the requested behavior
- */
- getBehaviorByName(name: string): Nullable<Behavior<Control3D>>;
- /** Gets or sets a boolean indicating if the control is visible */
- isVisible: boolean;
- /**
- * Creates a new control
- * @param name defines the control name
- */
- constructor(
- /** Defines the control name */
- name?: string | undefined);
- /**
- * Gets a string representing the class name
- */
- readonly typeName: string;
- protected _getTypeName(): string;
- /**
- * Gets the mesh used to render this control
- */
- readonly node: Nullable<TransformNode>;
- /**
- * Gets the mesh used to render this control
- */
- readonly mesh: Nullable<Mesh>;
- /**
- * Link the control as child of the given node
- * @param node defines the node to link to. Use null to unlink the control
- * @returns the current control
- */
- linkToTransformNode(node: Nullable<TransformNode>): Control3D;
- /** @hidden **/
- _prepareNode(scene: Scene): void;
- /**
- * Node creation.
- * Can be overriden by children
- * @param scene defines the scene where the node must be attached
- * @returns the attached node or null if none
- */
- protected _createNode(scene: Scene): Nullable<TransformNode>;
- /**
- * Affect a material to the given mesh
- * @param mesh defines the mesh which will represent the control
- */
- protected _affectMaterial(mesh: Mesh): void;
- /** @hidden */
- _onPointerMove(target: Control3D, coordinates: Vector3): void;
- /** @hidden */
- _onPointerEnter(target: Control3D): boolean;
- /** @hidden */
- _onPointerOut(target: Control3D): void;
- /** @hidden */
- _onPointerDown(target: Control3D, coordinates: Vector3, pointerId: number, buttonIndex: number): boolean;
- /** @hidden */
- _onPointerUp(target: Control3D, coordinates: Vector3, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
- /** @hidden */
- forcePointerUp(pointerId?: Nullable<number>): void;
- /** @hidden */
- _processObservables(type: number, pickedPoint: Vector3, pointerId: number, buttonIndex: number): boolean;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create containers for controls
- */
- class Container3D extends Control3D {
- /**
- * Gets the list of child controls
- */
- protected _children: Control3D[];
- /**
- * Creates a new container
- * @param name defines the container name
- */
- constructor(name?: string);
- /**
- * Gets a boolean indicating if the given control is in the children of this control
- * @param control defines the control to check
- * @returns true if the control is in the child list
- */
- containsControl(control: Control3D): boolean;
- /**
- * Adds a control to the children of this control
- * @param control defines the control to add
- * @returns the current container
- */
- addControl(control: Control3D): Container3D;
- /**
- * This function will be called everytime a new control is added
- */
- protected _arrangeChildren(): void;
- protected _createNode(scene: Scene): Nullable<TransformNode>;
- /**
- * Removes the control from the children of this control
- * @param control defines the control to remove
- * @returns the current container
- */
- removeControl(control: Control3D): Container3D;
- protected _getTypeName(): string;
- /**
- * Releases all associated resources
- */
- dispose(): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a button in 3D
- */
- class Button3D extends Control3D {
- /** @hidden */
- protected _currentMaterial: Material;
- private _facadeTexture;
- private _content;
- /**
- * Creates a new button
- * @param name defines the control name
- */
- constructor(name?: string);
- /**
- * Gets or sets the GUI 2D content used to display the button's facade
- */
- content: Control;
- protected _getTypeName(): string;
- protected _createNode(scene: Scene): TransformNode;
- protected _affectMaterial(mesh: Mesh): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a holographic button in 3D
- */
- class HolographicButton extends Button3D {
- private _frontPlate;
- /**
- * Creates a new button
- * @param name defines the control name
- */
- constructor(name?: string);
- protected _getTypeName(): string;
- protected _createNode(scene: Scene): TransformNode;
- protected _affectMaterial(mesh: Mesh): void;
- }
- }
- declare module BABYLON.GUI {
- /**
- * Class used to create a stack panel in 3D on XY plane
- */
- class StackPanel3D extends Container3D {
- private _isVertical;
- /**
- * Gets or sets a boolean indicating if the stack panel is vertical or horizontal (horizontal by default)
- */
- isVertical: boolean;
- /**
- * Gets or sets the distance between elements
- */
- margin: number;
- /**
- * Creates new StackPanel
- * @param isVertical
- */
- constructor();
- protected _arrangeChildren(): void;
- }
- }
|