# vispy.visuals.plane module

class vispy.visuals.plane.PlaneVisual(width=1, height=1, width_segments=1, height_segments=1, direction='+z', vertex_colors=None, face_colors=None, color=(0.5, 0.5, 1, 1), edge_color=None)

  Bases: `CompoundVisual`

  Visual that displays a plane.

  Parameters:
    width float

      Plane width.

    height float

      Plane height.

    width_segments int

      Plane segments count along the width.

    height_segments float

      Plane segments count along the height.

    direction: unicode

      `{'-x', '+x', '-y', '+y', '-z', '+z'}` Direction the plane will be facing.

    vertex_colors ndarray

      Same as for MeshVisual class. See create_plane for vertex ordering.

    face_colors ndarray

      Same as for MeshVisual class. See create_plane for vertex ordering.

    color Color

      The Color to use when drawing the cube faces.

    edge_color tuple or Color

      The Color to use when drawing the cube edges. If None, then no cube edges are drawn.

previous

vispy.visuals.mesh_normals module

next

vispy.visuals.polygon module