Class File3dmGroupTable

constructor

• new File3dmGroupTable(): File3dmGroupTable

  Returns File3dmGroupTable

count

add

• add(group: Group): void

  ...

  Parameters

  • group: Group

  Returns void

delete

• delete(group: Group): boolean

  ...

  Parameters

  • group: Group

  Returns boolean

deleteId

• deleteId(id: string): boolean

  ...

  Parameters

  • id: string

  Returns boolean

deleteIndex

• deleteIndex(index: number): boolean

  ...

  Parameters

  • index: number

  Returns boolean

findIndex

• findIndex(groupIndex: number): Group

  Parameters

  • groupIndex: number

    The index to search for.

  Returns Group

  A Group object, or null if none was found.

  Description

  Retrieves a Group object based on an index. This search type of search is discouraged. We are moving towards using only IDs for all tables.

findName

• findName(name: string): Group

  Parameters

  • name: string

    The name of the Group to be searched.

  Returns Group

  A Group, or null on error.

  Description

  Finds a Group given its name.

get

• get(index: number): Group

  ...

  Parameters

  • index: number

  Returns Group

groupMembers

• groupMembers(groupIndex: number): File3dmObject[]

  Parameters

  • groupIndex: number

    The index of the group in this table.

  Returns File3dmObject[]

  Array of objects that belong to the specified group or empty array if no objects could be found.

  Description

  Gets an array of all of the objects in a group.