@zeainc/zea-ux
Version:
66 lines • 2.03 kB
TypeScript
import { BaseItem, TreeItem, SelectionSet, MultiChoiceParameter, CloneContext } from '@zeainc/zea-engine';
import SelectionGroupXfoOperator from './SelectionGroupXfoOperator.js';
/**
* A specific type of `SelectionSet` class that contains/handles selection of one or more items from the scene.
*
* **Option parameter values**
*
* | Option | type | default | Description |
* | --- | --- | --- | --- |
* | selectionOutlineColor | `Color` | `new Color('#03e3ac'))` and opacity of `0.1` | See `Color` documentation |
* | branchSelectionOutlineColor | `Color` | `new Color('#81f1d5')` and opacity of `0.55` | See `Color` documentation |
*
* @extends {SelectionSet}
*/
declare class SelectionGroup extends SelectionSet {
initialXfoModeParam: MultiChoiceParameter;
selectionGroupXfoOp: SelectionGroupXfoOperator;
/**
* Creates an instance of SelectionGroup.
*
*
* **Parameters**
* @param options - Custom options for selection
*/
constructor(options?: Record<string, any>);
/**
* Returns enum of available xfo modes.
*
* | Name | Default |
* | --- | --- |
* | manual | <code>0</code> |
* | first | <code>1</code> |
* | average | <code>2</code> |
* | globalOri | <code>3</code> |
*/
static get INITIAL_XFO_MODES(): {
disabled: number;
manual: number;
first: number;
average: number;
globalOri: number;
};
/**
* Constructs a new selection group by copying the values from current one and returns it.
*
* @return - Cloned selection group.
*/
clone(context?: CloneContext): BaseItem;
/**
*
* @param item -
* @param index -
* @private
*/
bindItem(item: TreeItem, index: number): void;
/**
*
* @param item -
* @param index -
* @private
*/
unbindItem(item: TreeItem, index: number): void;
}
export default SelectionGroup;
export { SelectionGroup };
//# sourceMappingURL=SelectionGroup.d.ts.map