Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement CollisionPolygon3D margin #45855

Merged
merged 1 commit into from
Feb 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/classes/CollisionPolygon3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
If [code]true[/code], no collision will be produced.
</member>
<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.04">
The collision margin for the generated [Shape3D]. See [member Shape3D.margin] for more details.
</member>
<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array( )">
Array of vertices which define the polygon.
[b]Note:[/b] The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member.
Expand Down
3 changes: 2 additions & 1 deletion doc/classes/Shape3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
</methods>
<members>
<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.04">
The collision margin for the shape.
The collision margin for the shape. Used in Bullet Physics only.
Collision margins allows collision detection to be more efficient by adding an extra shell around shapes. Collision algorithms are more expensive when objects overlap by more than their margin, so a higher value for margins is better for performance, at the cost of accuracy around edges as it makes them less sharp.
</member>
</members>
<constants>
Expand Down
16 changes: 16 additions & 0 deletions scene/3d/collision_polygon_3d.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ void CollisionPolygon3D::_build_polygon() {
}

convex->set_points(cp);
convex->set_margin(margin);
parent->shape_owner_add_shape(owner_id, convex);
parent->shape_owner_set_disabled(owner_id, disabled);
}
Expand Down Expand Up @@ -155,6 +156,17 @@ bool CollisionPolygon3D::is_disabled() const {
return disabled;
}

real_t CollisionPolygon3D::get_margin() const {
return margin;
}

void CollisionPolygon3D::set_margin(real_t p_margin) {
margin = p_margin;
if (parent) {
_build_polygon();
}
}

String CollisionPolygon3D::get_configuration_warning() const {
String warning = Node3D::get_configuration_warning();

Expand Down Expand Up @@ -189,11 +201,15 @@ void CollisionPolygon3D::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_disabled", "disabled"), &CollisionPolygon3D::set_disabled);
ClassDB::bind_method(D_METHOD("is_disabled"), &CollisionPolygon3D::is_disabled);

ClassDB::bind_method(D_METHOD("set_margin", "margin"), &CollisionPolygon3D::set_margin);
ClassDB::bind_method(D_METHOD("get_margin"), &CollisionPolygon3D::get_margin);

ClassDB::bind_method(D_METHOD("_is_editable_3d_polygon"), &CollisionPolygon3D::_is_editable_3d_polygon);

ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "depth"), "set_depth", "get_depth");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "disabled"), "set_disabled", "is_disabled");
ADD_PROPERTY(PropertyInfo(Variant::PACKED_VECTOR2_ARRAY, "polygon"), "set_polygon", "get_polygon");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "margin", PROPERTY_HINT_RANGE, "0.001,10,0.001"), "set_margin", "get_margin");
}

CollisionPolygon3D::CollisionPolygon3D() {
Expand Down
4 changes: 4 additions & 0 deletions scene/3d/collision_polygon_3d.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
class CollisionObject3D;
class CollisionPolygon3D : public Node3D {
GDCLASS(CollisionPolygon3D, Node3D);
real_t margin = 0.04;

protected:
real_t depth = 1.0;
Expand Down Expand Up @@ -70,6 +71,9 @@ class CollisionPolygon3D : public Node3D {

virtual AABB get_item_rect() const;

real_t get_margin() const;
void set_margin(real_t p_margin);

String get_configuration_warning() const override;

CollisionPolygon3D();
Expand Down