@zeainc/zea-ux/dist/src/Handles/ScreenSpaceMovementHandle.d.ts

Zea UX

import { Xfo, ZeaPointerEvent, XfoParameter } from '@zeainc/zea-engine';
import Handle from './Handle.js';
import { Change } from '../index.js';
import SelectionGroup from '../SelectionGroup.js';
/**
 * Class representing a planar movement scene widget.
 *
 * @extends Handle
 */
declare class ScreenSpaceMovementHandle extends Handle {
    param: XfoParameter;
    baseXfo: Xfo;
    change: Change;
    selectionGroup: SelectionGroup;
    /**
     * Create a planar movement scene widget.
     *
     * @param name - The name value
     */
    constructor(name?: string);
    /**
     * Sets selectionGroup so this handle can modify the items.
     *
     * @param selectionGroup - The SelectionGroup.
     */
    setSelectionGroup(selectionGroup: SelectionGroup): void;
    /**
     * Sets global xfo target parameter.
     *
     * @param param - The parameter that will be modified during manipulation
     */
    setTargetParam(param: XfoParameter): void;
    /**
     * Returns target's global xfo parameter.
     *
     * @return {Parameter} - returns handle's target global Xfo.
     */
    getTargetParam(): XfoParameter;
    /**
     * Handles mouse down interaction with the handle.
     *
     * @param event - The event param.
     */
    handlePointerDown(event: ZeaPointerEvent): void;
    /**
     * Handles mouse move interaction with the handle.
     *
     * @param event - The event param
     */
    handlePointerMove(event: ZeaPointerEvent): void;
    /**
     * Handles mouse up interaction with the handle.
     *
     * @param event - The event param.
     */
    handlePointerUp(event: ZeaPointerEvent): void;
    /**
     * Handles the initially drag of the handle.
     *
     * @param event - The event param.
     */
    onDragStart(event: ZeaPointerEvent): void;
    /**
     * Handles drag action of the handle.
     *
     * @param event - The event param.
     */
    onDrag(event: ZeaPointerEvent): void;
    /**
     * Handles the end of dragging the handle.
     *
     * @param event - The event param.
     */
    onDragEnd(event: ZeaPointerEvent): void;
}
export default ScreenSpaceMovementHandle;
export { ScreenSpaceMovementHandle };
//# sourceMappingURL=ScreenSpaceMovementHandle.d.ts.map