BioSimSpace.Types.Coordinate

class BioSimSpace.Types.Coordinate(x, y, z)[source]

A coordinate (position vector).

__init__(x, y, z)[source]

Constructor.

Parameters:
  • x – The x position.

  • y – The y position.

  • z – The z position.

Methods

__init__(x, y, z)

Constructor.

fromVector(vector, unit)

Convert from a unitless BioSimSpace.Types.Vector object.

toVector()

Convert to a unitless BioSimSpace.Types.Vector object.

x()

Return the x component of the coordinate.

y()

Return the y component of the coordinate.

z()

Return the z component of the coordinate.

static fromVector(vector, unit)[source]

Convert from a unitless BioSimSpace.Types.Vector object.

Returns:

  • vector (:class: Vector) – The unitless vector.

  • unit (:class: Length) – The coordinate unit.

toVector()[source]

Convert to a unitless BioSimSpace.Types.Vector object.

Returns:

vector – The unitless vector.

Return type:

class:

Vector

x()[source]

Return the x component of the coordinate.

Returns:

x – The x component of the coordinate.

Return type:

class:

Length

y()[source]

Return the y component of the coordinate.

Returns:

y – The y component of the coordinate.

Return type:

class:

Length

z()[source]

Return the z component of the coordinate.

Returns:

z – The z component of the coordinate.

Return type:

class:

Length