Geom | gs-json

Class Geom

Hierarchy

Geom

Implements

IGeom

Index

Constructors

constructor

Properties

_kernel

Constructors

constructor

new Geom(kernel: Kernel): Geom

- Defined in geom.ts:22
Create a new Geom object from the Kernel.

Parameters
- kernel: Kernel
Returns Geom

Properties

Private _kernel

_kernel: Kernel

Methods

addCircle

addCircle(origin_point: IPoint, x_vec: XYZ, vec: XYZ, angles?: [number, number]): ICircle

Implementation of IGeom.addCircle
- Defined in geom.ts:213
Adds a new circle to the model.

Parameters
- origin_point: IPoint
- x_vec: XYZ
  
  A vector in the local x direction, also defines the raidus.
- vec: XYZ
  
  A vector in the plane
- Optional angles: [number, number]
  
  The angles, can be undefined, in which case a closed conic is generated.
Returns ICircle

Object of type Circle

addEllipse

addEllipse(origin_point: IPoint, x_vec: XYZ, vec: XYZ, angles?: [number, number]): IEllipse

Implementation of IGeom.addEllipse
- Defined in geom.ts:232
Adds a new ellipse to the model.

Parameters
- origin_point: IPoint
- x_vec: XYZ
  
  A vector defining the radius in the local x direction.
- vec: XYZ
- Optional angles: [number, number]
  
  The angles, can be undefined, in which case a closed conic is generated.
Returns IEllipse

Object of type Ellipse

addPlane

addPlane(origin_point: IPoint, x_vec: XYZ, vec: XYZ): IPlane

Implementation of IGeom.addPlane
- Defined in geom.ts:196
Adds a new plane to the model.

Parameters
- origin_point: IPoint
  
  The plane origin point.
- x_vec: XYZ
  
  A vector defining the x axis.
- vec: XYZ
  
  A vector in the plane.
Returns IPlane

Object of type Plane

addPoint

addPoint(xyz: XYZ): IPoint

Implementation of IGeom.addPoint
- Defined in geom.ts:164
Adds a new point to the model at position xyz.

Parameters
- xyz: XYZ
  
  xyz coordinates are required to create a point
Returns IPoint

A point instance.

addPoints

addPoints(xyz_arr: XYZ[]): IPoint[]

Implementation of IGeom.addPoints
- Defined in geom.ts:174
Adds a set of new points to the model, from an array of xyz coordinates.

Parameters
- xyz_arr: XYZ[]
Returns IPoint[]

An array Point instances.

addPolyline

addPolyline(points: IPoint[], is_closed: boolean): IPolyline

Implementation of IGeom.addPolyline
- Defined in geom.ts:249
Adds a new polyline to the model.

Parameters
- points: IPoint[]
  
  A collection of Points.
- is_closed: boolean
  
  True if the polyline is closed.
Returns IPolyline

Object of type Polyline

addPolymesh

addPolymesh(face_points: IPoint[][]): IPolymesh

Implementation of IGeom.addPolymesh
- Defined in geom.ts:260
Adds a new polymesh to the model.

Parameters
- face_points: IPoint[][]
  
  An array of arrays of points.
Returns IPolymesh

Object of type Polymesh

addRay

addRay(origin_point: IPoint, ray_vec: XYZ): IRay

Implementation of IGeom.addRay
- Defined in geom.ts:184
Adds a new ray to the model.

Parameters
- origin_point: IPoint
  
  The ray origin point.
- ray_vec: XYZ
  
  A vector defining the direction of the ray.
Returns IRay

Object of type Ray

copyCircleFromModel

copyCircleFromModel(circle: ICircle): ICircle

Implementation of IGeom.copyCircleFromModel
- Defined in geom.ts:92
Copies a circle to the model.

Parameters
- circle: ICircle
  
  The circle to copy.
Returns ICircle

Object of type Circle

copyObjFromModel

copyObjFromModel(obj: IObj): IObj

Implementation of IGeom.copyObjFromModel
- Defined in geom.ts:129
Copies an obj to the model.

Parameters
- obj: IObj
  
  The obj to copy.
Returns IObj

Object

copyObjsFromModel

copyObjsFromModel(objs: IObj[]): IObj[]

Implementation of IGeom.copyObjsFromModel
- Defined in geom.ts:151
Copies an array of objs to the model.

Parameters
- objs: IObj[]
  
  The objs to copy.
Returns IObj[]

Object

copyPlaneFromModel

copyPlaneFromModel(plane: IPlane): IPlane

Implementation of IGeom.copyPlaneFromModel
- Defined in geom.ts:76
Copies a plane to the model.

Parameters
- plane: IPlane
  
  The plane to copy.
Returns IPlane

Object of type Plane

copyPlineFromModel

copyPlineFromModel(pline: IPolyline): IPolyline

Implementation of IGeom.copyPlineFromModel
- Defined in geom.ts:109
Copies a polyline to the model.

Parameters
- pline: IPolyline
Returns IPolyline

Object of type Polyline

copyPmeshFromModel

copyPmeshFromModel(pline: IPolymesh): IPolymesh

Implementation of IGeom.copyPmeshFromModel
- Defined in geom.ts:119
Copies a polyline to the model.

Parameters
- pline: IPolymesh
Returns IPolymesh

