CollectionAPI

Interface CollectionAPI

Collections store groups of nodes. They can be created empty or from a list of nodes. There is also the way to create a collection by searching nodes matching a given property.

interface CollectionAPI {
    addToCollection(
        collectionID: number,
        nodeID: number,
        recursive?: boolean,
    ): void;
    createCollection(nodeIDlist?: number[]): number;
    createCollection(): number;
    getCollection(collectionID: number): ICollection;
    getCollectionElements(collectionID: number): Promise<number[]>;
    getCollectionNodeCount(collectionID: number): Promise<number>;
    removeCollection(collectionID: number): void;
    removeFromCollection(
        collectionID: number,
        nodeID: number,
        recursive?: boolean,
    ): void;
    searchByVolume(
        selectionBox: BoxVolume,
        includeOverlappingNodes: boolean,
        rootNodeID?: number,
    ): Promise<number>;
}

Hierarchy (View Summary)

Methods

addToCollection createCollection getCollection getCollectionElements getCollectionNodeCount removeCollection removeFromCollection searchByVolume

Methods

addToCollection

  • addToCollection(collectionID: number, nodeID: number, recursive?: boolean): void

  • Adds the node given by nodeID to the collection with id collectionID. If recursive is true, the descendants of the node are also added. Returns the number of nodes in the collection.

    Parameters

    • collectionID: number

      Specifies to which collection the node should be added

    • nodeID: number

      Specifies which node should be added to the collection

    • Optionalrecursive: boolean

      Specifies if the children of the node should also be added to the collection

    Returns void

createCollection

  • createCollection(nodeIDlist?: number[]): number

  • Returns the id of a new collection containing the nodes from the given list.

    Parameters

    • OptionalnodeIDlist: number[]

      An array of node id's from which a new node collection should be created.

    Returns number

    The id of the newly created node collection.

  • createCollection(): number

  • Creates a new, empty collection and returns its id.

    Returns number

    The id of the newly created collection.

getCollection

  • getCollection(collectionID: number): ICollection

  • Returns the collection with the given id.

    Parameters

    • collectionID: number

      Specifies which collection should be returned

    Returns ICollection

    The collection with the given id

getCollectionElements

  • getCollectionElements(collectionID: number): Promise<number[]>
  • Readonly

    Returns an array containing the ids of the nodes in the collection. Modifying the returned array results in undefined behavior.

    Parameters

    • collectionID: number

      The id of the node collection

    Returns Promise<number[]>

    Array of node IDs representing the node collection

getCollectionNodeCount

  • getCollectionNodeCount(collectionID: number): Promise<number>

  • Returns the number of elements inside a collection.

    Parameters

    • collectionID: number

      The id of the collection

    Returns Promise<number>

    Number of elements in a collection.

removeCollection

  • removeCollection(collectionID: number): void

  • Removes the collection with the given id.

    Parameters

    • collectionID: number

      Specifies which collection should be removed

    Returns void

removeFromCollection

  • removeFromCollection(
        collectionID: number,
        nodeID: number,
        recursive?: boolean,
    ): void

  • Removes a node given by nodeID from the collection with id collectionID. If recursive is true, the descendants of the node are also removed.

    Parameters

    • collectionID: number

      Specifies from which collection the node should be removed

    • nodeID: number

      Specifies which node should be removed from the collection

    • Optionalrecursive: boolean

      Specifies whether the children of the node should be removed from the collection too

    Returns void

searchByVolume

  • searchByVolume(
        selectionBox: BoxVolume,
        includeOverlappingNodes: boolean,
        rootNodeID?: number,
    ): Promise<number>

  • Finds nodes within the given BoxVolume (created using the createBoxVolume() function). If includeOverlappingNodes is false, only nodes fully contained by the box volume are returned. The rootNodeID specifies the node from which the subtree is searched.

    Parameters

    • selectionBox: BoxVolume

      3-dimensional search volume.

    • includeOverlappingNodes: boolean

      Specifies whether the search result contains only those nodes which lie entirely in the search volume or if overlapping nodes are also included.

    • OptionalrootNodeID: number

      Restricts the search to a subtree of a node with the given id.

    Returns Promise<number>

    A the id of the created collection of nodes that are fitting the given search criteria.