godot/doc/classes/Shape3D.xml

31 lines
1.6 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Shape3D" inherits="Resource" version="4.0">
<brief_description>
2017-09-23 11:12:30 +00:00
Base class for all 3D shape resources.
</brief_description>
<description>
Base class for all 3D shape resources. Nodes that inherit from this can be used as shapes for a [PhysicsBody3D] or [Area3D] objects.
</description>
<tutorials>
<link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link>
</tutorials>
<methods>
<method name="get_debug_mesh">
<return type="ArrayMesh" />
<description>
Returns the [ArrayMesh] used to draw the debug collision for this [Shape3D].
</description>
</method>
</methods>
2018-08-29 20:25:11 +00:00
<members>
<member name="custom_solver_bias" type="float" setter="set_custom_solver_bias" getter="get_custom_solver_bias" default="0.0">
The shape's custom solver bias. Defines how much bodies react to enforce contact separation when this shape is involved.
When set to [code]0[/code], the default value from [member ProjectSettings.physics/3d/solver/default_contact_bias] is used.
</member>
<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.04">
2021-02-09 19:37:12 +00:00
The collision margin for the shape. Used in Bullet Physics only.
2021-03-18 11:04:28 +00:00
Collision margins allow 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.
2018-08-29 20:25:11 +00:00
</member>
</members>
</class>