Vertex | gs-json

Vertex class.

Hierarchy

Topo
- Vertex

Implements

Index

Constructors

constructor

Properties

Constructors

constructor

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

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 Vertex

The Topo object.

Properties

Protected _kernel

_kernel: Kernel

Protected _path

_path: ITopoPathData

Methods

addToGroup

addToGroup(group: IGroup): boolean

Implementation of IVertex.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.

exists

exists(): boolean

Implementation of IVertex.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 IVertex.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 IVertex.getAttribs

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

Returns ITopoAttrib[]

The array of attribute names.

getEdge

getEdge(): IEdge

Implementation of IVertex.getEdge
- Defined in topo_sub.ts:51
Get the edge for which this is the start vertex.

Returns IEdge

The edge object.

getGeom

getGeom(): IGeom

Implementation of IVertex.getGeom

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

Returns IGeom

The Model object

getGeomType

getGeomType(): EGeomType

Implementation of IVertex.getGeomType

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

Returns EGeomType

The topo type.

getGroups

getGroups(): IGroup[]

Implementation of IVertex.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 IVertex.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 IVertex.getLabelCentroid

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

Returns XYZ

The xyz of the centroid.

getModel

getModel(): IModel

Implementation of IVertex.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 IVertex.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 IVertex.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.

getPoint

getPoint(): IPoint

Implementation of IVertex.getPoint
- Defined in topo_sub.ts:42
Get the point associated with this vertex.

Returns IPoint

The point object.

getTopoPath

getTopoPath(): ITopoPathData

Implementation of IVertex.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 IVertex.getTopoPathStr

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

Returns string

The geometry path str.

getWireOrFace

getWireOrFace(): IWire | IFace

Implementation of IVertex.getWireOrFace
- Defined in topo_sub.ts:59
Get the wire or face to which this vertex belongs.

Returns IWire | IFace

The wire or face object.

next

next(): IVertex

Implementation of IVertex.next
- Defined in topo_sub.ts:71
Find the next vertex in the sequence of vertices in the wire or face.

Returns IVertex

The next vertex object.

previous

previous(): IVertex

Implementation of IVertex.previous
- Defined in topo_sub.ts:80
Find the previous vertex in the sequence of vertices in the wire or face.

Returns IVertex

The previous vertex object.

setAttribValue

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

Implementation of IVertex.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.

verticesSamePosition

verticesSamePosition(): IVertex[][]

- Defined in topo_sub.ts:104
Within the parent object, find all vertices with the same point position. Returns an array containing two sub-arrays. 1) The wire vertices, and 2) the face vertices.

Returns IVertex[][]

An array containing the two sub-arrays of vertices.

verticesSharedPoint

verticesSharedPoint(): IVertex[][]

Implementation of IVertex.verticesSharedPoint
- Defined in topo_sub.ts:91
Within the parent object, find all vertices with the same point. Returns an array containing two sub-arrays. 1) The wire vertices, and 2) the face vertices.

Returns IVertex[][]

An array containing the two sub-arrays of vertices.

Generated using TypeDoc