Object of type Polyline

copyPointFromModel

copyPointFromModel(point: IPoint): IPoint

- Defined in geom.ts:40
Copies a point from another model to thid model.

Parameters
- point: IPoint
  
  The point to copy
Returns IPoint

A new point.

copyPointsFromModel

copyPointsFromModel(points: IPoint[]): IPoint[]

- Defined in geom.ts:50
Copies a set of new points to the model, from an array of xyz coordinates.

Parameters
- points: IPoint[]
  
  An array of points to copy.
Returns IPoint[]

An array of new points.

copyRayFromModel

copyRayFromModel(ray: IRay): IRay

Implementation of IGeom.copyRayFromModel
- Defined in geom.ts:60
Copies a ray to the model.

Parameters
- ray: IRay
  
  The ray to copy.
Returns IRay

Object of type Ray

delObj

delObj(obj: IObj, keep_points?: boolean): boolean

Implementation of IGeom.delObj
- Defined in geom.ts:398
Delete a single object.

Parameters
- obj: IObj
- Default value keep_points: boolean = true
Returns boolean

delObjs

delObjs(objs: IObj[], keep_points?: boolean): boolean

Implementation of IGeom.delObjs
- Defined in geom.ts:389
Delete an array of objects.

Parameters
- objs: IObj[]
- Default value keep_points: boolean = true
Returns boolean

delPoint

delPoint(point: IPoint): boolean

Implementation of IGeom.delPoint
- Defined in geom.ts:310
Delete a single point.

Parameters
- point: IPoint
Returns boolean

delPoints

delPoints(points: IPoint[]): boolean

Implementation of IGeom.delPoints
- Defined in geom.ts:301
Delete a set of points.

Parameters
- points: IPoint[]
Returns boolean

findObjs

findObjs(obj_type?: EObjType): IObj[]

Implementation of IGeom.findObjs
- Defined in geom.ts:353
Find certain types of objects in the model.

Parameters
- Optional obj_type: EObjType
Returns IObj[]

getAllObjs

getAllObjs(): IObj[]

Implementation of IGeom.getAllObjs
- Defined in geom.ts:362
Get all the object in the model.

Returns IObj[]

getAllPoints

getAllPoints(): IPoint[]

Implementation of IGeom.getAllPoints
- Defined in geom.ts:273
Get all the points in this model.

Returns IPoint[]

getObj

getObj(id: number): IObj

Implementation of IGeom.getObj
- Defined in geom.ts:380
Get a single object from an ID.

Parameters
- id: number
Returns IObj

getObjs

getObjs(ids: number[]): IObj[]

Implementation of IGeom.getObjs
- Defined in geom.ts:371
Get an array of objects from an array of IDs.

Parameters
- ids: number[]
Returns IObj[]

getPoint

getPoint(id: number): IPoint

Implementation of IGeom.getPoint
- Defined in geom.ts:292
Get a single point from an ID.

Parameters
- id: number
Returns IPoint

getPoints

getPoints(ids: number[]): IPoint[]

Implementation of IGeom.getPoints
- Defined in geom.ts:283
Get a set of points from an array of IDs.

Parameters
- ids: number[]
Returns IPoint[]

getTopo

getTopo(path: ITopoPathData): IVertex | IEdge | IWire | IFace

Implementation of IGeom.getTopo
- Defined in geom.ts:438
Get a topo from a topo path. If the topo does not exist, then null is returned.

Parameters
- path: ITopoPathData
Returns IVertex | IEdge | IWire | IFace

getTopoFromLabel

getTopoFromLabel(path_str: string): IVertex | IEdge | IWire | IFace

Implementation of IGeom.getTopoFromLabel
- Defined in geom.ts:454
Get a topo from a topo label.

Parameters
- path_str: string
Returns IVertex | IEdge | IWire | IFace

getTopos

getTopos(geom_type: EGeomType): IVertex[] | IEdge[] | IWire[] | IFace[]

Implementation of IGeom.getTopos
- Defined in geom.ts:419
Get all the topos in the model for a specific geom type. (Vertices, Edges, Wires, Faces.)

Parameters
- geom_type: EGeomType
Returns IVertex[] | IEdge[] | IWire[] | IFace[]

mergeAllPoints

mergeAllPoints(tolerance: number): IPoint[]

Implementation of IGeom.mergeAllPoints
- Defined in geom.ts:342
Merge all points.

Parameters
- tolerance: number
Returns IPoint[]

mergePoints

mergePoints(points: IPoint[], tolerance?: number): IPoint[]

Implementation of IGeom.mergePoints
- Defined in geom.ts:328
Merge points.

Parameters
- points: IPoint[]
- Optional tolerance: number
Returns IPoint[]

numObjs

numObjs(): number

Implementation of IGeom.numObjs
- Defined in geom.ts:407
Get the total number of objects in the model.

Returns number

numPoints

numPoints(): number

Implementation of IGeom.numPoints
- Defined in geom.ts:319
Get the number of points in the model.

Returns number

numTopos

numTopos(geom_type: EGeomType): number

Implementation of IGeom.numTopos
- Defined in geom.ts:485
Get the number of topos in the model for a specific geom type. (Vertices, Edges, Wires, Faces.)

Parameters
- geom_type: EGeomType
Returns number

Generated using TypeDoc