Home > PCB_Event > addRayTracerEngine3DViewClickMaterialEventListener

PCB_Event.addRayTracerEngine3DViewClickMaterialEventListener() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Add a ray tracer engine 3D preview material click event listener

Signature

public addRayTracerEngine3DViewClickMaterialEventListener(id: string, callFn: (props: { materialId: number; material: any }) => void | Promise<void>, onlyOnce?: boolean): void;

Parameters

Parameter	Type	Description
id	string	Event ID, used to prevent duplicate event registration
callFn	(props: { materialId: number; material: any }) => void | Promise<void>	The callback function triggered when the event fires
onlyOnce	boolean	(Optional) Whether to listen only once

Returns

void

Remarks

Note: This API is only valid for extensions. Calling it in a standalone script environment will always throw Error ADD since EDA v4

Example

const listenerId = '嘉立创示例_3d_material';

// 1. 注册点击材质监听（回调在 3D 预览点击材质时触发，本例不依赖实际触发）
eda.pcb_Event.addRayTracerEngine3DViewClickMaterialEventListener(
  listenerId,
  (props) => {
    console.log('clickMaterial:', JSON.stringify(props));
  }
);

// 2. 回读确认注册成功
const registered = eda.pcb_Event.isEventListenerAlreadyExist(listenerId);
console.log('registered:', registered);

// 3. 清理监听
const removed = eda.pcb_Event.removeEventListener(listenerId);
console.log('removed:', removed);