Files
cocos4/cocos/core/components/model-renderer.ts
T
ChiaNing f2a9607aa4 The base version of sorting priority add (#11599)
* sorting Priority add

* fix CI

* name change

* binding add

* name change to priority

* bind remove

Co-authored-by: ChiaNing <sun.clooud.mo@gmail.com>
2022-06-20 17:54:31 +08:00

100 lines
3.1 KiB
TypeScript

/*
Copyright (c) 2022 Xiamen Yaji Software Co., Ltd.
https://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.
*/
import {
ccclass, serializable,
} from 'cc.decorator';
import { scene } from '../renderer';
import { Layers } from '../scene-graph/layers';
import { Renderer } from './renderer';
/**
* @en Base class for all rendering components containing model.
* @zh 所有包含 model 的渲染组件基类。
*/
@ccclass('cc.ModelRenderer')
export class ModelRenderer extends Renderer {
/**
* @en The visibility which will be applied to the committed models.
* @zh 应用于所有提交渲染的 Model 的可见性
*/
get visibility () {
return this._visFlags;
}
set visibility (val) {
this._visFlags = val;
this._onVisibilityChange(val);
}
/**
* @en The priority which will be applied to the committed models.(Valid only in transparent queues)
* @zh 应用于所有提交渲染的 Model 的排序优先级(只在半透明渲染队列中起效)
*/
get priority () {
return this._priority;
}
set priority (val) {
if (val === this._priority) return;
this._updatePriority();
}
@serializable
protected _visFlags = Layers.Enum.NONE;
protected _models: scene.Model[] = [];
protected _priority = 0;
/**
* @zh 收集组件中的 models
* @en Collect the models in this component.
* @deprecated since v3.5.0, this is an engine private interface that will be removed in the future.
*/
public _collectModels (): scene.Model[] {
return this._models;
}
protected onEnable () {
this._updatePriority();
}
protected _attachToScene () {
}
protected _detachFromScene () {
}
protected _onVisibilityChange (val) {
}
protected _updatePriority () {
if (this._models.length > 0) {
for (let i = 0; i < this._models.length; i++) {
this._models[i].priority = this._priority;
}
}
}
}