Struct CSGShape

The CSG base class.

struct CSGShape ;

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

Properties

NameTypeDescription
calculateTangents[get, set] boolCalculate 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.
collisionLayer[get, set] longThe physics layers this area is in. 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.
collisionMask[get, set] longThe physics layers this CSG shape scans for collisions.
operation[get, set] CSGShape.OperationThe 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[get, set] doubleSnap 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.
useCollision[get, set] boolAdds 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.

Methods

NameDescription
_updateShape
getCollisionLayer
getCollisionLayerBit Returns an individual bit on the collision mask.
getCollisionMask
getCollisionMaskBit Returns an individual bit on the collision mask.
getMeshes Returns an Array with two elements, the first is the Transform of this node and the second is the root Mesh of this node. Only works when this node is the root shape.
getOperation
getSnap
isCalculatingTangents
isRootShape Returns true if this is a root shape and is thus the object that is rendered.
isUsingCollision
setCalculateTangents
setCollisionLayer
setCollisionLayerBit Sets individual bits on the layer mask. Use this if you only need to change one layer's value.
setCollisionMask
setCollisionMaskBit Sets individual bits on the collision mask. Use this if you only need to change one layer's value.
setOperation
setSnap
setUseCollision

Enums

NameDescription
Constants
Operation