Files
cocos4/cocos/core/animation/skeletal-animation.ts
T
Jare Guo 0319477911 fix decorator warning of ValueTypes (#7553)
* fix decorator warning of ValueTypes (sync #6285)

* refresh copyright
2020-10-21 16:31:41 +08:00

226 lines
8.9 KiB
TypeScript

/*
Copyright (c) 2017-2020 Xiamen Yaji Software Co., Ltd.
http://www.cocos.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
/**
* @packageDocumentation
* @module animation
*/
import { SkinnedMeshRenderer } from '../3d/framework/skinned-mesh-renderer';
import { ccclass, executeInEditMode, executionOrder, help, menu, tooltip, type, serializable, editable } from 'cc.decorator';
import { Mat4 } from '../math';
import { DataPoolManager } from '../renderer/data-pool-manager';
import { Node } from '../scene-graph/node';
import { AnimationClip } from './animation-clip';
import { Animation } from './animation-component';
import { SkelAnimDataHub } from './skeletal-animation-data-hub';
import { SkeletalAnimationState } from './skeletal-animation-state';
import { getWorldTransformUntilRoot } from './transform-utils';
import { legacyCC } from '../global-exports';
import { AnimationManager } from './animation-manager';
import { js } from '../utils/js';
@ccclass('cc.SkeletalAnimation.Socket')
export class Socket {
/**
* @en Path of the target joint.
* @zh 此挂点的目标骨骼路径。
*/
@serializable
@editable
public path: string = '';
/**
* @en Transform output node.
* @zh 此挂点的变换信息输出节点。
*/
@type(Node)
public target: Node | null = null;
constructor (path = '', target: Node | null = null) {
this.path = path;
this.target = target;
}
}
js.setClassAlias(Socket, 'cc.SkeletalAnimationComponent.Socket');
const m4_1 = new Mat4();
const m4_2 = new Mat4();
function collectRecursively (node: Node, prefix = '', out: string[] = []) {
for (let i = 0; i < node.children.length; i++) {
const child = node.children[i];
if (!child) { continue; }
const path = prefix ? `${prefix}/${child.name}` : child.name;
out.push(path);
collectRecursively(child, path, out);
}
return out;
}
/**
* @en
* Skeletal animation component, offers the following features on top of [[Animation]]:
* * Choice between baked animation and real-time calculation, to leverage efficiency and expressiveness.
* * Joint socket system: Create any socket node directly under the animation component root node,
* find your target joint and register both to the socket list, so that the socket node would be in-sync with the joint.
* @zh
* 骨骼动画组件,在普通动画组件基础上额外提供以下功能:
* * 可选预烘焙动画模式或实时计算模式,用以权衡运行时效率与效果;
* * 提供骨骼挂点功能:通过在动画根节点下创建挂点节点,并在骨骼动画组件上配置 socket 列表,挂点节点的 Transform 就能与骨骼保持同步。
*/
@ccclass('cc.SkeletalAnimation')
@help('i18n:cc.SkeletalAnimation')
@executionOrder(99)
@executeInEditMode
@menu('Components/SkeletalAnimation')
export class SkeletalAnimation extends Animation {
public static Socket = Socket;
/**
* @en
* The joint sockets this animation component maintains.<br>
* Sockets have to be registered here before attaching custom nodes to animated joints.
* @zh
* 当前动画组件维护的挂点数组。要挂载自定义节点到受动画驱动的骨骼上,必须先在此注册挂点。
*/
@type([Socket])
@tooltip('i18n:animation.sockets')
get sockets () {
return this._sockets;
}
set sockets (val) {
if (!this._useBakedAnimation) {
const animMgr = legacyCC.director.getAnimationManager() as AnimationManager;
animMgr.removeSockets(this.node, this._sockets);
animMgr.addSockets(this.node, val);
}
this._sockets = val;
this.rebuildSocketAnimations();
}
/**
* @en
* Whether to bake animations. Default to true,<br>
* which substantially increases performance while making all animations completely fixed.<br>
* Dynamically changing this property will take effect when playing the next animation clip.
* @zh
* 是否使用预烘焙动画,默认启用,可以大幅提高运行效时率,但所有动画效果会被彻底固定,不支持任何形式的编辑和混合。<br>
* 运行时动态修改此选项会在播放下一条动画片段时生效。
*/
@tooltip('i18n:animation.use_baked_animation')
get useBakedAnimation () {
return this._useBakedAnimation;
}
set useBakedAnimation (val) {
this._useBakedAnimation = val;
const comps = this.node.getComponentsInChildren(SkinnedMeshRenderer);
for (let i = 0; i < comps.length; ++i) {
const comp = comps[i];
if (comp.skinningRoot === this.node) {
comp.setUseBakedAnimation(this._useBakedAnimation);
}
}
if (this._useBakedAnimation) { (legacyCC.director.getAnimationManager() as AnimationManager).removeSockets(this.node, this._sockets); }
else { (legacyCC.director.getAnimationManager() as AnimationManager).addSockets(this.node, this._sockets); }
}
@serializable
protected _useBakedAnimation = true;
@type([Socket])
protected _sockets: Socket[] = [];
public onDestroy () {
super.onDestroy();
(legacyCC.director.root.dataPoolManager as DataPoolManager).jointAnimationInfo.destroy(this.node.uuid);
(legacyCC.director.getAnimationManager() as AnimationManager).removeSockets(this.node, this._sockets);
}
public start () {
this.sockets = this._sockets;
this.useBakedAnimation = this._useBakedAnimation;
super.start();
}
public querySockets () {
const animPaths = this._defaultClip && Object.keys(SkelAnimDataHub.getOrExtract(this._defaultClip).data).sort().reduce((acc, cur) =>
cur.startsWith(acc[acc.length - 1]) ? acc : (acc.push(cur), acc), [] as string[]) || [];
if (!animPaths.length) { return ['please specify a valid default animation clip first']; }
const out: string[] = [];
for (let i = 0; i < animPaths.length; i++) {
const path = animPaths[i];
const node = this.node.getChildByPath(path);
if (!node) { continue; }
out.push(path);
collectRecursively(node, path, out);
}
return out;
}
public rebuildSocketAnimations () {
for (const socket of this._sockets) {
const joint = this.node.getChildByPath(socket.path);
const target = socket.target;
if (joint && target) {
target.name = `${socket.path.substring(socket.path.lastIndexOf('/') + 1)} Socket`;
target.parent = this.node;
getWorldTransformUntilRoot(joint, this.node, m4_1);
Mat4.fromRTS(m4_2, target.rotation, target.position, target.scale);
if (!Mat4.equals(m4_2, m4_1)) { target.matrix = m4_1; }
}
}
for (const stateName of Object.keys(this._nameToState)) {
const state = this._nameToState[stateName] as SkeletalAnimationState;
state.rebuildSocketCurves(this._sockets);
}
}
public createSocket (path: string) {
const socket = this._sockets.find((s) => s.path === path);
if (socket) { return socket.target; }
const joint = this.node.getChildByPath(path);
if (!joint) { console.warn('illegal socket path'); return null; }
const target = new Node();
target.parent = this.node;
this._sockets.push(new Socket(path, target));
this.rebuildSocketAnimations();
return target;
}
protected _createState (clip: AnimationClip, name?: string) {
return new SkeletalAnimationState(clip, name);
}
protected _doCreateState (clip: AnimationClip, name: string) {
const state = super._doCreateState(clip, name) as SkeletalAnimationState;
state.rebuildSocketCurves(this._sockets);
return state;
}
}