Options
All
  • Public
  • Public/Protected
  • All
Menu

Topo class. An abstrcat class that is the superclass for all topo components: vertices, edges, wires, and faces.

Hierarchy

Implements

Index

Constructors

constructor

  • 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 Topo

    The Topo object.

Properties

Protected _kernel

_kernel: Kernel

Protected _path

Methods

addToGroup

  • addToGroup(group: IGroup): boolean
  • Add this topo to a group.

    Parameters

    Returns boolean

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

exists

  • exists(): boolean
  • Check if this entity exists in the model. (i.e has it been deleted?)

    Returns boolean

    The entity ID number.

getAttribValue

getAttribs

getGeom

getGeomType

  • Get the geometry type for this topo component. This method mst be overridden by the sub-classes.

    Returns EGeomType

    The geometry type.

getGroups

getLabel

  • getLabel(): string
  • Get the label of this topo.

    Returns string

    The xyz of the centroid.

getLabelCentroid

  • getLabelCentroid(): XYZ
  • Get the label centroid of this topo. This is calculated as the average of the point positions for all points in the topo.

    Returns XYZ

    The xyz of the centroid.

getModel

getObj

  • Get the ID of the object to which this topo component belongs.

    Returns IObj

    The object ID number.

getObjID

  • getObjID(): number
  • Get the ID of the object to which this topo component belongs.

    Returns number

    The object ID number.

getTopoPath

getTopoPathStr

  • getTopoPathStr(): string
  • Get a compact string representation of the geometry path for this topo component.

    Returns string

    The geometry path str.

setAttribValue

  • 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.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc