Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Ent. An abstrcat class that is the superclass for all geometric entities, both Point and Obj. An entity may be part of a group and may have attributes.

Hierarchy

Implements

Index

Constructors

constructor

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

    The Ent object.

Properties

Protected _id

_id: number

Protected _kernel

_kernel: Kernel

Methods

addToGroup

  • addToGroup(group: IGroup): boolean
  • Add this object to a group. This method must be overridden by the sub-classes.

    Parameters

    Returns boolean

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

copy

  • copy(copy_attribs: boolean): IEnt
  • Make a copy of this entity. This method must be overridden by the sub-classes.

    Parameters

    • copy_attribs: boolean

    Returns IEnt

    The geometry type.

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 entity. This method must be overridden by the sub-classes.

    Returns EGeomType

    The geometry type.

getGroups

  • Get the groups for all the groups for which this entity is a member. This method must be overridden by the sub-classes.

    Returns IGroup[]

    The array of group names.

getID

  • getID(): number
  • Get the ID number of this entity.

    Returns number

    The entity ID number.

getLabel

  • getLabel(): string
  • Get the label for this entity. This method must be overridden by the sub-classes.

    Returns string

    The geometry type.

getLabelCentroid

  • getLabelCentroid(): XYZ
  • Get the label centroid for this entity. This method must be overridden by the sub-classes.

    Returns XYZ

    The geometry type.

getModel

setAttribValue

  • setAttribValue(attrib: IEntAttrib, value: any): any
  • 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
  • Create s string representation of this object. This method must be overridden by the sub-classes.

    Returns string

    Strig

xform

  • xform(matrix: Matrix4): void
  • Transform points. This method must be overridden by the sub-classes.

    Parameters

    • matrix: Matrix4

      The xform matrix.

    Returns void

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