Class reference

CSGPolygon3D

Inherits CSGPrimitive3D

Extrudes a 2D polygon shape to create a 3D mesh.

Description

An array of 2D points is extruded to quickly and easily create a variety of 3D meshes. See also CSGMesh3D for using 3D meshes as CSG nodes. Note: CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a MeshInstance3D with a PrimitiveMesh. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.

Properties

Material material

Material to use for the resulting mesh. The UV maps the top half of the material to the extruded shape (U along the length of the extrusions and V around the outline of the polygon), the bottom-left quarter to the front end face, and the bottom-right quarter to the back end face.

bool path_continuous_u

When mode is MODE_PATH, by default, the top half of the material is stretched along the entire length of the extruded shape. If false the top half of the material is repeated every step of the extrusion.

float path_interval

When mode is MODE_PATH, the path interval or ratio of path points to extrusions.

bool path_joined

When mode is MODE_PATH, if true the ends of the path are joined, by adding an extrusion between the last and first points of the path.

bool path_rotation_accurate

When mode is MODE_PATH, if true the polygon will be rotated according to the proper tangent of the path at the sampled points. If false an approximation is used, which decreases in accuracy as the number of subdivisions decreases.

float path_simplify_angle

When mode is MODE_PATH, extrusions that are less than this angle, will be merged together to reduce polygon count.

float path_u_distance

When mode is MODE_PATH, this is the distance along the path, in meters, the texture coordinates will tile. When set to 0, texture coordinates will match geometry exactly with no tiling.

PackedVector2Array polygon = PackedVector2Array(0, 0, 0, 1, 1, 1, 1, 0)

The point array that defines the 2D polygon that is extruded. This can be a convex or concave polygon with 3 or more points. The polygon must not have any intersecting edges. Otherwise, triangulation will fail and no mesh will be generated. Note: If only 1 or 2 points are defined in polygon, no mesh will be generated.

bool smooth_faces = false

If true, applies smooth shading to the extrusions.

Constants

MODE_DEPTH = 0

Enum: Mode

The polygon shape is extruded along the negative Z axis.

MODE_SPIN = 1

Enum: Mode

The polygon shape is extruded by rotating it around the Y axis.

PATH_ROTATION_POLYGON = 0

Enum: PathRotation

The polygon shape is not rotated. Note: Requires the path Z coordinates to continually decrease to ensure viable shapes.

PATH_ROTATION_PATH = 1

Enum: PathRotation

The polygon shape is rotated along the path, but it is not rotated around the path axis. Note: Requires the path Z coordinates to continually decrease to ensure viable shapes.

PATH_ROTATION_PATH_FOLLOW = 2

Enum: PathRotation

The polygon shape follows the path and its rotations around the path axis.

PATH_INTERVAL_DISTANCE = 0

Enum: PathIntervalType

When mode is set to MODE_PATH, path_interval will determine the distance, in meters, each interval of the path will extrude.

PATH_INTERVAL_SUBDIVIDE = 1

Enum: PathIntervalType

When mode is set to MODE_PATH, path_interval will subdivide the polygons along the path.

Tutorials

Source revision 5592dc3a7a61
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.