Interface INodePool

Interface for a node pool that manages reusable SceneGraph nodes.

interface INodePool {
    get<T extends ISGNNode>(
        componentType: string,
        initialState?: IStyleDictionary,
    ): T;
    getPoolCounts(): INodePoolCounts;
    prepopulate(componentType: string, count: number): void;
    release(node: ISGNNode): void;
}

Implemented by

NodePool.NodePool

Index

Methods

get getPoolCounts prepopulate release

Methods

get

get<T extends ISGNNode>(
componentType: string,
initialState?: IStyleDictionary,
): T
Retrieves a node of the specified component type from the pool, optionally applying an initial state.
Type Parameters
- T extends ISGNNode
Parameters
- componentType: string
  The type of node to retrieve.
- OptionalinitialState: IStyleDictionary
  Optional initial state to apply to the node.
Returns T
- Defined in hosanna-ui/src/hosanna-ui/lib/NodePool.ts:17

getPoolCounts

getPoolCounts(): INodePoolCounts
Returns counts of total, available, and created nodes by component type.

Returns INodePoolCounts
- Defined in hosanna-ui/src/hosanna-ui/lib/NodePool.ts:11

prepopulate

prepopulate(componentType: string, count: number): void
Prepopulates the pool with a specified number of nodes of the given component type.
Parameters
- componentType: string
  The type of node to prepopulate.
- count: number
  The number of nodes to create.
Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/NodePool.ts:28

release

release(node: ISGNNode): void
Releases a node back into the pool for reuse.
Parameters
- node: ISGNNode
  The node to release.
Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/NodePool.ts:22