Table of Contents

Class PlaneMesh

Class representing a planar PrimitiveMesh.

Inheritance
PlaneMesh
Derived

Remarks

Class representing a planar PrimitiveMesh. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Z axes; this default rotation isn't suited for use with billboarded materials. For billboarded materials, change orientation to PlaneMesh.FACE_Z.

Note: When using a large textured PlaneMesh (e.g. as a floor), you may stumble upon UV jittering issues depending on the camera angle. To solve this, increase subdivide_depth and subdivide_width until you no longer notice UV jittering.

Properties

center_offset

Offset of the generated plane. Useful for particles.

var center_offset : Vector3 = Vector3(0, 0, 0)

Property Value

Vector3

Remarks

orientation

Direction that the PlaneMesh is facing. See Orientation for options.

var orientation : int = 1

Property Value

int

Remarks

  • void set_orientation(int value)
  • int get_orientation

size

Size of the generated plane.

var size : Vector2 = Vector2(2, 2)

Property Value

Vector2

Remarks

subdivide_depth

Number of subdivision along the Z axis.

var subdivide_depth : int = 0

Property Value

int

Remarks

  • void set_subdivide_depth(int value)
  • int get_subdivide_depth

subdivide_width

Number of subdivision along the X axis.

var subdivide_width : int = 0

Property Value

int

Remarks

  • void set_subdivide_width(int value)
  • int get_subdivide_width