gs-json/dist/src/typescript/ifaces_gs.d.ts

gs-JSON is a domain agnostic unifying 3D file format for geometric and semantic modelling (hence the 'gs').

import * as three from "three";
import { EGeomType, EDataType, EObjType } from "./enums";
import { IModelData, ITopoPathData } from "./ifaces_json";
export declare type XYZ = [number, number, number];
/**
 * Interface, the main model class.
 */
export interface IModel {
    getGeom(): IGeom;
    findAttribs(attrib_type: EGeomType): IEntAttrib[] | ITopoAttrib[];
    getAllAttribs(): [IEntAttrib[], ITopoAttrib[]];
    getEntAttrib(name: string, attrib_type: EGeomType): IEntAttrib;
    getAllEntAttribs(): IEntAttrib[];
    addEntAttrib(name: string, attrib_type: EGeomType, data_type: EDataType): IEntAttrib;
    getTopoAttrib(name: string, attrib_type: EGeomType): ITopoAttrib;
    getAllTopoAttribs(): ITopoAttrib[];
    addTopoAttrib(name: string, attrib_type: EGeomType, data_type: EDataType): ITopoAttrib;
    delAttrib(attrib: IAttrib): boolean;
    hasAttrib(attrib: IAttrib): boolean;
    setAttribName(attrib: IAttrib, new_name: string): boolean;
    getAllGroups(): IGroup[];
    getGroup(name: string): IGroup;
    addGroup(name: string, parent?: IGroup): IGroup;
    delGroup(group: IGroup): boolean;
    hasGroup(group: IGroup): boolean;
    setGroupName(group: IGroup, new_name: string): boolean;
    merge(model: IModel): void;
    purge(): void;
    validate(): boolean;
    toModelData(): IModelData;
    toJSON(): string;
    toString(): string;
}
/**
 * Interface, for the Geom class, that gives access to geometry in the model.
 */
export interface IGeom {
    copyRayFromModel(ray: IRay): IRay;
    copyPlaneFromModel(plane: IPlane): IPlane;
    copyCircleFromModel(circle: ICircle): ICircle;
    copyPlineFromModel(pline: IPolyline): IPolyline;
    copyPmeshFromModel(pline: IPolymesh): IPolymesh;
    copyObjFromModel(obj: IObj): IObj;
    copyObjsFromModel(objs: IObj[]): IObj[];
    addPoint(xyz: XYZ): IPoint;
    addPoints(xyz_arr: XYZ[]): IPoint[];
    addRay(origin_point: IPoint, ray_vec: XYZ): IRay;
    addPlane(origin_point: IPoint, x_vec: XYZ, y_vec: XYZ): IPlane;
    addCircle(origin_point: IPoint, x_vec: XYZ, y_vec: XYZ, angles?: [number, number]): any;
    addPolyline(wire_points: IPoint[], is_closed: boolean): IPolyline;
    addPolymesh(face_points: IPoint[][]): IPolymesh;
    getAllPoints(): IPoint[];
    getPoints(point_ids: number[]): IPoint[];
    getPoint(point_id: number): IPoint;
    delPoints(points: IPoint[]): boolean;
    delPoint(point: IPoint): boolean;
    numPoints(): number;
    mergePoints(points: IPoint[], tolerance?: number): IPoint[];
    mergeAllPoints(tolerance: number): IPoint[];
    copyPoints(points: IPoint[], copy_attribs: boolean): IPoint[];
    xformPoints(points: IPoint[], matrix: three.Matrix4): void;
    findObjs(obj_type?: EObjType): IObj[];
    getAllObjs(): IObj[];
    getObjs(obj_ids: number[]): IObj[];
    getObj(obj_id: number): IObj;
    delObjs(objs: IObj[], keep_points: boolean): boolean;
    delObj(obj: IObj, keep_points: boolean): boolean;
    numObjs(): number;
    unweldObjs(objs: IObj[]): IPoint[];
    copyObjs(objs: IObj[], copy_attribs: boolean): IObj[];
    xformObjs(objs: IObj[], matrix: three.Matrix4): void;
    getTopos(topo_type: EGeomType): (IVertex[] | IEdge[] | IWire[] | IFace[]);
    numTopos(topo_type: EGeomType): number;
    getTopo(path: ITopoPathData): IVertex | IEdge | IWire | IFace;
    getTopoFromLabel(path_str: string): IVertex | IEdge | IWire | IFace;
}
/**
 * Interface, for the abstract Ent class, that represents any geometric entity.
 * The Ent class cannot be instantiated.
 */
