diff --git a/packages/geom-api/.npmignore b/packages/geom-api/.npmignore new file mode 100644 index 0000000000..74ea62d1fa --- /dev/null +++ b/packages/geom-api/.npmignore @@ -0,0 +1,12 @@ +.meta +.nyc_output +*.html +*.tgz +build +coverage +dev +doc +export +src* +test +tsconfig.json diff --git a/packages/geom-api/LICENSE b/packages/geom-api/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/geom-api/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/geom-api/README.md b/packages/geom-api/README.md new file mode 100644 index 0000000000..094e452632 --- /dev/null +++ b/packages/geom-api/README.md @@ -0,0 +1,40 @@ +# @thi.ng/geom-api + +[![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/geom-api.svg)](https://www.npmjs.com/package/@thi.ng/geom-api) +![npm downloads](https://img.shields.io/npm/dm/@thi.ng/geom-api.svg) +[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella) + +This project is part of the +[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo. + + + + + +## About + +TODO... + +## Installation + +```bash +yarn add @thi.ng/geom-api +``` + +## Dependencies + +- TODO... + +## Usage examples + +```ts +import * as ga from "@thi.ng/geom-api"; +``` + +## Authors + +- Karsten Schmidt + +## License + +© 2018 Karsten Schmidt // Apache Software License 2.0 diff --git a/packages/geom-api/package.json b/packages/geom-api/package.json new file mode 100644 index 0000000000..19826b5d37 --- /dev/null +++ b/packages/geom-api/package.json @@ -0,0 +1,46 @@ +{ + "name": "@thi.ng/geom-api", + "version": "0.0.1", + "description": "TODO", + "module": "./index.js", + "main": "./lib/index.js", + "umd:main": "./lib/index.umd.js", + "typings": "./index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/thi-ng/umbrella.git" + }, + "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/geom-api", + "author": "Karsten Schmidt ", + "license": "Apache-2.0", + "scripts": { + "build": "yarn clean && yarn build:es6 && yarn build:bundle", + "build:es6": "tsc --declaration", + "build:bundle": "../../scripts/bundle-module", + "test": "rimraf build && tsc -p test/tsconfig.json && nyc mocha build/test/*.js", + "clean": "rimraf *.js *.d.ts .nyc_output build coverage doc lib", + "cover": "yarn test && nyc report --reporter=lcov", + "doc": "node_modules/.bin/typedoc --mode modules --out doc src", + "pub": "yarn build && yarn publish --access public" + }, + "devDependencies": { + "@types/mocha": "^5.2.5", + "@types/node": "^10.12.15", + "mocha": "^5.2.0", + "nyc": "^13.1.0", + "typedoc": "^0.14.0", + "typescript": "^3.2.2" + }, + "dependencies": { + "@thi.ng/api": "^5.0.1", + "@thi.ng/vectors": "^2.1.0" + }, + "keywords": [ + "ES6", + "typescript" + ], + "publishConfig": { + "access": "public" + }, + "sideEffects": false +} \ No newline at end of file diff --git a/packages/geom-api/src/index.ts b/packages/geom-api/src/index.ts new file mode 100644 index 0000000000..141555e8aa --- /dev/null +++ b/packages/geom-api/src/index.ts @@ -0,0 +1,153 @@ +import { ICopy, IObjectOf, IToHiccup } from "@thi.ng/api"; +import { ReadonlyVec, Vec } from "@thi.ng/vectors"; + +export const DEFAULT_SAMPLES = 20; + +export const enum SegmentType { + MOVE, + LINE, + POLYLINE, + ARC, + CUBIC, + QUADRATIC, + CLOSE, +} + +export const enum Type { + AABB = 1, + ARC, + CIRCLE, + CUBIC, + CUBIC3, + ELLIPSE, + GROUP, + LINE, + LINE3, + PATH, + POINTS, + POINTS3, + POLYGON, + POLYGON3, + POLYLINE, + POLYLINE3, + QUAD, + QUAD3, + QUADRATIC, + QUADRATIC3, + RECT, + SPHERE, + TRIANGLE, + TRIANGLE3, + RAY, + RAY3, +} + +export type Attribs = IObjectOf; + +export type Tessellator = (points: ReadonlyVec[]) => Vec[][]; + +export interface IShape extends + ICopy { + + readonly type: number | string; + attribs?: Attribs; +} + +export interface AABBLike extends IShape { + pos: Vec; + size: Vec; + + max(): Vec; +} + +export interface SphereLike extends IShape { + pos: Vec; + r: number; +} + +export interface IHiccupShape extends IShape, IToHiccup { +} + +export interface IHiccupPathSegment { + toHiccupPathSegments(): any[]; +} + +export interface PathSegment { + type: SegmentType; + point?: Vec; + geo?: IShape & IHiccupPathSegment; +} + +export interface PCLike extends IShape { + points: Vec[]; +} + +export interface PCLikeConstructor { + new(pts: Vec[], attribs: Attribs): PCLike; +} + +export interface SamplingOpts { + /** + * Number of points to sample & return. Defaults to the implementing + * type's `DEFAULT_RES` if neither this nor `theta` option is given. + */ + num: number; + /** + * Defines the target angle between sampled points. If greater than + * the actual range of the arc, only the two end points will be + * returned at most. This option is used to derive a `num` value and + * takes priority if `num` is given as well. + * + * This option is useful to adapt the sampling based on angular + * resolution, rather than a fixed number of samples. + */ + theta: number; + /** + * Approximate desired distance between sampled result points. If + * given, takes priority over the `num` option, but the latter MIGHT + * be used as part of the sampling process (implementation + * specific). + */ + dist: number; + /** + * If `true`, the shape's end point will be included in the result + * array. The default setting for open geometries is `true`, for + * closed ones `false`. This option has no influence on any internal + * resolution calculation. + * + * For open geometry this option is useful to when re-sampling paths + * of consecutive segments, where the end points of each segment + * coincide with the start points of the next segment. For all but + * the last segment, this option should be `false` and so can be + * used to avoid duplicate vertices in the concatenated result. + * + * When sampling closed shapes, enabling this option will include an + * extra point (start), i.e. if the `num` option was given, results + * in `num+1` points. + */ + last: boolean; +} + +export interface SubdivKernel { + fn: (pts: ReadonlyVec[], i: number, nump: number) => Vec[]; + iter?: (pts: ReadonlyVec[]) => Iterable; + size: number; +} + +export const enum IntersectionType { + NONE, + PARALLEL, + COINCIDENT, + COINCIDENT_NO_INTERSECT, + INTERSECT, + INTERSECT_OUTSIDE, +} + +export interface IntersectionResult { + type: IntersectionType; + isec?: Vec | Vec[]; + det?: number; + alpha?: number; + beta?: number; + inside?: boolean; +} diff --git a/packages/geom-api/test/index.ts b/packages/geom-api/test/index.ts new file mode 100644 index 0000000000..1eb82fd2ef --- /dev/null +++ b/packages/geom-api/test/index.ts @@ -0,0 +1,6 @@ +// import * as assert from "assert"; +// import * as ga from "../src/index"; + +describe("geom-api", () => { + it("tests pending"); +}); diff --git a/packages/geom-api/test/tsconfig.json b/packages/geom-api/test/tsconfig.json new file mode 100644 index 0000000000..f6e63560dd --- /dev/null +++ b/packages/geom-api/test/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "outDir": "../build", + "module": "commonjs" + }, + "include": [ + "./**/*.ts", + "../src/**/*.ts" + ] +} diff --git a/packages/geom-api/tsconfig.json b/packages/geom-api/tsconfig.json new file mode 100644 index 0000000000..893b9979c5 --- /dev/null +++ b/packages/geom-api/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": ".", + "module": "es6", + "target": "es6" + }, + "include": [ + "./src/**/*.ts" + ] +}