Edge | gs-json

Edge class.

Hierarchy

Topo
- Edge

Implements

ITopo
IEdge

Index

Constructors

constructor

Properties

Constructors

constructor

new Edge(kernel: Kernel, path: ITopoPathData): Edge

Inherited from Topo.constructor
- Defined in topo.ts:16
Creates an instance of one of the subclasses of Topo. The entity must already exists in the geometry. You should not create new topo components using this constructor. Topology will be created for you when you create geometric objects, such as polylines and polymeshes.

Parameters
- kernel: Kernel
- path: ITopoPathData
  
  The path of the entity. This path must already exist in the geometry.
Returns Edge

The Topo object.

Properties

Protected _kernel

_kernel: Kernel

Protected _path

_path: ITopoPathData

Methods

addToGroup

addToGroup(group: IGroup): boolean

Implementation of IEdge.addToGroup

Inherited from Topo.addToGroup
- Defined in topo.ts:167
Add this topo to a group.

Parameters
- group: IGroup
  
  The group.
Returns boolean

True if the topo was added, False is the topo was already in the group.

edgesSharedPoints

edgesSharedPoints(): IEdge[][]

Implementation of IEdge.edgesSharedPoints
- Defined in topo_sub.ts:200
Within the parent object, find all edges with the same two points as this edge. The order of the points is ignored. Returns an array containing two sub-arrays. 1) The wire edges, and 2) the face edges.

Returns IEdge[][]

An array containing the two sub-arrays of edges.

exists

exists(): boolean

Implementation of IEdge.exists

Inherited from Topo.exists
- Defined in topo.ts:35
Check if this entity exists in the model. (i.e has it been deleted?)

Returns boolean

The entity ID number.

getAttribValue

getAttribValue(attrib: ITopoAttrib): any

Implementation of IEdge.getAttribValue

Inherited from Topo.getAttribValue
- Defined in topo.ts:135
Get an attribute value for this topo component.

Parameters
- attrib: ITopoAttrib
  
  The topo attribute.
Returns any

The attribute value.

getAttribs

getAttribs(): ITopoAttrib[]

Implementation of IEdge.getAttribs

Inherited from Topo.getAttribs
- Defined in topo.ts:124
Get the attributes for this topo component.

Returns ITopoAttrib[]

The array of attribute names.

getGeom

getGeom(): IGeom

Implementation of IEdge.getGeom

Inherited from Topo.getGeom
- Defined in topo.ts:51
Get the Geom object

Returns IGeom

The Model object

getGeomType

getGeomType(): EGeomType

Implementation of IEdge.getGeomType

Overrides Topo.getGeomType
- Defined in topo_sub.ts:122
Get the geometry type: "edges". This method overrides the method in the Topo class.

Returns EGeomType

The topo type.

getGroups

getGroups(): IGroup[]

Implementation of IEdge.getGroups

Inherited from Topo.getGroups
- Defined in topo.ts:157
Get the groups for which this topo component is a member.

Returns IGroup[]

The array of groups.

getLabel

getLabel(): string

Implementation of IEdge.getLabel

Inherited from Topo.getLabel
- Defined in topo.ts:104
Get the label of this topo.

Returns string

The xyz of the centroid.

getLabelCentroid

getLabelCentroid(): XYZ

Implementation of IEdge.getLabelCentroid

Overrides Topo.getLabelCentroid
- Defined in topo_sub.ts:140
Get the centroid of this topo. This is used for attaching labels.

Returns XYZ

The xyz of the centroid.

getModel

getModel(): IModel

Implementation of IEdge.getModel

Inherited from Topo.getModel
- Defined in topo.ts:43
Get the model to which this group belongs.

Returns IModel

The model

getObj

getObj(): IObj

Implementation of IEdge.getObj

Inherited from Topo.getObj
- Defined in topo.ts:69
Get the ID of the object to which this topo component belongs.

Returns IObj

The object ID number.

getObjID

getObjID(): number

Implementation of IEdge.getObjID

Inherited from Topo.getObjID
- Defined in topo.ts:61
Get the ID of the object to which this topo component belongs.

Returns number

The object ID number.

getTopoPath

getTopoPath(): ITopoPathData

Implementation of IEdge.getTopoPath

Inherited from Topo.getTopoPath
- Defined in topo.ts:87
Get the geometry path for this topo component.

Returns ITopoPathData

The geometry path.

getTopoPathStr

getTopoPathStr(): string

Implementation of IEdge.getTopoPathStr

Overrides Topo.getTopoPathStr
- Defined in topo_sub.ts:131
Get a compact string representation of the geometry path for this topological component, dtsrting with the obj ID.

Returns string

The geometry path str.

getVertices

getVertices(): IVertex[]

Implementation of IEdge.getVertices
- Defined in topo_sub.ts:155
Get the two vertices for this edge.

Returns IVertex[]

An array of two edges.

getWireOrFace

getWireOrFace(): IWire | IFace

Implementation of IEdge.getWireOrFace
- Defined in topo_sub.ts:164
Get the wire or face to which this edge belongs.

Returns IWire | IFace

The wire or face.

next

next(): IEdge

Implementation of IEdge.next
- Defined in topo_sub.ts:177
Find the next edge in the sequence of edges in the wire or face.

Returns IEdge

The next edge object.

previous

previous(): IEdge

Implementation of IEdge.previous
- Defined in topo_sub.ts:187
Find the previous edge in the sequence of edges in the wire or face.

Returns IEdge

The previous edge object.

setAttribValue

setAttribValue(attrib: ITopoAttrib, value: any): any

Implementation of IEdge.setAttribValue

Inherited from Topo.setAttribValue
- Defined in topo.ts:146
Set an attribute value for this topo component.

Parameters
- attrib: ITopoAttrib
  
  The topo attribute.
- value: any
  
  The new attribute value.
Returns any

The old attribute value.

Generated using TypeDoc