Browse Source

Tools code comments

David Catuhe 7 years ago
parent
commit
73665bc785
3 changed files with 15872 additions and 16297 deletions
  1. 15517 15234
      dist/preview release/babylon.d.ts
  2. 0 904
      dist/preview release/typedocValidationBaseline.json
  3. 355 159
      src/Tools/babylon.tools.ts

File diff suppressed because it is too large
+ 15517 - 15234
dist/preview release/babylon.d.ts


+ 0 - 904
dist/preview release/typedocValidationBaseline.json

@@ -2426,32 +2426,6 @@
         }
         }
       }
       }
     },
     },
-    "PerfCounter": {
-      "Constructor": {
-        "new PerfCounter": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      },
-      "Property": {
-        "count": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "total": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "Enabled": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      }
-    },
     "PerformanceMonitor": {
     "PerformanceMonitor": {
       "Property": {
       "Property": {
         "averageFPS": {
         "averageFPS": {
@@ -8561,884 +8535,6 @@
         }
         }
       }
       }
     },
     },
-    "Tools": {
-      "Class": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Property": {
-        "AllLogLevel": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "BaseUrl": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "DefaultRetryStrategy": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "EndPerformanceCounter": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "Error": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "ErrorLogLevel": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "Log": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "LogCache": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "LogLevels": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "MessageLogLevel": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "NoneLogLevel": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "Now": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "OnNewCacheEntry": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "PerformanceConsoleLogLevel": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "PerformanceLogLevel": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "PerformanceNoneLogLevel": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "PerformanceUserMarkLogLevel": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "PreprocessUrl": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "StartPerformanceCounter": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "UseFallbackTexture": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "Warn": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "WarningLogLevel": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "errorsCount": {
-          "Naming": {
-            "NotPascalCase": true
-          },
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "fallbackTexture": {
-          "Naming": {
-            "NotPascalCase": true
-          },
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      },
-      "Method": {
-        "CheckExtends": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "v": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "min": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "max": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "CleanUrl": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "url": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "ClearLogCache": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "CreateScreenshot": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "engine": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "camera": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "size": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "successCallback": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "mimeType": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "DeepCopy": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "source": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "destination": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "doNotCopyList": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "mustCopyList": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "DumpFramebuffer": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "width": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "height": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "engine": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "successCallback": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "mimeType": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "fileName": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "EncodeArrayBufferTobase64": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "buffer": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "ExitFullscreen": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "ExtractMinAndMax": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "positions": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "start": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "count": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "bias": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "stride": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "ExtractMinAndMaxIndexed": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "positions": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "indices": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "indexStart": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "indexCount": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "bias": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "ExtractMinAndMaxVector2": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "feeder": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "bias": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "FileAsURL": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "content": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "First": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "array": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "predicate": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "Format": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "value": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "decimals": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "GetClassName": {
-          "Parameter": {
-            "isType": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "GetDOMTextContent": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "element": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "GetExponentOfTwo": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "value": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "max": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "mode": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "GetFilename": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "path": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "GetPointerPrefix": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "Instantiate": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "className": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "IsEmpty": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "obj": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "IsExponentOfTwo": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "value": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "IsWindowObjectExist": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "LoadFile": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "url": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "onSuccess": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "onProgress": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "database": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "useArrayBuffer": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "onError": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "LoadScript": {
-          "Parameter": {
-            "scriptUrl": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "onSuccess": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "onError": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "MakeArray": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "obj": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "allowsNullUndefined": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "QueueNewFrame": {
-          "Comments": {
-            "MissingText": true,
-            "MissingReturn": true
-          }
-        },
-        "RandomId": {
-          "Comments": {
-            "MissingReturn": true
-          }
-        },
-        "ReadFile": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "fileToLoad": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "callback": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "progressCallBack": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "useArrayBuffer": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "ReadFileAsDataURL": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "fileToLoad": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "callback": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "progressCallback": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "RegisterTopRootEvents": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "events": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "RequestFullscreen": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "element": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "SetImmediate": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "action": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "ToDegrees": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "angle": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "ToRadians": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "angle": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "UnregisterTopRootEvents": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "events": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "ValidateXHRData": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "xhr": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "dataType": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "Vector2ArrayFeeder": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "array": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "_EndPerformanceConsole": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "counterName": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "condition": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "_EndPerformanceCounterDisabled": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "counterName": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "condition": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "_EndUserMark": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "counterName": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "condition": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "_StartPerformanceConsole": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "counterName": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "condition": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "_StartPerformanceCounterDisabled": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "counterName": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "condition": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "_StartUserMark": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "counterName": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "condition": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "arrayOrStringFeeder": {
-          "Naming": {
-            "NotPascalCase": true
-          },
-          "Comments": {
-            "MissingReturn": true
-          }
-        },
-        "getFullClassName": {
-          "Naming": {
-            "NotPascalCase": true
-          },
-          "Parameter": {
-            "isType": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "hashCodeFromStream": {
-          "Naming": {
-            "NotPascalCase": true
-          }
-        }
-      }
-    },
     "TransformNode": {
     "TransformNode": {
       "Class": {
       "Class": {
         "Comments": {
         "Comments": {

File diff suppressed because it is too large
+ 355 - 159
src/Tools/babylon.tools.ts