PlaneMesh

PlaneMesh

Inherits: PrimitiveMesh < Mesh < Resource < Reference < Object

Class representing a planar PrimitiveMesh.

Description

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, use QuadMesh instead.

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

Vector3	center_offset	`Vector3( 0, 0, 0 )`
Vector2	size	`Vector2( 2, 2 )`
int	subdivide_depth	`0`
int	subdivide_width	`0`

Property Descriptions

Vector3 center_offset

Default	`Vector3( 0, 0, 0 )`
Setter	set_center_offset(value)
Getter	get_center_offset()

Offset from the origin of the generated plane. Useful for particles.

Vector2 size

Default	`Vector2( 2, 2 )`
Setter	set_size(value)
Getter	get_size()

Size of the generated plane.

int subdivide_depth

Default	`0`
Setter	set_subdivide_depth(value)
Getter	get_subdivide_depth()

Number of subdivision along the Z axis.

int subdivide_width

Default	`0`
Setter	set_subdivide_width(value)
Getter	get_subdivide_width()

Number of subdivision along the X axis.