Face | gs-json

Face class

Hierarchy

Topo
- Face

Implements

ITopo
IFace

Index

Constructors

constructor

Properties

Constructors

constructor

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

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 Face

The Topo object.

Properties

Protected _kernel

_kernel: Kernel

Protected _path

_path: ITopoPathData

Methods

addToGroup

addToGroup(group: IGroup): boolean

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

facesSharedPoints

facesSharedPoints(num_shared_points?: number): IFace[]

Implementation of IFace.facesSharedPoints
- Defined in topo_sub.ts:385
Within the parent object, find all faces that share at least n points.

Parameters
- Optional num_shared_points: number
Returns IFace[]

An array of faces.

getAttribValue

getAttribValue(attrib: ITopoAttrib): any

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

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

Returns ITopoAttrib[]

The array of attribute names.

getEdges

getEdges(): IEdge[]

Implementation of IFace.getEdges
- Defined in topo_sub.ts:350
Get the edges for this wire.

Returns IEdge[]

An array of edges.

getGeom

getGeom(): IGeom

Implementation of IFace.getGeom

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

Returns IGeom

The Model object

getGeomType

getGeomType(): EGeomType

Implementation of IFace.getGeomType

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

Returns EGeomType

The topo type.

getGroups

getGroups(): IGroup[]

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

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

Returns XYZ

The xyz of the centroid.

getModel

getModel(): IModel

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

Overrides Topo.getTopoPathStr
- Defined in topo_sub.ts:317
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 IFace.getVertices
- Defined in topo_sub.ts:341
Get the vertices for this wire.

Returns IVertex[]

An array of vertices.

isClosed

isClosed(): boolean

Implementation of IFace.isClosed
- Defined in topo_sub.ts:377
Return true, since a face is always closed.

Returns boolean

boolean

numEdges

numEdges(): number

Implementation of IFace.numEdges
- Defined in topo_sub.ts:369
Get the number of edged in this face. This is the same as numVertices().

Returns number

The number of edges.

numVertices

numVertices(): number

Implementation of IFace.numVertices
- Defined in topo_sub.ts:360
Get the number of vertices in this face. This is the same as numEdges().

Returns number

The number of vertices.

setAttribValue

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

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