API Reference for Enthought Tool Suite 3.2.0

Function summary

• clip(value, low, high)
• distance_to_line(pt1, pt2, mouse)
• dot(pt1, pt2)
• mag(pt)
• point_in_box(pt1, pt2, mouse, tolerance = 0)
• subtract(pt1, pt2)

Functions

• clip(value, low, high)

  Clip value so that it is betwen low and high values.

  Example:

  >>> clip(5, 0, 10)
  5
  >>> clip(-5, 0, 10)
  0
  >>> clip(15, 0, 10)
  10
  

• distance_to_line(pt1, pt2, mouse)

  Calculate the distance of the mouse from lint pt1->pt2 All three inputs are 2 element lists of x,y pairs.

  examples:

  >>> distance_to_line([0,0],[1,1],[.5,.5])
  0.0
  >>> distance_to_line([0,0],[1,1],[0,0])
  0.0
  >>> distance_to_line([0,0],[1,1],[0,1])
  0.70710678118654757
  >>> distance_to_line([10,1],[20,5],[15,14])
  10.213243599737853
  

  Implementation from:

  http://msdn2.microsoft.com/en-us/library/ms969920.aspx

• dot(pt1, pt2)

  Calculate the dot product of two 2D vectors.

  pt1 and pt2 can be any sort of indexed sequence.

  Example:

  >>> dot([0,1], [1,0]) # orthogonal vectors have zero projection.
  0.0
  >>> dot([1,1], [1,0]) # 45 degree angle has projection of 1.
  1.0
  

• mag(pt)

  Calculate the magnitude of a vector.

  Example:

  >>> mag([3,4])
  5.0
  >>> mag([3,-4]) # ignore
  5.0
  

• point_in_box(pt1, pt2, mouse, tolerance = 0)

  Returns if the point x,y is in the box.

  Inclusive on the lower end, excluive on the upper end.

  tolerance -- default 0. It expands the box the given amount.

  examples:

  >>> point_in_box([0,0], [1,1], [.5,.5])
  True
  >>> point_in_box([0,0], [1,1], [1.1,.5])
  False
  

• subtract(pt1, pt2)

  Subtract one 2D vector from another.

  Example:

  >>> subtract([2,1],[.5,.1])
  [1.5, 0.90000000000000002]
  

Imported Names

© Copyright 2002-2009 Enthought, Inc.