Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

GLTFPhysicsShape¶

Inherits: Resource < RefCounted < Object

Represents a GLTF physics shape.

Description¶

Represents a physics shape as defined by the OMI_collider GLTF extension. This class is an intermediary between the GLTF data and Godot's nodes, and it's abstracted in a way that allows adding support for different GLTF physics extensions in the future.

Tutorials¶

Properties¶

float	height	`2.0`
ImporterMesh	importer_mesh
bool	is_trigger	`false`
int	mesh_index	`-1`
float	radius	`0.5`
String	shape_type	`""`
Vector3	size	`Vector3(1, 1, 1)`

Methods¶

GLTFPhysicsShape	from_dictionary ( Dictionary dictionary ) static
GLTFPhysicsShape	from_node ( CollisionShape3D shape_node ) static
Dictionary	to_dictionary ( ) const
CollisionShape3D	to_node ( bool cache_shapes=false )

Property Descriptions¶

float height = 2.0

void set_height ( float value )
float get_height ( )

The height of the shape, in meters. This is only used when the shape type is "capsule" or "cylinder". This value should not be negative, and for "capsule" it should be at least twice the radius.

ImporterMesh importer_mesh

void set_importer_mesh ( ImporterMesh value )
ImporterMesh get_importer_mesh ( )

The ImporterMesh resource of the shape. This is only used when the shape type is "hull" (convex hull) or "trimesh" (concave trimesh).

bool is_trigger = false

void set_is_trigger ( bool value )
bool get_is_trigger ( )

If true, indicates that this shape is a trigger. For Godot, this means that the shape should be a child of an Area3D node.

This is the only variable not used in the to_node method, it's intended to be used alongside when deciding where to add the generated node as a child.

int mesh_index = -1

void set_mesh_index ( int value )
int get_mesh_index ( )

The index of the shape's mesh in the GLTF file. This is only used when the shape type is "hull" (convex hull) or "trimesh" (concave trimesh).

float radius = 0.5

void set_radius ( float value )
float get_radius ( )

The radius of the shape, in meters. This is only used when the shape type is "capsule", "cylinder", or "sphere". This value should not be negative.

String shape_type = ""

void set_shape_type ( String value )
String get_shape_type ( )

The type of shape this shape represents. Valid values are "box", "capsule", "cylinder", "sphere", "hull", and "trimesh".

Vector3 size = Vector3(1, 1, 1)

void set_size ( Vector3 value )
Vector3 get_size ( )

The size of the shape, in meters. This is only used when the shape type is "box", and it represents the "diameter" of the box. This value should not be negative.

Method Descriptions¶

GLTFPhysicsShape from_dictionary ( Dictionary dictionary ) static

Creates a new GLTFPhysicsShape instance by parsing the given Dictionary.

GLTFPhysicsShape from_node ( CollisionShape3D shape_node ) static

Create a new GLTFPhysicsShape instance from the given Godot CollisionShape3D node.

Dictionary to_dictionary ( ) const

Serializes this GLTFPhysicsShape instance into a Dictionary.

CollisionShape3D to_node ( bool cache_shapes=false )

Converts this GLTFPhysicsShape instance into a Godot CollisionShape3D node.