PYME.LMVis.layers.ScaleBoxOverlayLayer module

class PYME.LMVis.layers.ScaleBoxOverlayLayer.ScaleBoxOverlayLayer(tick_distance=1000, color=None, **kwargs)

Bases: OverlayLayer

Parameters

color [r, g, b] , rgb = float [0.0,1.0]

flip_starts(flip_x=None, flip_y=None, flip_z=None)

There’s six possible sides of the bounding box. Only three are used to draw the grids. With this method you can change to the other ones. Parameters ———- flip_x change grid position in the x plane flip_y change grid position in the y plane flip_z change grid position in the z plane

Returns

get_tick_distance()

render(gl_canvas)

Abstract render method to be over-ridden in derived classes. Should check self.visible before drawing anything.

Parameters

gl_canvasthe canvas to draw to - an instance of PYME.LMVis.gl_render3D_shaders.LMGLShaderCanvas

set_box_dimensions(box_dimensions)

Parameters

box_dimensions (width, height, depth) or (x/y/z) in nm

is smaller than tick size, tick size is used

Returns

set_color(color)

set_starts(start_x, start_y, start_z)

set_tick_distance(value)

Set the distance between two ticks in the box Parameters ———- value float, >0

Returns

show(boolean)