Obj | gs-json

Abstract class Obj. The superclass for all geometric objects, including Polyline and Polymesh.

Hierarchy

Ent
- Obj
  - Polyline
  - Ellipse
  - Plane
  - Polymesh
  - Ray
  - Circle
  - Hyperbola

Implements

IEnt
IObj

Index

Constructors

constructor

Properties

_id
_kernel

Constructors

constructor

new Obj(kernel: Kernel, id: number): Obj

Inherited from Ent.constructor
- Defined in entity.ts:14
Creates an instance of one of the subclasses of Ent. The entity must already exists in the geometry. Do not use this constructor if you want to add a new entity to the geometry. For that, you should use one of the 'add' methods in the geometry class.

Parameters
- kernel: Kernel
- id: number
  
  The ID of the entity. This ID must already exist in the geometry.
Returns Obj

The Ent object.

Properties

Protected _id

_id: number

Protected _kernel

_kernel: Kernel

Methods

addToGroup

addToGroup(group: IGroup): boolean

Implementation of IObj.addToGroup

Overrides Ent.addToGroup
- Defined in entity_obj.ts:277
Add this object to a group.

Parameters
- group: IGroup
  
  The group.
Returns boolean

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

copy

copy(copy_attribs?: boolean): IObj

Implementation of IObj.copy

Overrides Ent.copy
- Defined in entity_obj.ts:73
Make a copy of this entity. This method must be overridden by the sub-classes.

Parameters
- Optional copy_attribs: boolean
Returns IObj

The geometry type.

exists

exists(): boolean

Implementation of IObj.exists

Overrides Ent.exists
- Defined in entity_obj.ts:40
Check if this entity exists in the model. (i.e has it been deleted?)

Returns boolean

The entity ID number.

getAttribValue

getAttribValue(attrib: IEntAttrib): any

Implementation of IObj.getAttribValue

Inherited from Ent.getAttribValue
- Defined in entity.ts:131
Get an attribute value for this entity.

Parameters
- attrib: IEntAttrib
  
  The attribute.
Returns any

The attribute value.

getAttribs

getAttribs(): IEntAttrib[] | ITopoAttrib[]

Implementation of IObj.getAttribs

Inherited from Ent.getAttribs
- Defined in entity.ts:120
Get the attribute names for this entity.

Returns IEntAttrib[] | ITopoAttrib[]

The array of attribute names.

getEdges

getEdges(edge_type?: wires | faces): IEdge[][][]

Implementation of IObj.getEdges
- Defined in entity_obj.ts:159
Get the edges for this object. If the edge_type is not specified, then edges for both wires and faces are returned.

Parameters
- Optional edge_type: wires | faces
Returns IEdge[][][]

The array of edges.

getFacePoints

getFacePoints(): IPoint[]

Implementation of IObj.getFacePoints
- Defined in entity_obj.ts:257
Returns IPoint[]

getFaces

getFaces(): IFace[]

Implementation of IObj.getFaces
- Defined in entity_obj.ts:180
Get the faces for this object.

Returns IFace[]

The array of faces.

getGeom

getGeom(): IGeom

Implementation of IObj.getGeom

Inherited from Ent.getGeom
- Defined in entity.ts:41
Get the Geom object

Returns IGeom

The Model object

getGeomType

getGeomType(): EGeomType

Implementation of IObj.getGeomType

Overrides Ent.getGeomType
- Defined in entity_obj.ts:23
Get the geometry type. This method overrides the method in the Ent class.

Returns EGeomType

The geometry type.

getGroups

getGroups(): IGroup[]

Implementation of IObj.getGroups

Overrides Ent.getGroups
- Defined in entity_obj.ts:268
Get the group names for all the groups for which this entity is a member.

Returns IGroup[]

The array of group names.

getID

getID(): number

Implementation of IObj.getID

Inherited from Ent.getID
- Defined in entity.ts:51
Get the ID number of this entity.

Returns number

The entity ID number.

getLabel

getLabel(): string

Implementation of IObj.getLabel

Overrides Ent.getLabel
- Defined in entity_obj.ts:48
Get the label for this object.

Returns string

The xyz of the centroid.

