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
float depth = 1.0
float depth = 1.0When mode is MODE_DEPTH, the depth of the extrusion.
Material material
Material materialMaterial 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.
int mode = 0
int mode = 0bool path_continuous_u
bool path_continuous_uWhen 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
float path_intervalWhen mode is MODE_PATH, the path interval or ratio of path points to extrusions.
int path_interval_type
int path_interval_typeWhen mode is MODE_PATH, this will determine if the interval should be by distance (PATH_INTERVAL_DISTANCE) or subdivision fractions (PATH_INTERVAL_SUBDIVIDE).
bool path_joined
bool path_joinedWhen 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_local
bool path_localWhen mode is MODE_PATH, if true the Transform3D of the CSGPolygon3D is used as the starting point for the extrusions, not the Transform3D of the path_node.
NodePath path_node
NodePath path_nodeWhen mode is MODE_PATH, the location of the Path3D object used to extrude the polygon.
int path_rotation
int path_rotationWhen mode is MODE_PATH, the path rotation method used to rotate the polygon as it is extruded.
bool path_rotation_accurate
bool path_rotation_accurateWhen 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
float path_simplify_angleWhen mode is MODE_PATH, extrusions that are less than this angle, will be merged together to reduce polygon count.
float path_u_distance
float path_u_distanceWhen 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)
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
bool smooth_faces = falseIf true, applies smooth shading to the extrusions.
float spin_degrees
float spin_degreesWhen mode is MODE_SPIN, the total number of degrees the polygon is rotated when extruding.
int spin_sides
int spin_sidesConstants
MODE_DEPTH = 0
The polygon shape is extruded along the negative Z axis.
MODE_SPIN = 1
The polygon shape is extruded by rotating it around the Y axis.
MODE_PATH = 2
The polygon shape is extruded along the Path3D specified in path_node.
PATH_ROTATION_POLYGON = 0
The polygon shape is not rotated. Note: Requires the path Z coordinates to continually decrease to ensure viable shapes.
PATH_ROTATION_PATH = 1
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
The polygon shape follows the path and its rotations around the path axis.
PATH_INTERVAL_DISTANCE = 0
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
When mode is set to MODE_PATH, path_interval will subdivide the polygons along the path.