mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-21 16:12:40 +08:00
024737aebc
* Move Any.h/Optional.h/Variant.h to base/std and rename them to lowercase. * fixed #11195: Rename cc::optional, cc::any, cc::variant to ccstd::optional, ccstd::any, ccstd::variant * Format code.
97 lines
2.7 KiB
C++
97 lines
2.7 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2021 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.
|
|
****************************************************************************/
|
|
#pragma once
|
|
|
|
#include "primitive/PrimitiveDefine.h"
|
|
|
|
namespace cc {
|
|
|
|
/**
|
|
* @en
|
|
* The definition of the parameter for building a box.
|
|
* @zh
|
|
* 立方体参数选项。
|
|
*/
|
|
struct IBoxOptions : public IGeometryOptions {
|
|
/**
|
|
* @en
|
|
* Box extent on X-axis.
|
|
* @zh
|
|
* 立方体宽度。
|
|
*/
|
|
ccstd::optional<float> width;
|
|
|
|
/**
|
|
* @en
|
|
* Box extent on Y-axis.
|
|
* @zh
|
|
* 立方体高度。
|
|
*/
|
|
ccstd::optional<float> height;
|
|
|
|
/**
|
|
* @en
|
|
* Box extent on Z-axis.
|
|
* @zh
|
|
* 立方体长度。
|
|
*/
|
|
ccstd::optional<float> length;
|
|
|
|
/**
|
|
* @en
|
|
* Segment count on X-axis.
|
|
* @zh
|
|
* 宽度线段数。
|
|
*/
|
|
ccstd::optional<uint32_t> widthSegments;
|
|
|
|
/**
|
|
* @en
|
|
* Segment count on Y-axis.
|
|
* @zh
|
|
* 高度线段数。
|
|
*/
|
|
ccstd::optional<uint32_t> heightSegments;
|
|
|
|
/**
|
|
* @en
|
|
* Segment count on Z-axis.
|
|
* @zh
|
|
* 长度线段数。
|
|
*/
|
|
ccstd::optional<uint32_t> lengthSegments;
|
|
};
|
|
|
|
/**
|
|
* @en
|
|
* This function generates a box with specified extents and centered at origin,
|
|
* but may be repositioned through the `center` option.
|
|
* @zh
|
|
* 生成一个立方体,其大小是定义的范围且中心在原点。
|
|
* @param options 参数选项。
|
|
*/
|
|
IGeometry box(const ccstd::optional<IBoxOptions> &options = ccstd::nullopt);
|
|
} // namespace cc
|