Inherits: VisualInstance < Spatial < Node < Object

Inherited By: CSGCombiner, CSGPrimitive

Category: Core

Brief Description

The CSG base class.


bool is_root_shape ( ) const


enum Operation:

  • OPERATION_UNION = 0 — Geometry of both primitives is merged, intersecting geometry is removed.
  • OPERATION_INTERSECTION = 1 — Only intersecting geometry remains, the rest is removed.
  • OPERATION_SUBTRACTION = 2 — The second shape is susbtracted from the first, leaving a dent with it’s shape.


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

Property Descriptions

  • bool calculate_tangents
Setter set_calculate_tangents(value)
Getter is_calculating_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.

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.

Setter set_snap(value)
Getter get_snap()
  • bool use_collision
Setter set_use_collision(value)
Getter is_using_collision()

Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden.

Method Descriptions

  • bool is_root_shape ( ) const

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