webgl_clipping
对应 three.js 示例地址 。
仅需关注 init 函数的内容，其他部分都是示例小程序所使用的描述配置。
js
import * as THREE from "three";
import { OrbitControls } from "three/examples/jsm/controls/OrbitControls.js";
/** @type {import("@minisheeep/mp-three-examples").OfficialExampleInfo} */
const exampleInfo = {
name: "webgl_clipping",
useLoaders: [],
info: [],
init: ({ window, canvas, GUI, Stats, needToDispose, useFrame }) => {
let camera, scene, renderer, startTime, object, stats;
init();
function init() {
camera = new THREE.PerspectiveCamera(36, window.innerWidth / window.innerHeight, 0.25, 16);
camera.position.set(0, 1.3, 3);
scene = new THREE.Scene();
scene.add(new THREE.AmbientLight(13421772));
const spotLight = new THREE.SpotLight(16777215, 60);
spotLight.angle = Math.PI / 5;
spotLight.penumbra = 0.2;
spotLight.position.set(2, 3, 3);
spotLight.castShadow = true;
spotLight.shadow.camera.near = 3;
spotLight.shadow.camera.far = 10;
spotLight.shadow.mapSize.width = 1024;
spotLight.shadow.mapSize.height = 1024;
scene.add(spotLight);
const dirLight = new THREE.DirectionalLight(5591130, 3);
dirLight.position.set(0, 3, 0);
dirLight.castShadow = true;
dirLight.shadow.camera.near = 1;
dirLight.shadow.camera.far = 10;
dirLight.shadow.camera.right = 1;
dirLight.shadow.camera.left = -1;
dirLight.shadow.camera.top = 1;
dirLight.shadow.camera.bottom = -1;
dirLight.shadow.mapSize.width = 1024;
dirLight.shadow.mapSize.height = 1024;
scene.add(dirLight);
const localPlane = new THREE.Plane(new THREE.Vector3(0, -1, 0), 0.8);
const globalPlane = new THREE.Plane(new THREE.Vector3(-1, 0, 0), 0.1);
const material = new THREE.MeshPhongMaterial({
color: 8449552,
shininess: 100,
side: THREE.DoubleSide,
// ***** Clipping setup (material): *****
clippingPlanes: [localPlane],
clipShadows: true,
alphaToCoverage: true
});
const geometry = new THREE.TorusKnotGeometry(0.4, 0.08, 95, 20);
object = new THREE.Mesh(geometry, material);
object.castShadow = true;
scene.add(object);
const ground = new THREE.Mesh(
new THREE.PlaneGeometry(9, 9, 1, 1),
new THREE.MeshPhongMaterial({ color: 10530223, shininess: 150 })
);
ground.rotation.x = -Math.PI / 2;
ground.receiveShadow = true;
scene.add(ground);
renderer = new THREE.WebGLRenderer({ antialias: true, canvas });
renderer.setPixelRatio(window.devicePixelRatio);
renderer.setSize(window.innerWidth, window.innerHeight);
renderer.setAnimationLoop(animate);
renderer.shadowMap.enabled = true;
window.addEventListener("resize", onWindowResize);
const globalPlanes = [globalPlane], Empty = Object.freeze([]);
renderer.clippingPlanes = Empty;
renderer.localClippingEnabled = true;
stats = new Stats(renderer);
const controls = new OrbitControls(camera, renderer.domElement);
controls.target.set(0, 1, 0);
controls.update();
const gui = new GUI(), props = {
alphaToCoverage: true
}, folderLocal = gui.addFolder("Local Clipping"), propsLocal = {
get Enabled() {
return renderer.localClippingEnabled;
},
set Enabled(v) {
renderer.localClippingEnabled = v;
},
get Shadows() {
return material.clipShadows;
},
set Shadows(v) {
material.clipShadows = v;
},
get Plane() {
return localPlane.constant;
},
set Plane(v) {
localPlane.constant = v;
}
}, folderGlobal = gui.addFolder("Global Clipping"), propsGlobal = {
get Enabled() {
return renderer.clippingPlanes !== Empty;
},
set Enabled(v) {
renderer.clippingPlanes = v ? globalPlanes : Empty;
},
get Plane() {
return globalPlane.constant;
},
set Plane(v) {
globalPlane.constant = v;
}
};
gui.add(props, "alphaToCoverage").onChange(function(value) {
ground.material.alphaToCoverage = value;
ground.material.needsUpdate = true;
material.alphaToCoverage = value;
material.needsUpdate = true;
});
folderLocal.add(propsLocal, "Enabled");
folderLocal.add(propsLocal, "Shadows");
folderLocal.add(propsLocal, "Plane", 0.3, 1.25);
folderGlobal.add(propsGlobal, "Enabled");
folderGlobal.add(propsGlobal, "Plane", -0.4, 3);
startTime = Date.now();
needToDispose(renderer, scene, controls);
}
function onWindowResize() {
camera.aspect = window.innerWidth / window.innerHeight;
camera.updateProjectionMatrix();
renderer.setSize(window.innerWidth, window.innerHeight);
}
function animate() {
const currentTime = Date.now();
const time = (currentTime - startTime) / 1e3;
object.position.y = 0.8;
object.rotation.x = time * 0.5;
object.rotation.y = time * 0.2;
object.scale.setScalar(Math.cos(time) * 0.125 + 0.875);
stats.begin();
renderer.render(scene, camera);
stats.end();
stats.update();
}
}
};
export {
exampleInfo as default
};ts
import { Loader, TypedArray } from 'three';
/**
* 官网示例的多端使用封装把版本
* */
export interface OfficialExampleInfo extends MiniProgramMeta {
/*** 示例名称（保持和官网一致）*/
name: string;
/** main */
init: (context: LoadContext) => void;
}
export interface LoadContext {
window: EventTarget & { innerWidth: number; innerHeight: number; devicePixelRatio: number };
/** HTMLCanvasElement */
canvas: any;
/** https://www.npmjs.com/package/lil-gui */
GUI: any;
/**
* https://www.npmjs.com/package/stats.js
* 也可以使用其他受支持的版本
* */
Stats: any;
/** 收集需要 dispose 的对象（官方示例没有处理这部分）*/
needToDispose: (...objs: any[]) => void | ((fromFn: () => any[]) => void);
/**基于 raq 的通用封装 */
useFrame(animateFunc: (/** ms */ delta: number) => void): { cancel: () => void };
/** 显示加载模态框 */
requestLoading(text?: string): Promise<void>;
/** 隐藏加载模态框*/
cancelLoading(): void;
/** 保存文件的通用封装*/
saveFile(
fileName: string,
data: ArrayBuffer | TypedArray | DataView | string
): Promise<string | null>;
/** 示例使用 DracoDecoder 时的资源路径 */
DecoderPath: {
GLTF: string;
STANDARD: string;
};
/** 为资源路径拼上 CDN 前缀 */
withCDNPrefix(path: string): string;
/**
* 在小程序中应使用 import { VideoTexture } from '@minisheep/three-platform-adapter/override/jsm/textures/VideoTexture.js';
* 正常情况（web） 可直接使用 THREE.VideoTexture
* */
getVideoTexture(videoOptions: VideoOptions): Promise<[{ isVideoTexture: true }, video: any]>;
/**
* 在小程序中应使用 import { CameraTexture } from '@minisheep/three-platform-adapter/override/jsm/textures/CameraTexture.js';
* 正常情况（web） 可参考示例 webgl_materials_video_webcam
* */
getCameraTexture(): { isVideoTexture: true };
/** 用于动态修改 info 中的占位符*/
bindInfoText(template: `$${string}$`, initValue?: string): { value: string };
/** 分屏控件对应的事件回调 */
onSlideStart(handle: () => void): void;
/** 分屏控件对应的事件回调 */
onSlideEnd(handle: () => void): void;
/** 分屏控件对应的事件回调 */
onSlideChange(handle: (offset: number, boxSize: number) => void): void;
}
export type VideoOptions = {
src: string;
/** 相当于 HTMLVideoElement 的 naturalWidth (小程序中获取不到)*/
width: number;
/** 相当于 HTMLVideoElement 的 naturalHeight (小程序中获取不到)*/
height: number;
loop?: boolean;
autoplay?: boolean;
muted?: boolean;
};
/** 示例小程序中使用的一些配置 */
export interface MiniProgramMeta {
/** 用于统计加载相关信息 */
useLoaders: Record<string, Loader>;
/** 通用 info */
info: TagItem[][];
/** 特殊 info */
infoPanel?: {
left?: [string, string][];
right?: [string, string][];
};
/** 分屏控件配置 */
needSlider?: {
/** 方向 */
direction?: 'horizontal' | 'vertical';
/** 初始偏移 0-100 */
initPosition?: number;
};
/** 操作摇杆控件 */
needArrowControls?: boolean;
/** 默认需要的画布类型 */
canvasType?: '2d' | 'webgl' | 'webgl2';
/** 为保持效果一致所需要的画布样式 */
canvasStyle?: {
bgColor?: string;
width?: number | string;
height?: number | string;
};
/** 部分示例需要在加载前进行一些提示 */
initAfterConfirm?: {
/**
* 提示类型
* @default 'default'
* */
type?: 'warning' | 'default';
text: string[];
};
}
export interface BaseTag<T extends string> {
tag: T;
content: string;
}
export interface ATag extends BaseTag<'a'> {
link: string;
}
export type TextTag = BaseTag<'text'>;
export type TagItem = TextTag | ATag;