xverse-components-volume/types/types.d.ts

xverse components volume

import { ISnippet } from '@xverse/matrix-shared-types';
export declare const snippet: ISnippet;
/**
 * @componentName Volume
 * @title 碰撞区域
 * @type 3D
 * @contributor 周璨
 */
export interface IVolume {
    /**
     * @title 碰撞盒子中心坐标的BomId：
     * @setter PointIdSetter
     * @isBaseInitOption
     */
    pointId: string;
    /**
     * @title 碰撞盒子的半径(CM)：
     * @setter NumberSetter
     * @isBaseInitOption
     */
    radius: number;
    /**
     * @title 碰撞盒子的形状（0 方形 1 圆形）：
     * @default 0
     * @notExternal
     * @isBaseInitOption
     */
    shape?: 0 | 1;
    /**
     * @title 是否开启事件触发(关闭即使事件生效也不会触发事件回调)
     * @description 受控属性，可以通过变量控制是否支持事件触发
     * @default true
     */
    enabledEventListener?: boolean;
    /**
     * @title 进入盒子触发的事件
     */
    onEnter?: () => void;
    /**
     * @title 退出盒子触发的事件
     */
    onLeave?: () => void;
    /**
     * @title 是否在场景中显示盒子调试绘制模型
     * @isBaseInitOption
     */
    debugPaintVisible?: boolean;
}