getLabelCentroid

getLabelCentroid(): XYZ

Implementation of IObj.getLabelCentroid

Overrides Ent.getLabelCentroid
- Defined in entity_obj.ts:56
Get the label centroid for this object.

Returns XYZ

The xyz of the label.

getModel

getModel(): IModel

Implementation of IObj.getModel

Inherited from Ent.getModel
- Defined in entity.ts:33
Get the Model object that this entity belongs to.

Returns IModel

A Model object.

getObjType

getObjType(): EObjType

Implementation of IObj.getObjType
- Defined in entity_obj.ts:32
Get the object type. This method will be overridden by subclasses.

Returns EObjType

The object type.

getPoints

getPoints(point_type?: wires | faces): IPoint[][][]

Implementation of IObj.getPoints
- Defined in entity_obj.ts:92
Get the points for this object. If the point_type is not specified, then points for both wires and faces are returned.

Parameters
- Optional point_type: wires | faces
Returns IPoint[][][]

A nested array of points, with sub-arrays for wires and faces.

getPointsArr

getPointsArr(): IPoint[]

Implementation of IObj.getPointsArr
- Defined in entity_obj.ts:118
Get the points for this object. If the point_type is not specified, then points for both wires and faces are returned.

Returns IPoint[]

A flat array of points.

getPointsSet

getPointsSet(): IPoint[]

Implementation of IObj.getPointsSet
- Defined in entity_obj.ts:126
Get the set of unique points for this object.

Returns IPoint[]

The array of point IDs.

getVertices

getVertices(vertex_type?: wires | faces): IVertex[][][]

Implementation of IObj.getVertices
- Defined in entity_obj.ts:146
Get the vertices for this object. If the vertex_type is not specified, then vertices for both wires and faces are returned.

Parameters
- Optional vertex_type: wires | faces
Returns IVertex[][][]

The array of vertices.

getWirePoints

getWirePoints(): IPoint[]

Implementation of IObj.getWirePoints
- Defined in entity_obj.ts:247
Returns IPoint[]

getWires

getWires(): IWire[]

Implementation of IObj.getWires
- Defined in entity_obj.ts:171
Get the wires for this object.

Returns IWire[]

The array of wires.

numFaceEdges

numFaceEdges(): number

Implementation of IObj.numFaceEdges
- Defined in entity_obj.ts:237
Returns the number of edges in this polymesh faces.

Returns number

Return the number of edges.

numFaceVertices

numFaceVertices(): number

Implementation of IObj.numFaceVertices
- Defined in entity_obj.ts:217
Returns the number of vertices in this polymesh faces.

Returns number

Return the number of vertices.

numFaces

numFaces(): number

Implementation of IObj.numFaces
- Defined in entity_obj.ts:197
Get the number of faces for this object.

Returns number

The number of faces.

numWireEdges

numWireEdges(): number

Implementation of IObj.numWireEdges
- Defined in entity_obj.ts:227
Returns the number of edges in this polymesh wires.

Returns number

Return the number of edges.

numWireVertices

numWireVertices(): number

Implementation of IObj.numWireVertices
- Defined in entity_obj.ts:207
Returns the number of vertices in this polymesh wires.

Returns number

Return the number of vertices.

numWires

numWires(): number

Implementation of IObj.numWires
- Defined in entity_obj.ts:189
Get the number of wires for this object.

Returns number

The number of wires.

setAttribValue

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

Implementation of IObj.setAttribValue

Inherited from Ent.setAttribValue
- Defined in entity.ts:142
Set an attribute value for this entity.

Parameters
- attrib: IEntAttrib
  
  The attribute.
- value: any
  
  The new attribute value.
Returns any

The old attribute value.

toString

toString(): string

Implementation of IObj.toString

Overrides Ent.toString
- Defined in entity_obj.ts:287
Create s string representation of this object.

Returns string

Strig

xform

xform(matrix: Matrix4): void

Implementation of IObj.xform

Overrides Ent.xform
- Defined in entity_obj.ts:81
Transform the points for this object.

Parameters
- matrix: Matrix4
  
  The xform matrix.
Returns void

Generated using TypeDoc