export interface IEnt {
    getModel(): IModel;
    getGeom(): IGeom;
    getID(): number;
    exists(): boolean;
    getGeomType(): EGeomType;
    getLabel(): string;
    getLabelCentroid(): XYZ;
    copy(copy_attribs?: boolean): IEnt;
    xform(matrix: three.Matrix4): void;
    getAttribs(): IEntAttrib[] | ITopoAttrib[];
    getAttribValue(attrib: IEntAttrib): any;
    setAttribValue(attrib: IEntAttrib, value: any): any;
    getGroups(): IGroup[];
    addToGroup(group: IGroup): boolean;
    toString(): string;
}
/**
 * Interface, for the Point class, that represents a 3D point with xyz coords.
 */
export interface IPoint extends IEnt {
    getPosition(): XYZ;
    setPosition(xyz: XYZ): XYZ;
    getVertices(): IVertex[];
    copy(copy_attribs?: boolean): IPoint;
}
/**
 * Interface, for the abstract Obj class, that represents a geometric object.
 * Subclasses such as Polyline and polymesh can be instantiated.
 */
export interface IObj extends IEnt {
    getObjType(): EObjType;
    getPoints(point_type?: EGeomType.wires | EGeomType.faces): IPoint[][][];
    getPointsArr(): IPoint[];
    getPointsSet(): IPoint[];
    getVertices(vertex_type?: EGeomType.wires | EGeomType.faces): IVertex[][][];
    getEdges(edge_type?: EGeomType.wires | EGeomType.faces): IEdge[][][];
    getWires(): IWire[];
    getFaces(): IFace[];
    numWireVertices(): number;
    numFaceVertices(): number;
    numWireEdges(): number;
    numFaceEdges(): number;
    getWirePoints(): IPoint[];
    getFacePoints(): IPoint[];
    numWires(): number;
    numFaces(): number;
    copy(copy_attribs?: boolean): IObj;
}
/**
 * Interface, for a Ray class.
 */
export interface IRay extends IObj {
    getObjType(): EObjType;
    getOrigin(): IPoint;
    getVector(): XYZ;
}
/**
 * Interface, for a Plane class.
 */
export interface IPlane extends IObj {
    getObjType(): EObjType;
    getOrigin(): IPoint;
    getAxes(): [XYZ, XYZ, XYZ];
    getNormal(): XYZ;
    setOrientation(x_vec: XYZ, vec: XYZ): void;
    getCartesians(): number[];
}
/**
 * Interface, for a Circle class.
 */
export interface ICircle extends IObj {
    getObjType(): EObjType;
    isClosed(): boolean;
    getOrigin(): IPoint;
    getAxes(): [XYZ, XYZ, XYZ];
    getNormal(): XYZ;
    setOrientation(x_vec: XYZ, vec: XYZ): void;
    getAngles(): [number, number];
    setAngles(angles: [number, number]): void;
    getRadius(): number;
    setRadius(radius: number): number;
    length(): number;
    evalParam(t: number): IPoint;
    evalParamTangent(t: number): XYZ;
    evalPoint(point: IPoint): number;
    equiPoints(num_points: number): IPoint[];
}
/**
 * Interface, for a Ellipse class.
 */
export interface IEllipse extends IObj {
    getObjType(): EObjType;
    isClosed(): boolean;
    getOrigin(): IPoint;
    getAxes(): [XYZ, XYZ, XYZ];
    getNormal(): XYZ;
    setOrientation(x_vec: XYZ, vec: XYZ): void;
    getRadii(): [number, number];
    getAngles(): [number, number];
    setAngles(angles: [number, number]): void;
}
/**
 * Interface, for a Hyperbola class.
 */
export interface IHyperbola extends IObj {
    getObjType(): EObjType;
    getOrigin(): IPoint;
    getVectors(): XYZ[];
    setVectors(x_vec: XYZ, y_vec: XYZ): void;
    getAngles(): [number, number];
    setAngles(angles: [number, number]): void;
    getRadii(): [number, number];
    length(): number;
    evalParam(t: number): IPoint;
    equiPoints(num_points: number): IPoint[];
}
/**
 * Interface, for a Polyline class.
 */
