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:
widthfloat

Plane width.

heightfloat

Plane height.

width_segmentsint

Plane segments count along the width.

height_segmentsfloat

Plane segments count along the height.

direction: unicode

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

vertex_colorsndarray

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

face_colorsndarray

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

colorColor

The Color to use when drawing the cube faces.

edge_colortuple or Color

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