UNPKG

1.06 kBTypeScriptView Raw
1import { PolyhedronGeometry } from "./PolyhedronGeometry.js";
2
3/**
4 * A class for generating an octahedron geometry.
5 * @see {@link https://threejs.org/docs/index.html#api/en/geometries/OctahedronGeometry | Official Documentation}
6 * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/OctahedronGeometry.js | Source}
7 */
8export class OctahedronGeometry extends PolyhedronGeometry {
9 /**
10 * Create a new instance of {@link OctahedronGeometry}
11 * @param radius Radius of the octahedron. Expects a `Float`. Default `1`
12 * @param detail Setting this to a value greater than zero add vertices making it no longer an octahedron. Expects a `Integer`. Default `0`
13 */
14 constructor(radius?: number, detail?: number);
15
16 /**
17 * A Read-only _string_ to check if `this` object type.
18 * @remarks Sub-classes will update this value.
19 * @defaultValue `OctahedronGeometry`
20 */
21 override readonly type: string | "OctahedronGeometry";
22
23 /** @internal */
24 static fromJSON(data: {}): OctahedronGeometry;
25}