Package schrodinger :: Package graphics3d :: Module gridbox :: Class GridBox
[hide private]
[frames] | no frames]

Class GridBox

object --+
         |
        GridBox

Class for drawing a grid box to the Workspace.

Instance Methods [hide private]
 
__init__(self, center=(0.0, 0.0, 0.0), inner_box_size=(10.0, 10.0, 10.0), outer_box_size=(30.0, 30.0, 30.0), display_center_box=True, display_enclosing_box=True)
Create an instance of the grid box, hidden initially.
 
__del__(self)
 
_workspaceDraw(self)
A Workspace-draw callback registered with Maestro.
 
__setattr__(self, name, value)
Custom setter for the attributes that affect the drawing of the box.
bool
isShown(self)
Returns: Whether the grid box is currently shown.
 
hide(self)
Hide the grid box (don't draw to the Workspace).
 
show(self)
Show the grid box.
 
_updateObjects(self)
Will re-create the boxes and axes objects, and draw them if the grid box is currently shown.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, center=(0.0, 0.0, 0.0), inner_box_size=(10.0, 10.0, 10.0), outer_box_size=(30.0, 30.0, 30.0), display_center_box=True, display_enclosing_box=True)
(Constructor)

 

Create an instance of the grid box, hidden initially. Call the show() method to display the box. The box parameters can be modified by setting the object's attributes with same names as the arguments to this init method - the box will be automatically re-drawn.

Parameters:
  • center ((float, float, float)) - Center coordinates of the box.
  • inner_box_size ((float, float, float)) - Inner box size. Defaults to 10 in all dimensions. Typical range is 6-40A.
  • outer_box_size ((float, float, float)) - Outer box size. Defaults to 30 in all dimensions. Usually set to inner_box_size + maximum ligand length.
  • display_center_box (bool) - Whether to show the center (inner) box.
  • display_enclosing_box (bool) - Whether to show the outer grid box.
Overrides: object.__init__

_workspaceDraw(self)

 

A Workspace-draw callback registered with Maestro. Called every time the Workspace is re-drawn.

__setattr__(self, name, value)

 

Custom setter for the attributes that affect the drawing of the box.

Overrides: object.__setattr__

isShown(self)

 
Returns: bool
Whether the grid box is currently shown.