generate_arrow module

http://pymolwiki.org/index.php/cgo_arrow

  1. 2013 Thomas Holder, Schrodinger Inc.

License: BSD-2-Clause

generate_arrow.cgo_arrow(origin, endpoint, color='blue', radius=0.1, gap=0.0, hlength=-1, hradius=-1, type='electric', name='', scaling=7, use_lab=True)
Parameters

  • origin (List of floats) – List representing origin point of vector to be drawn

  • endpoint (List of floats) – List representing endpoint of vector to be drawn

  • color (String, optional - default blue) – Color of arrow

  • radius (Float, optional - default .1) – Radius of cylinder portion of arrow

  • gap (Float, optional - default 0) – Specifies a gap between the head and body of the arrow, if desired

  • hlength (Float, optional - default -1) – Length of the head of the arrow

  • hradius (Float, optional - default -1) – Radius of the head of the arrow

  • type (String, optional - default electric) – Type of vector being drawn, electric or magnetic

  • name (String, optional - default blank) – Name to be shown in PyMol for the cgo object

  • scaling (Int, optional - default 7) – Scaling factor that is passed to scale_endpoint function

Returns

None

generate_arrow.scale_endpoint(end, factor=5)
Parameters

  • end (List of floats) – A list representing the endpoint of the vectors

  • factor (Int, optional - default 5) – The scaling factor for end to be increased by

Returns

Modified end vector

Return type

List of floats

generate_arrow.shift_vectors(start, atomCoords)
Parameters

  • start (List of floats) – A list representing the starting point of the vector

  • atomCoords (List of floats) – The coordinates of the atom from which the vector will originate

Returns

Modified start vector

Return type

List of floats