CSGPolygon

Inherits: CSGPrimitive < CSGShape < GeometryInstance < VisualInstance < CullInstance < Spatial < Node < Object Extrudes a 2D polygon shape to create a 3D mesh.

Description

CSGMesh 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 MeshInstance with a PrimitiveMesh. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.

Tutorials

  • Prototyping levels with CSG

    Properties

    Enumerations

    Mode:
  • 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 Path specified in path_node.

PathRotation:

  • PATH_ROTATION_POLYGON = 0 —- The polygon shape is not rotated. Note: Requires the path’s 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’s 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.

PathIntervalType:

  • 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.

    Property Descriptions

  • float depth mode is MODE_DEPTH, the depth of the extrusion.
  • Material material polygon), the bottom-left quarter to the front end face, and the bottom-right quarter to the back end face.
  • Mode mode mode used to extrude the polygon.
  • bool path_continuous_u 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 mode is MODE_PATH, the path interval or ratio of path points to extrusions.
  • PathIntervalType path_interval_type 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 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 mode is MODE_PATH, if true the Transform of the CSGPolygon is used as the starting point for the extrusions, not the Transform of the path_node.
  • NodePath path_node mode is MODE_PATH, the location of the Path object used to extrude the polygon.
  • PathRotation path_rotation mode is MODE_PATH, the PathRotation method used to rotate the polygon as it is extruded.
  • float path_simplify_angle mode is MODE_PATH, extrusions that are less than this angle, will be merged together to reduce polygon count.
  • float path_u_distance 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.
  • PoolVector2Array polygon 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 true, applies smooth shading to the extrusions.
  • float spin_degrees mode is MODE_SPIN, the total number of degrees the polygon is rotated when extruding.
  • int spin_sides mode is MODE_SPIN, the number of extrusions made.