export interface IPolyline extends IObj {
    getObjType(): EObjType;
    isClosed(): boolean;
    setIsClosed(is_closed: boolean): boolean;
    numVertices(): number;
    numEdges(): number;
    insertVertex(edge: IEdge, point: IPoint): IVertex;
    addVertex(point: IPoint, to_start: boolean): IVertex;
    delVertex(vertex: IVertex): IVertex;
}
/**
 * Interface, for a Polymesh class.
 */
export interface IPolymesh extends IObj {
    getObjType(): EObjType;
    isClosed(): boolean;
}
/**
 * Interface, for Topo abstract class, that represents any topological component.
 */
export interface ITopo {
    exists(): boolean;
    getModel(): IModel;
    getGeom(): IGeom;
    getObjID(): number;
    getObj(): IObj;
    getGeomType(): EGeomType;
    getTopoPath(): ITopoPathData;
    getTopoPathStr(): string;
    getLabel(): string;
    getLabelCentroid(): XYZ;
    getAttribs(): ITopoAttrib[];
    setAttribValue(attrib: ITopoAttrib, value: any): any;
    getAttribValue(attrib: ITopoAttrib): any;
    getGroups(): IGroup[];
    addToGroup(group: IGroup): boolean;
}
/**
 * Interface, for Vertex class.
 */
export interface IVertex extends ITopo {
    getPoint(): IPoint;
    getEdge(): IEdge;
    getWireOrFace(): IWire | IFace;
    next(): IVertex;
    previous(): IVertex;
    verticesSharedPoint(): IVertex[][];
}
/**
 * Interface, for Edge class.
 */
export interface IEdge extends ITopo {
    getVertices(): IVertex[];
    getWireOrFace(): IWire | IFace;
    next(): IEdge;
    previous(): IEdge;
    edgesSharedPoints(): IEdge[][];
}
/**
 * Interface, for Wire class.
 */
export interface IWire extends ITopo {
    getVertices(): IVertex[];
    getEdges(): IEdge[];
    numVertices(): number;
    numEdges(): number;
    isClosed(): boolean;
    wiresSharedPoints(): IWire[];
}
/**
 * Interface, for Face class.
 */
export interface IFace extends ITopo {
    getVertices(): IVertex[];
    getEdges(): IEdge[];
    numVertices(): number;
    numEdges(): number;
    isClosed(): boolean;
    facesSharedPoints(num_shared_points?: number): IFace[];
}
/**
 * Interface, for Attrib class.
 */
export interface IAttrib {
    exists(): boolean;
    getModel(): IModel;
    getGeom(): IGeom;
    getName(): string;
    setName(name: string): string;
    getGeomType(): EGeomType;
    getDataType(): EDataType;
    count(): number;
    getValues(): any[];
    getLabels(): string[];
}
export interface IEntAttrib extends IAttrib {
    getIDs(): number[];
    getEnts(): IPoint[] | IObj[];
}
export interface ITopoAttrib extends IAttrib {
    getPaths(): ITopoPathData[];
    getTopos(): IVertex[] | IEdge[] | IWire[] | IFace[];
}
/**
 * Interface, for Group class.
 */
export interface IGroup {
    exists(): boolean;
    getModel(): IModel;
    getGeom(): IGeom;
    getName(): string;
    setName(name: string): string;
    getParentGroup(): IGroup;
    getChildGroups(): IGroup[];
    setParentGroup(group: IGroup): IGroup;
    removeParentGroup(): IGroup;
    getObjs(obj_type?: EObjType): IObj[];
    addObj(obj: IObj): boolean;
    addObjs(objs: IObj[]): boolean;
    removeObj(obj: IObj): boolean;
    removeObjs(objs: IObj[]): boolean;
    hasObj(obj: IObj): boolean;
    getTopos(geom_type?: EGeomType): ITopo[];
    addTopo(path: ITopo): boolean;
    addTopos(paths: ITopo[]): boolean;
    removeTopo(path: ITopo): boolean;
    removeTopos(paths: ITopo[]): boolean;
    hasTopo(path: ITopo): boolean;
    getPoints(): IPoint[];
    addPoint(point: IPoint): boolean;
    addPoints(points: IPoint[]): boolean;
    removePoint(point: IPoint): boolean;
    removePoints(points: IPoint[]): boolean;
    hasPoint(point: IPoint): boolean;
    getProps(): Array<[string, any]>;
    setProps(new_Map: Array<[string, any]>): Array<[string, any]>;
    toString(): string;
}