whs/types/components/meshes/Dodecahedron.d.ts

Super-fast 3D framework for Web Applications & Games. Based on Three.js

import {
  MeshComponent,
  MeshComponentParams
} from '../../core/MeshComponent';

import {
  BufferGeometry,
  DodecahedronGeometry,
  Geometry,
  Mesh
} from 'three';

/**
 * this is missing in @types from three.js :(
 * 
 * @export interface DodecahedronBufferGeometry
 * @extends {Geometry}
 */
export interface DodecahedronBufferGeometry extends BufferGeometry {
    constructor(radius: number, detail: number): DodecahedronBufferGeometry;

    geometry?: {
        radius: number;
        detail: number;
    };
}

export interface DodecahedronParams extends MeshComponentParams {

  /** Geometry parameters */
  geometry?: {

    /**
     * Radius/
     */
    radius?: number;

    /**
     * Detail level.
     */
    detail?: number;
  };

  /**
   * Whether to create buffered geometry or not.
   * Default is false.
   */
  buffer?: boolean;
}

 export class Dodecahedron extends MeshComponent {

   /**
    * @description Creates a Dodecahedron.
    * @constructor
    * @param params
    */
   constructor(params?: DodecahedronParams);

   /**
    * Build lifecycle creates a mesh using input params.
    * @param params 
    */
   build(params?: DodecahedronParams): Mesh;

   /**
    * Build the geometry
    * @param params 
    */
   buildGeometry(params?: DodecahedronParams): DodecahedronGeometry | DodecahedronBufferGeometry;
}