Options
All
  • Public
  • Public/Protected
  • All
Menu

Group class.

Hierarchy

  • Group

Implements

Index

Constructors

constructor

  • Creates an instance of the Group class. The group data must already exists in the model. Do not use this constructor if you want to add a new group to the model. Instead, you should use the "addGroup()" methdod in the model class.

    Parameters

    Returns Group

    The Group object.

Properties

Private _kernel

_kernel: Kernel

Private _name

_name: string

Methods

addObj

  • addObj(obj: IObj): boolean

addObjs

  • addObjs(objs: IObj[]): boolean
  • Add multiple object to this group.

    Parameters

    Returns boolean

    Returns true if all obj IDs were added, false otherwise.

addPoint

  • addPoint(point: IPoint): boolean

addPoints

  • addPoints(points: IPoint[]): boolean

addTopo

  • addTopo(topo: ITopo): boolean
  • Add a topo to this group. (Vertices, edges, wires, faces.)

    Parameters

    Returns boolean

addTopos

  • addTopos(topos: ITopo[]): boolean
  • Add multiple topos to this group. (Vertices, edges, wires, faces.)

    Parameters

    Returns boolean

exists

  • exists(): boolean

getChildGroups

getGeom

getModel

getName

  • getName(): string
  • Get the group name, which is its main identifier. Kust be unque.

    Returns string

getNumObjs

  • getNumObjs(obj_type?: EObjType): number
  • Get the number of objs in this group.

    Parameters

    Returns number

getNumPoints

  • getNumPoints(): number
  • Get the number of points in this group.

    Returns number

getNumTopos

  • Get the number of topos in this group.

    Parameters

    Returns number

getObjs

getParentGroup

getPoints

getProps

  • getProps(): Array<[string, any]>
  • Get the properties of this group. This returns an array of key: value pairs.

    Returns Array<[string, any]>

getTopos

hasObj

  • hasObj(obj: IObj): boolean

hasPoint

  • hasPoint(point: IPoint): boolean

hasTopo

  • hasTopo(topo: ITopo): boolean
  • Check if a topo is in this group. (Vertices, edges, wires, faces.)

    Parameters

    Returns boolean

removeObj

  • removeObj(obj: IObj): boolean

removeObjs

  • removeObjs(objs: IObj[]): boolean

removeParentGroup

  • Remove the parent group of this group. This will result in this group having no parent. A group with no parent is a top level group

    Returns IGroup

removePoint

  • removePoint(point: IPoint): boolean

removePoints

  • removePoints(points: IPoint[]): boolean

removeTopo

  • removeTopo(topo: ITopo): boolean

removeTopos

  • removeTopos(topos: ITopo[]): boolean
  • Remove multiple topos from this group. (Vertices, edges, wires, faces.)

    Parameters

    Returns boolean

setName

  • setName(name: string): string

setParentGroup

setProps

  • setProps(props: Array<[string, any]>): Array<[string, any]>
  • Set the properties of this group. The value must be an array of key: value pairs.

    Parameters

    • props: Array<[string, any]>

    Returns Array<[string, any]>

toString

  • toString(): string

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