Forráskód Böngészése

Add comments to public fields

yuccai 8 éve
szülő
commit
16242f028c

+ 13 - 0
src/Actions/babylon.actionManager.ts

@@ -245,6 +245,10 @@
             return false;
             return false;
         }
         }
 
 
+        /**
+         * Does exist one action manager with at least one trigger 
+         * @return {boolean} whether or not it exists one action manager with one trigger
+        **/
         public static get HasTriggers(): boolean {
         public static get HasTriggers(): boolean {
             for (var t in ActionManager.Triggers) {
             for (var t in ActionManager.Triggers) {
                 if (ActionManager.Triggers.hasOwnProperty(t)) {
                 if (ActionManager.Triggers.hasOwnProperty(t)) {
@@ -254,6 +258,10 @@
             return false;
             return false;
         }
         }
 
 
+        /**
+         * Does exist one action manager with at least one pick trigger 
+         * @return {boolean} whether or not it exists one action manager with one pick trigger
+        **/
         public static get HasPickTriggers(): boolean {
         public static get HasPickTriggers(): boolean {
             for (var t in ActionManager.Triggers) {
             for (var t in ActionManager.Triggers) {
                 if (ActionManager.Triggers.hasOwnProperty(t)) {
                 if (ActionManager.Triggers.hasOwnProperty(t)) {
@@ -266,6 +274,11 @@
             return false;
             return false;
         }
         }
 
 
+        /**
+         * Does exist one action manager that handles actions of a given trigger
+         * @param {number} trigger - the trigger to be tested
+         * @return {boolean} whether the trigger is handeled by at least one action manager
+        **/
         public static HasSpecificTrigger(trigger: number): boolean {
         public static HasSpecificTrigger(trigger: number): boolean {
             for (var t in ActionManager.Triggers) {
             for (var t in ActionManager.Triggers) {
                 if (ActionManager.Triggers.hasOwnProperty(t)) {
                 if (ActionManager.Triggers.hasOwnProperty(t)) {

+ 9 - 0
src/Tools/babylon.observable.ts

@@ -155,6 +155,10 @@
             return result;
             return result;
         }
         }
 
 
+        /**
+         * Does this observable has observers registered with pick mask
+         * @return {boolean} whether or not it has observers registered with pick mask
+        **/
         public hasPickMasks(): boolean {
         public hasPickMasks(): boolean {
             for (var obs of this._observers) {
             for (var obs of this._observers) {
                 if (obs.mask && (obs.mask === PointerEventTypes.POINTERPICK// ||
                 if (obs.mask && (obs.mask === PointerEventTypes.POINTERPICK// ||
@@ -167,6 +171,11 @@
             return false;
             return false;
         }
         }
 
 
+        /**
+         * Does this observable handles observer registered with a given mask
+         * @param {number} trigger - the mask to be tested
+         * @return {boolean} whether or not one observer registered with the given mask is handeled 
+        **/
         public hasSpecificMask(mask: number = -1): boolean {
         public hasSpecificMask(mask: number = -1): boolean {
             for (var obs of this._observers) {
             for (var obs of this._observers) {
                 if (obs.mask & mask && obs.mask === mask) {
                 if (obs.mask & mask && obs.mask === mask) {

+ 1 - 1
src/babylon.scene.ts

@@ -384,7 +384,7 @@
         private _previousPickResult = null;
         private _previousPickResult = null;
         private _isButtonPressed = false;
         private _isButtonPressed = false;
         private _doubleClickOccured = false;
         private _doubleClickOccured = false;
-        public exclusiveDoubleClickMode = false;
+        public exclusiveDoubleClickMode = false; // If you need to check double click without raising a single click at first click, enable this flag
 
 
         public cameraToUseForPointers: Camera = null; // Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position
         public cameraToUseForPointers: Camera = null; // Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position
         private _pointerX: number;
         private _pointerX: number;