Attention

You are viewing PyUnity docs under the develop branch. As such, they are only applicable if you installed from source. Go to https://docs.pyunity.x10.bz/en/latest/ for the most recent release.

pyunity.meshes module

Source code: pyunity/meshes.py

---

Module for meshes created at runtime and their various attributes.

class pyunity.meshes.Mesh

Bases: Asset

Class to create a mesh for rendering with a MeshRenderer

Parameters:

• verts (list) – List of Vector3’s containing each vertex

• triangles (list) – List of ints containing triangles joining up the vertices. Each int is the index of a vertex above.

• normals (list) – List of Vector3’s containing the normal of each vertex.

verts

List of Vector3’s containing each vertex

Type:

list

triangles

List of lists containing triangles joining up the vertices. Each int is the index of a vertex above. The list is two-dimesional, meaning that each item in the list is a list of three ints.

Type:

list

normals

List of Vector3’s containing the normal of each vertex.

Type:

list

texcoords

List of lists containing the texture coordinate of each vertex. The list is two-dimesional, meaning that each item in the list is a list of two floats.

Type:

list (optional)

Notes

When any of the mesh attributes are updated while a scene is running, you must use compile(force=True) to update the mesh so that it is displayed correctly.

>>> mesh = Mesh.cube(2)
>>> mesh.vertices[1] = Vector3(2, 0, 0)
>>> mesh.compile(force=True)

compile(force=False)

draw()

copy()

Create a copy of the current Mesh.

Returns:

Copy of the mesh

Return type:

Mesh

GetAssetFile(gameObject)

SaveAsset(ctx)

static quad(size)

Creates a quadrilateral mesh.

Parameters:

size (float) – Side length of quad

Returns:

A quad centered at Vector3(0, 0, 0) with side length of size facing in the direction of the positive z axis.

Return type:

Mesh

static doubleQuad(size)

Creates a two-sided quadrilateral mesh.

Parameters:

size (float) – Side length of quad

Returns:

A double-sided quad centered at Vector3(0, 0) with side length of size.

Return type:

Mesh

static cylinder(radius, height, detail=32)

static sphere(size, detail=16)

static capsule(radius, height, detail=16)

static cube(size)

Creates a cube mesh.

Parameters:

size (float) – Side length of cube

Returns:

A cube centered at Vector3(0, 0, 0) that has a side length of size

Return type:

Mesh

class pyunity.meshes.Material

Bases: Asset

Class to hold data on a material.

color

An albedo tint.

Type:

Color

texture

A texture to map onto the mesh provided by a MeshRenderer

Type:

Texture2D

GetAssetFile(gameObject)

SaveAsset(ctx)

class pyunity.meshes.Color

Bases: object

toString()

static fromString(string)

class pyunity.meshes.RGB

Bases: Color

A class to represent an RGB color.

Parameters:

• r (int) – Red value (0-255)

• g (int) – Green value (0-255)

• b (int) – Blue value (0-255)

toRGB()

toHSV()

static fromHSV(h, s, v)

class pyunity.meshes.HSV

Bases: Color

A class to represent a HSV color.

Parameters:

• h (int) – Hue (0-360)

• s (int) – Saturation (0-100)

• v (int) – Value (0-100)

toRGB()

toHSV()

static fromRGB(r, g, b)

class pyunity.meshes.MeshRenderer

Bases: SingleComponent

Component to render a mesh at the position of a transform.

mesh = None

Mesh that the MeshRenderer will render.

Type:

Mesh

mat = <pyunity.meshes.Material object at 0x7fc4aa68eb50>

Material to use for the mesh

Type:

Material

DefaultMaterial = <pyunity.meshes.Material object>

Type:    Material

Render()

Render the mesh that the MeshRenderer has.