cadnano.extras.math.box module

class Box(min_point, max_point)

Bases: object

Cube box object

For doing an oct tree type thing

Parameters:
  • min_point (Tuple) – length 3 lower left corner
  • max_point (Tuple) – length 3 diagonal opposite top corner
center()

Return the center of this Box

Returns:Vector3 – the center point of this box.
clone()

Clone this Box

Returns:Box – a copy of this box.
containsBox(box)

Does this object contain the Box box?

Parameters:Box –
Returns:bool – True if box is in self otherwise False
containsPoint(point)

Is the point within this Box?

Parameters:point (Vector3) – to check for inclusion.
Returns:bool –
True if the specified point lies within the boundaries
of this box False otherwise
doesBoxSpan(box)

doe this object contain the Box box? :param Box:

Returns:bool – True if box spans self otherwise False
set(min_point, max_point)

Set the Tuples

Setter for setting the bounding points of the Box

Parameters:
  • min_point (Tuple) – length 3 lower left corner
  • max_point (Tuple) – length 3 diagonal opposite top corner
size()

Find the dimensions of the Box

Returns:Tuple – the width, height, and depth of this box.