Fix documentation issues

dist/preview release/serializers/babylon.glTF2Serializer.d.ts

@@ -1,3 +1,252 @@
+declare module BABYLON.GLTF2 {
+    const enum AccessorComponentType {
+        BYTE = 5120,
+        UNSIGNED_BYTE = 5121,
+        SHORT = 5122,
+        UNSIGNED_SHORT = 5123,
+        UNSIGNED_INT = 5125,
+        FLOAT = 5126,
+    }
+    const enum AccessorType {
+        SCALAR = "SCALAR",
+        VEC2 = "VEC2",
+        VEC3 = "VEC3",
+        VEC4 = "VEC4",
+        MAT2 = "MAT2",
+        MAT3 = "MAT3",
+        MAT4 = "MAT4",
+    }
+    const enum AnimationChannelTargetPath {
+        TRANSLATION = "translation",
+        ROTATION = "rotation",
+        SCALE = "scale",
+        WEIGHTS = "weights",
+    }
+    const enum AnimationInterpolation {
+        LINEAR = "LINEAR",
+        STEP = "STEP",
+        CUBICSPLINE = "CUBICSPLINE",
+    }
+    const enum CameraType {
+        PERSPECTIVE = "perspective",
+        ORTHOGRAPHIC = "orthographic",
+    }
+    const enum ImageMimeType {
+        JPEG = "image/jpeg",
+        PNG = "image/png",
+    }
+    const enum MaterialAlphaMode {
+        OPAQUE = "OPAQUE",
+        MASK = "MASK",
+        BLEND = "BLEND",
+    }
+    const enum MeshPrimitiveMode {
+        POINTS = 0,
+        LINES = 1,
+        LINE_LOOP = 2,
+        LINE_STRIP = 3,
+        TRIANGLES = 4,
+        TRIANGLE_STRIP = 5,
+        TRIANGLE_FAN = 6,
+    }
+    const enum TextureMagFilter {
+        NEAREST = 9728,
+        LINEAR = 9729,
+    }
+    const enum TextureMinFilter {
+        NEAREST = 9728,
+        LINEAR = 9729,
+        NEAREST_MIPMAP_NEAREST = 9984,
+        LINEAR_MIPMAP_NEAREST = 9985,
+        NEAREST_MIPMAP_LINEAR = 9986,
+        LINEAR_MIPMAP_LINEAR = 9987,
+    }
+    const enum TextureWrapMode {
+        CLAMP_TO_EDGE = 33071,
+        MIRRORED_REPEAT = 33648,
+        REPEAT = 10497,
+    }
+    interface IProperty {
+        extensions?: {
+            [key: string]: any;
+        };
+        extras?: any;
+    }
+    interface IChildRootProperty extends IProperty {
+        name?: string;
+    }
+    interface IAccessorSparseIndices extends IProperty {
+        bufferView: number;
+        byteOffset?: number;
+        componentType: AccessorComponentType;
+    }
+    interface IAccessorSparseValues extends IProperty {
+        bufferView: number;
+        byteOffset?: number;
+    }
+    interface IAccessorSparse extends IProperty {
+        count: number;
+        indices: IAccessorSparseIndices;
+        values: IAccessorSparseValues;
+    }
+    interface IAccessor extends IChildRootProperty {
+        bufferView?: number;
+        byteOffset?: number;
+        componentType: AccessorComponentType;
+        normalized?: boolean;
+        count: number;
+        type: AccessorType;
+        max?: number[];
+        min?: number[];
+        sparse?: IAccessorSparse;
+    }
+    interface IAnimationChannel extends IProperty {
+        sampler: number;
+        target: IAnimationChannelTarget;
+    }
+    interface IAnimationChannelTarget extends IProperty {
+        node: number;
+        path: AnimationChannelTargetPath;
+    }
+    interface IAnimationSampler extends IProperty {
+        input: number;
+        interpolation?: AnimationInterpolation;
+        output: number;
+    }
+    interface IAnimation extends IChildRootProperty {
+        channels: IAnimationChannel[];
+        samplers: IAnimationSampler[];
+    }
+    interface IAsset extends IChildRootProperty {
+        copyright?: string;
+        generator?: string;
+        version: string;
+        minVersion?: string;
+    }
+    interface IBuffer extends IChildRootProperty {
+        uri?: string;
+        byteLength: number;
+    }
+    interface IBufferView extends IChildRootProperty {
+        buffer: number;
+        byteOffset?: number;
+        byteLength: number;
+        byteStride?: number;
+    }
+    interface ICameraOrthographic extends IProperty {
+        xmag: number;
+        ymag: number;
+        zfar: number;
+        znear: number;
+    }
+    interface ICameraPerspective extends IProperty {
+        aspectRatio: number;
+        yfov: number;
+        zfar: number;
+        znear: number;
+    }
+    interface ICamera extends IChildRootProperty {
+        orthographic?: ICameraOrthographic;
+        perspective?: ICameraPerspective;
+        type: CameraType;
+    }
+    interface IImage extends IChildRootProperty {
+        uri?: string;
+        mimeType?: ImageMimeType;
+        bufferView?: number;
+    }
+    interface IMaterialNormalTextureInfo extends ITextureInfo {
+        scale?: number;
+    }
+    interface IMaterialOcclusionTextureInfo extends ITextureInfo {
+        strength?: number;
+    }
+    interface IMaterialPbrMetallicRoughness {
+        baseColorFactor?: number[];
+        baseColorTexture?: ITextureInfo;
+        metallicFactor?: number;
+        roughnessFactor?: number;
+        metallicRoughnessTexture?: ITextureInfo;
+    }
+    interface IMaterial extends IChildRootProperty {
+        pbrMetallicRoughness?: IMaterialPbrMetallicRoughness;
+        normalTexture?: IMaterialNormalTextureInfo;
+        occlusionTexture?: IMaterialOcclusionTextureInfo;
+        emissiveTexture?: ITextureInfo;
+        emissiveFactor?: number[];
+        alphaMode?: MaterialAlphaMode;
+        alphaCutoff?: number;
+        doubleSided?: boolean;
+    }
+    interface IMeshPrimitive extends IProperty {
+        attributes: {
+            [name: string]: number;
+        };
+        indices?: number;
+        material?: number;
+        mode?: MeshPrimitiveMode;
+        targets?: {
+            [name: string]: number;
+        }[];
+    }
+    interface IMesh extends IChildRootProperty {
+        primitives: IMeshPrimitive[];
+        weights?: number[];
+    }
+    interface INode extends IChildRootProperty {
+        camera?: number;
+        children?: number[];
+        skin?: number;
+        matrix?: number[];
+        mesh?: number;
+        rotation?: number[];
+        scale?: number[];
+        translation?: number[];
+        weights?: number[];
+    }
+    interface ISampler extends IChildRootProperty {
+        magFilter?: TextureMagFilter;
+        minFilter?: TextureMinFilter;
+        wrapS?: TextureWrapMode;
+        wrapT?: TextureWrapMode;
+    }
+    interface IScene extends IChildRootProperty {
+        nodes: number[];
+    }
+    interface ISkin extends IChildRootProperty {
+        inverseBindMatrices?: number;
+        skeleton?: number;
+        joints: number[];
+    }
+    interface ITexture extends IChildRootProperty {
+        sampler?: number;
+        source: number;
+    }
+    interface ITextureInfo {
+        index: number;
+        texCoord?: number;
+    }
+    interface IGLTF extends IProperty {
+        accessors?: IAccessor[];
+        animations?: IAnimation[];
+        asset: IAsset;
+        buffers?: IBuffer[];
+        bufferViews?: IBufferView[];
+        cameras?: ICamera[];
+        extensionsUsed?: string[];
+        extensionsRequired?: string[];
+        images?: IImage[];
+        materials?: IMaterial[];
+        meshes?: IMesh[];
+        nodes?: INode[];
+        samplers?: ISampler[];
+        scene?: number;
+        scenes?: IScene[];
+        skins?: ISkin[];
+        textures?: ITexture[];
+    }
+}
+
 
 declare module BABYLON {
     /**

dist/preview release/serializers/babylonjs.serializers.module.d.ts

@@ -12,6 +12,255 @@ declare module BABYLON {
     }
 }
 
+declare module BABYLON.GLTF2 {
+    const enum AccessorComponentType {
+        BYTE = 5120,
+        UNSIGNED_BYTE = 5121,
+        SHORT = 5122,
+        UNSIGNED_SHORT = 5123,
+        UNSIGNED_INT = 5125,
+        FLOAT = 5126,
+    }
+    const enum AccessorType {
+        SCALAR = "SCALAR",
+        VEC2 = "VEC2",
+        VEC3 = "VEC3",
+        VEC4 = "VEC4",
+        MAT2 = "MAT2",
+        MAT3 = "MAT3",
+        MAT4 = "MAT4",
+    }
+    const enum AnimationChannelTargetPath {
+        TRANSLATION = "translation",
+        ROTATION = "rotation",
+        SCALE = "scale",
+        WEIGHTS = "weights",
+    }
+    const enum AnimationInterpolation {
+        LINEAR = "LINEAR",
+        STEP = "STEP",
+        CUBICSPLINE = "CUBICSPLINE",
+    }
+    const enum CameraType {
+        PERSPECTIVE = "perspective",
+        ORTHOGRAPHIC = "orthographic",
+    }
+    const enum ImageMimeType {
+        JPEG = "image/jpeg",
+        PNG = "image/png",
+    }
+    const enum MaterialAlphaMode {
+        OPAQUE = "OPAQUE",
+        MASK = "MASK",
+        BLEND = "BLEND",
+    }
+    const enum MeshPrimitiveMode {
+        POINTS = 0,
+        LINES = 1,
+        LINE_LOOP = 2,
+        LINE_STRIP = 3,
+        TRIANGLES = 4,
+        TRIANGLE_STRIP = 5,
+        TRIANGLE_FAN = 6,
+    }
+    const enum TextureMagFilter {
+        NEAREST = 9728,
+        LINEAR = 9729,
+    }
+    const enum TextureMinFilter {
+        NEAREST = 9728,
+        LINEAR = 9729,
+        NEAREST_MIPMAP_NEAREST = 9984,
+        LINEAR_MIPMAP_NEAREST = 9985,
+        NEAREST_MIPMAP_LINEAR = 9986,
+        LINEAR_MIPMAP_LINEAR = 9987,
+    }
+    const enum TextureWrapMode {
+        CLAMP_TO_EDGE = 33071,
+        MIRRORED_REPEAT = 33648,
+        REPEAT = 10497,
+    }
+    interface IProperty {
+        extensions?: {
+            [key: string]: any;
+        };
+        extras?: any;
+    }
+    interface IChildRootProperty extends IProperty {
+        name?: string;
+    }
+    interface IAccessorSparseIndices extends IProperty {
+        bufferView: number;
+        byteOffset?: number;
+        componentType: AccessorComponentType;
+    }
+    interface IAccessorSparseValues extends IProperty {
+        bufferView: number;
+        byteOffset?: number;
+    }
+    interface IAccessorSparse extends IProperty {
+        count: number;
+        indices: IAccessorSparseIndices;
+        values: IAccessorSparseValues;
+    }
+    interface IAccessor extends IChildRootProperty {
+        bufferView?: number;
+        byteOffset?: number;
+        componentType: AccessorComponentType;
+        normalized?: boolean;
+        count: number;
+        type: AccessorType;
+        max?: number[];
+        min?: number[];
+        sparse?: IAccessorSparse;
+    }
+    interface IAnimationChannel extends IProperty {
+        sampler: number;
+        target: IAnimationChannelTarget;
+    }
+    interface IAnimationChannelTarget extends IProperty {
+        node: number;
+        path: AnimationChannelTargetPath;
+    }
+    interface IAnimationSampler extends IProperty {
+        input: number;
+        interpolation?: AnimationInterpolation;
+        output: number;
+    }
+    interface IAnimation extends IChildRootProperty {
+        channels: IAnimationChannel[];
+        samplers: IAnimationSampler[];
+    }
+    interface IAsset extends IChildRootProperty {
+        copyright?: string;
+        generator?: string;
+        version: string;
+        minVersion?: string;
+    }
+    interface IBuffer extends IChildRootProperty {
+        uri?: string;
+        byteLength: number;
+    }
+    interface IBufferView extends IChildRootProperty {
+        buffer: number;
+        byteOffset?: number;
+        byteLength: number;
+        byteStride?: number;
+    }
+    interface ICameraOrthographic extends IProperty {
+        xmag: number;
+        ymag: number;
+        zfar: number;
+        znear: number;
+    }
+    interface ICameraPerspective extends IProperty {
+        aspectRatio: number;
+        yfov: number;
+        zfar: number;
+        znear: number;
+    }
+    interface ICamera extends IChildRootProperty {
+        orthographic?: ICameraOrthographic;
+        perspective?: ICameraPerspective;
+        type: CameraType;
+    }
+    interface IImage extends IChildRootProperty {
+        uri?: string;
+        mimeType?: ImageMimeType;
+        bufferView?: number;
+    }
+    interface IMaterialNormalTextureInfo extends ITextureInfo {
+        scale?: number;
+    }
+    interface IMaterialOcclusionTextureInfo extends ITextureInfo {
+        strength?: number;
+    }
+    interface IMaterialPbrMetallicRoughness {
+        baseColorFactor?: number[];
+        baseColorTexture?: ITextureInfo;
+        metallicFactor?: number;
+        roughnessFactor?: number;
+        metallicRoughnessTexture?: ITextureInfo;
+    }
+    interface IMaterial extends IChildRootProperty {
+        pbrMetallicRoughness?: IMaterialPbrMetallicRoughness;
+        normalTexture?: IMaterialNormalTextureInfo;
+        occlusionTexture?: IMaterialOcclusionTextureInfo;
+        emissiveTexture?: ITextureInfo;
+        emissiveFactor?: number[];
+        alphaMode?: MaterialAlphaMode;
+        alphaCutoff?: number;
+        doubleSided?: boolean;
+    }
+    interface IMeshPrimitive extends IProperty {
+        attributes: {
+            [name: string]: number;
+        };
+        indices?: number;
+        material?: number;
+        mode?: MeshPrimitiveMode;
+        targets?: {
+            [name: string]: number;
+        }[];
+    }
+    interface IMesh extends IChildRootProperty {
+        primitives: IMeshPrimitive[];
+        weights?: number[];
+    }
+    interface INode extends IChildRootProperty {
+        camera?: number;
+        children?: number[];
+        skin?: number;
+        matrix?: number[];
+        mesh?: number;
+        rotation?: number[];
+        scale?: number[];
+        translation?: number[];
+        weights?: number[];
+    }
+    interface ISampler extends IChildRootProperty {
+        magFilter?: TextureMagFilter;
+        minFilter?: TextureMinFilter;
+        wrapS?: TextureWrapMode;
+        wrapT?: TextureWrapMode;
+    }
+    interface IScene extends IChildRootProperty {
+        nodes: number[];
+    }
+    interface ISkin extends IChildRootProperty {
+        inverseBindMatrices?: number;
+        skeleton?: number;
+        joints: number[];
+    }
+    interface ITexture extends IChildRootProperty {
+        sampler?: number;
+        source: number;
+    }
+    interface ITextureInfo {
+        index: number;
+        texCoord?: number;
+    }
+    interface IGLTF extends IProperty {
+        accessors?: IAccessor[];
+        animations?: IAnimation[];
+        asset: IAsset;
+        buffers?: IBuffer[];
+        bufferViews?: IBufferView[];
+        cameras?: ICamera[];
+        extensionsUsed?: string[];
+        extensionsRequired?: string[];
+        images?: IImage[];
+        materials?: IMaterial[];
+        meshes?: IMesh[];
+        nodes?: INode[];
+        samplers?: ISampler[];
+        scene?: number;
+        scenes?: IScene[];
+        skins?: ISkin[];
+        textures?: ITexture[];
+    }
+}
+
 
 declare module BABYLON {
     /**

src/Materials/babylon.material.ts

@@ -22,7 +22,6 @@
 
         /**
          * Specifies if the material needs to be re-calculated.
-         * @returns - Boolean indicating if the material is dirty or not.
          */
         public get isDirty(): boolean {
             return this._isDirty;
@@ -221,7 +220,6 @@
 
         /**
          * Returns the triangle fill mode.
-         * @returns - Number indicating the triangle fill mode.
          */
         public static get TriangleFillMode(): number {
             return Material._TriangleFillMode;
@@ -229,7 +227,6 @@
 
         /**
          * Returns the wireframe mode.
-         * @returns - Number indicating the wireframe mode.
          */
         public static get WireFrameFillMode(): number {
             return Material._WireFrameFillMode;
@@ -237,7 +234,6 @@
 
         /**
          * Returns the point fill mode.
-         * @returns - Number indicating the point fill mode.
          */
         public static get PointFillMode(): number {
             return Material._PointFillMode;
@@ -245,7 +241,6 @@
 
         /**
          * Returns the point list draw mode.
-         * @returns - Number indicating the point list draw mode.
          */
         public static get PointListDrawMode(): number {
             return Material._PointListDrawMode;
@@ -253,7 +248,6 @@
 
         /**
          * Returns the line list draw mode.
-         * @returns - Number indicating the line list draw mode.
          */
         public static get LineListDrawMode(): number {
             return Material._LineListDrawMode;
@@ -261,7 +255,6 @@
 
         /**
          * Returns the line loop draw mode.
-         * @returns - Number indicating the line loop draw mode.
          */
         public static get LineLoopDrawMode(): number {
             return Material._LineLoopDrawMode;
@@ -269,7 +262,6 @@
 
         /**
          * Returns the line strip draw mode.
-         * @returns - Number indicating the line strip draw mode.
          */
         public static get LineStripDrawMode(): number {
             return Material._LineStripDrawMode;
@@ -277,7 +269,6 @@
 
         /**
          * Returns the triangle strip draw mode.
-         * @returns - Number indicating the triangle strip draw mode.
          */
         public static get TriangleStripDrawMode(): number {
             return Material._TriangleStripDrawMode;
@@ -285,7 +276,6 @@
 
         /**
          * Returns the triangle fan draw mode.
-         * @returns - Number indicating the triangle fan draw mode.
          */
         public static get TriangleFanDrawMode(): number {
             return Material._TriangleFanDrawMode;
@@ -303,7 +293,6 @@
 
         /**
          * Returns the clock-wise side orientation.
-         * @returns - Number indicating the clock-wise side orientation.
          */
         public static get ClockWiseSideOrientation(): number {
             return Material._ClockWiseSideOrientation;
@@ -311,7 +300,6 @@
 
         /**
          * Returns the counter clock-wise side orientation.
-         * @returns - Number indicating the counter clock-wise side orientation.
          */
         public static get CounterClockWiseSideOrientation(): number {
             return Material._CounterClockWiseSideOrientation;
@@ -344,7 +332,6 @@
 
         /**
          * Returns the dirty texture flag value.
-         * @returns - Number for the dirty texture flag value.
          */
         public static get TextureDirtyFlag(): number {
             return Material._TextureDirtyFlag;
@@ -352,7 +339,6 @@
 
         /**
          * Returns the dirty light flag value.
-         * @returns - Number for the dirty light flag value.
          */
         public static get LightDirtyFlag(): number {
             return Material._LightDirtyFlag;
@@ -360,7 +346,6 @@
 
         /**
          * Returns the dirty fresnel flag value.
-         * @returns - Number for the dirsty fresnel flag value.
          */
         public static get FresnelDirtyFlag(): number {
             return Material._FresnelDirtyFlag;
@@ -368,7 +353,6 @@
 
         /**
          * Returns the dirty attributes flag value.
-         * @returns - Number for the dirty attribute flag value.
          */
         public static get AttributesDirtyFlag(): number {
             return Material._AttributesDirtyFlag;
@@ -376,7 +360,6 @@
 
         /**
          * Returns the dirty misc flag value.
-         * @returns - Number for the dirty misc flag value.
          */
         public static get MiscDirtyFlag(): number {
             return Material._MiscDirtyFlag;
@@ -431,7 +414,6 @@
 
         /**
          * Gets the alpha value of the material.
-         * @returns - Number of the alpha value.
          */
         public get alpha(): number {
             return this._alpha;
@@ -445,7 +427,6 @@
 
         /**
          * Sets the back-face culling state.
-         * @param value - Booleean specifying if back face culling should be enabled.
          */
         public set backFaceCulling(value: boolean) {
             if (this._backFaceCulling === value) {
@@ -457,7 +438,6 @@
 
         /**
          * Gets the back-face culling state.
-         * @returns - Boolean specifiying if back face culling is enabled.
          */
         public get backFaceCulling(): boolean {
             return this._backFaceCulling;
@@ -557,7 +537,6 @@
 
         /**
          * Sets the value of the alpha mode.
-         * @param value - Number representing the alpha mode.
          */
         public set alphaMode(value: number) {
             if (this._alphaMode === value) {
@@ -569,7 +548,6 @@
 
         /**
          * Gets the value of the alpha mode.
-         * @returns - Number of the alpha mode.
          */
         public get alphaMode(): number {
             return this._alphaMode;
@@ -583,7 +561,6 @@
 
         /**
          * Sets the need depth pre-pass value.
-         * @param value - Boolean specifying if the depth pre-pass is needed.
          */
         public set needDepthPrePass(value: boolean) {
             if (this._needDepthPrePass === value) {
@@ -597,7 +574,6 @@
 
         /**
          * Gets the depth pre-pass value.
-         * @returns - Boolean specifying if the depth pre-pass is needed.
          */
         public get needDepthPrePass(): boolean {
             return this._needDepthPrePass;
@@ -629,7 +605,6 @@
 
         /**
          * Sets the state for enabling fog.
-         * @param value - Boolean specifying if fog should be enabled.
          */
         public set fogEnabled(value: boolean) {
             if (this._fogEnabled === value) {
@@ -641,7 +616,6 @@
 
         /**
          * Gets the value of the fog enabled state.
-         * @returns - Boolean indicating the fog enabled state.
          */
         public get fogEnabled(): boolean {
             return this._fogEnabled;
@@ -661,7 +635,6 @@
 
         /**
          * Gets a value specifying if wireframe mode is enabled.
-         * @returns - Boolean specifying if wireframe is enabled. 
          */
         @serialize()
         public get wireframe(): boolean {
@@ -670,7 +643,6 @@
 
         /**
          * Sets the state of wireframe mode.
-         * @param value - Boolean specifying if wireframe is enabled.
          */
         public set wireframe(value: boolean) {
             this._fillMode = (value ? Material.WireFrameFillMode : Material.TriangleFillMode);
@@ -678,7 +650,6 @@
 
         /**
          * Gets the value specifying if point clouds are enabled.
-         * @returns - Boolean specifying if point clouds are enabled.
          */
         @serialize()
         public get pointsCloud(): boolean {
@@ -687,7 +658,6 @@
 
         /**
          * Sets the state of point cloud mode.
-         * @param value - Boolean specifying if point clouds are enabled.
          */
         public set pointsCloud(value: boolean) {
             this._fillMode = (value ? Material.PointFillMode : Material.TriangleFillMode);
@@ -695,7 +665,6 @@
 
         /**
          * Gets the material fill mode.
-         * @returns - Number specifying the fill mode.
          */
         @serialize()
         public get fillMode(): number {
@@ -704,7 +673,6 @@
 
         /**
          * Sets the material fill mode.
-         * @param value - Number specifying the material fill mode.
          */
         public set fillMode(value: number) {
             if (this._fillMode === value) {