1/**************************************************************************/
2/* multimesh.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef MULTIMESH_H
32#define MULTIMESH_H
33
34#include "scene/resources/mesh.h"
35#include "servers/rendering_server.h"
36
37class MultiMesh : public Resource {
38 GDCLASS(MultiMesh, Resource);
39 RES_BASE_EXTENSION("multimesh");
40
41public:
42 enum TransformFormat {
43 TRANSFORM_2D = RS::MULTIMESH_TRANSFORM_2D,
44 TRANSFORM_3D = RS::MULTIMESH_TRANSFORM_3D
45 };
46
47private:
48 Ref<Mesh> mesh;
49 RID multimesh;
50 TransformFormat transform_format = TRANSFORM_2D;
51 bool use_colors = false;
52 bool use_custom_data = false;
53 int instance_count = 0;
54 int visible_instance_count = -1;
55
56protected:
57 static void _bind_methods();
58
59#ifndef DISABLE_DEPRECATED
60 // Kept for compatibility from 3.x to 4.0.
61 void _set_transform_array(const Vector<Vector3> &p_array);
62 Vector<Vector3> _get_transform_array() const;
63
64 void _set_transform_2d_array(const Vector<Vector2> &p_array);
65 Vector<Vector2> _get_transform_2d_array() const;
66
67 void _set_color_array(const Vector<Color> &p_array);
68 Vector<Color> _get_color_array() const;
69
70 void _set_custom_data_array(const Vector<Color> &p_array);
71 Vector<Color> _get_custom_data_array() const;
72#endif
73 void set_buffer(const Vector<float> &p_buffer);
74 Vector<float> get_buffer() const;
75
76public:
77 void set_mesh(const Ref<Mesh> &p_mesh);
78 Ref<Mesh> get_mesh() const;
79
80 void set_use_colors(bool p_enable);
81 bool is_using_colors() const;
82
83 void set_use_custom_data(bool p_enable);
84 bool is_using_custom_data() const;
85
86 void set_transform_format(TransformFormat p_transform_format);
87 TransformFormat get_transform_format() const;
88
89 void set_instance_count(int p_count);
90 int get_instance_count() const;
91
92 void set_visible_instance_count(int p_count);
93 int get_visible_instance_count() const;
94
95 void set_instance_transform(int p_instance, const Transform3D &p_transform);
96 void set_instance_transform_2d(int p_instance, const Transform2D &p_transform);
97 Transform3D get_instance_transform(int p_instance) const;
98 Transform2D get_instance_transform_2d(int p_instance) const;
99
100 void set_instance_color(int p_instance, const Color &p_color);
101 Color get_instance_color(int p_instance) const;
102
103 void set_instance_custom_data(int p_instance, const Color &p_custom_data);
104 Color get_instance_custom_data(int p_instance) const;
105
106 virtual AABB get_aabb() const;
107
108 virtual RID get_rid() const override;
109
110 MultiMesh();
111 ~MultiMesh();
112};
113
114VARIANT_ENUM_CAST(MultiMesh::TransformFormat);
115
116#endif // MULTIMESH_H
117