CSGShape

Inherited By: , CSGPrimitive

The CSG base class.

This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot.

Properties

	get_collision_layer_bit ( bit ) const
bool	( int bit ) const
	get_meshes ( ) const
	is_root_shape ( ) const
void	( int bit, value )
void	set_collision_mask_bit ( bit, bool value )

Enumerations

enum Operation:

OPERATION_INTERSECTION = 1 —- Only intersecting geometry remains, the rest is removed.
OPERATION_SUBTRACTION = 2 —- The second shape is subtracted from the first, leaving a dent with its shape.

calculate_tangents

Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child.

int collision_layer

Default	`1`
Setter	set_collision_layer(value)
Getter	get_collision_layer()

Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property.

A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See in the documentation for more information.

int collision_mask

The physics layers this CSG shape scans for collisions. See in the documentation for more information.

Operation operation

Default	`0`
Setter	set_operation(value)
Getter	get_operation()

The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent.

Snap makes the mesh snap to a given distance so that the faces of two meshes can be perfectly aligned. A lower value results in greater precision but may be harder to adjust.

use_collision

Default	`false`
Setter	set_use_collision(value)
Getter	is_using_collision()

Method Descriptions

bool get_collision_layer_bit ( bit ) const

Returns an individual bit on the collision mask.

bool get_collision_mask_bit ( bit ) const

Returns an individual bit on the collision mask.

Array get_meshes ( ) const

Returns an with two elements, the first is the Transform of this node and the second is the root of this node. Only works when this node is the root shape.

bool is_root_shape ( ) const

Returns if this is a root shape and is thus the object that is rendered.

void set_collision_layer_bit ( bit, bool value )

Sets individual bits on the layer mask. Use this if you only need to change one layer’s value.