Merge pull request #280 from WhitestormJS/#278

PR for #278

Author: hirako2000

types/modules/index.d.ts

@@ -0,0 +1 @@
+export * from "./mesh";

types/modules/mesh/AnimationModule.d.ts

@@ -0,0 +1,27 @@
+import {App} from '../../core';
+
+interface AnimationModuleParams {
+
+  /**
+   * Speed of the playing animation.
+   * Defalt is 1 (default animation frames).
+   */
+  speed?: number
+} 
+
+export class AnimationModule {
+
+  /**
+   * @constructor Creates an animation module.
+   * @param app the app.
+   * @param isDeferred sets whether to defer the start of the loop, default is false.
+   * @param params the parameters.
+   */
+  constructor(app: App, isDeferred?: boolean, params?: AnimationModuleParams);
+
+  /**
+   * Plays the given clip name
+   * @param clipName - the clip name to play
+   */
+  play(clipName: string): void;
+}

types/modules/mesh/DynamicGeometryModule.d.ts

@@ -0,0 +1,25 @@
+import {App} from '../../core';
+
+interface DynamicGeometryParams {
+
+  /**
+   * Sets whether to use attributes.
+   * Default is false.
+   */
+  attributes?: boolean,
+
+  /**
+   * TODO alex to explain
+   * Map of geometry parameters
+   */
+  geometry?: Map
+} 
+
+export class DynamicGeometryModule {
+
+  /**
+   * @constructor Creates a dynamic geometry module.
+   * @param params the parameters.
+   */
+  constructor(params?: DynamicGeometryParams);
+}

types/modules/mesh/TextureModule.d.ts

@@ -0,0 +1,70 @@
+import {
+  ClampToEdgeWrapping,
+  MirroredRepeatWrapping,
+  RepeatWrapping,
+  UVMapping,
+  Vector2
+  } from 'three';
+import {App} from '../../core';
+
+/**
+ * Texture properties
+ */
+interface TextureParams {
+
+  /**
+   * The path to the texture (e.g URL)
+   */
+  url: string,
+
+  /**
+   * The type of map (e.g bumpMap)
+   * Default is map
+   */
+  type?: string,
+
+  /**
+   * Offset of the texture.
+   * Default is Vector2(0, 0)
+   */
+  offset?: Vector2,
+
+  /**
+   * Repeat
+   * Default is Vector2(1, 1)
+   */
+  repeat?: Vector2,
+  
+  /**
+   * Sets wrapS and wrapT.
+   * This defines how the texture is wrapped horizontally and vertically, corresponds to UV mapping.
+   * Default is RepeatWrapping.
+   */
+  wrap?: ClampToEdgeWrapping | MirroredRepeatWrapping | RepeatWrapping | any[],
+
+  /**
+   * How the image is applied to the object. 
+   * An object type of THREE.UVMapping is the default, where the U,V coordinates are used to apply the map.
+   */
+  mapping?: UVMapping,
+
+  /** 
+   * Function to set more granular parameters
+   * e.g const fix = texture => {
+   *   texture.anisotropy = 2;
+   *   texture.magFilter = THREE.LinearFilter;
+   *   texture.minFilter = THREE.LinearMipMapLinearFilter;
+   *   return texture;
+   * };
+   */
+  fix?: Function
+} 
+
+export class TextureModule {
+
+  /**
+   * @constructor Creates a texture module.
+   * @param textures the texture(s) properties
+   */
+  constructor(textures: TextureParams | TextureParams[]);
+}

types/modules/mesh/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./AnimationModule";
+export * from "./DynamicGeometryModule";
+export * from "./TextureModule";

types/whs-tests.ts

@@ -27,6 +27,10 @@ import {
   SpotLight
 } from './components/lights';
 
+import {
+  TextureModule,
+} from './modules/mesh';
+
 
 // Core
 const app = new App();
@@ -151,3 +155,16 @@ pointLight.addTo(app);
 const spotLight = new SpotLight({build: false});
 spotLight.build();
 spotLight.addTo(app);
+
+// Mesh Modules
+
+let textureModule = new TextureModule([{
+    url: 'some/path',
+    type: 'map'
+  }]
+);
+textureModule = new TextureModule({
+    url: 'some/path',
+    type: 'bumpMap'
+  }
+);