1a64f5d2ec
See #36285 which mistakenly added documentation for the whole C++ API, while
some of it is meant to be and stay private as it's not exposed to scripts.
The access modifiers and method prefix were not used properly.
Cleanup code, and rename wrong `group_name` parameters to `method`, as it's a
method name which is being broadcast.
This is a very old class from pre-open source days, chances are that it was
just forgotten and not meant to be kept as is and undocumented.
(cherry picked from commit 79ba70f7ee)
87 lines
3.2 KiB
C++
87 lines
3.2 KiB
C++
/*************************************************************************/
|
|
/* proximity_group.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef PROXIMITY_GROUP_H
|
|
#define PROXIMITY_GROUP_H
|
|
|
|
#include "spatial.h"
|
|
|
|
class ProximityGroup : public Spatial {
|
|
|
|
GDCLASS(ProximityGroup, Spatial);
|
|
|
|
public:
|
|
enum DispatchMode {
|
|
MODE_PROXY,
|
|
MODE_SIGNAL,
|
|
};
|
|
|
|
private:
|
|
Map<StringName, uint32_t> groups;
|
|
|
|
String group_name;
|
|
DispatchMode dispatch_mode;
|
|
Vector3 grid_radius;
|
|
|
|
float cell_size;
|
|
uint32_t group_version;
|
|
|
|
void _clear_groups();
|
|
void _update_groups();
|
|
void _add_groups(int *p_cell, String p_base, int p_depth);
|
|
void _new_group(StringName p_name);
|
|
|
|
void _proximity_group_broadcast(String p_method, Variant p_parameters);
|
|
|
|
protected:
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
void set_group_name(const String &p_group_name);
|
|
String get_group_name() const;
|
|
|
|
void set_dispatch_mode(DispatchMode p_mode);
|
|
DispatchMode get_dispatch_mode() const;
|
|
|
|
void set_grid_radius(const Vector3 &p_radius);
|
|
Vector3 get_grid_radius() const;
|
|
|
|
void broadcast(String p_method, Variant p_parameters);
|
|
|
|
ProximityGroup();
|
|
~ProximityGroup() {}
|
|
};
|
|
|
|
VARIANT_ENUM_CAST(ProximityGroup::DispatchMode);
|
|
|
|
#endif // PROXIMITY_GROUP_H
|