Module gengeo :: Class Sphere

[hide private]
[frames] | no frames]

# Class Sphere

     object --+
              |
    ??.instance --+
                  |
                 Sphere

A class defining a sphere.

Instance Methods | [hide private]

Vector3

Centre(...) Returns the centre of the sphere. |

int

Id(...) Returns the particle ID of the sphere. |

double

Radius(...) Returns the radius of the sphere. |

int

Tag(...) Returns the particle tag of the sphere. |

__init__(...) Constructs a sphere with the specified centre and radius. |

__reduce__(...) helper for pickle |

__str__(...) str(x) |

int

setId(...) Sets the ID of the sphere. |

int

setTag(...) Sets the particle tag of the sphere. |

Inherited from `unreachable.instance`: `__new__` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Class Variables | [hide private]

| __instance_size__ = `72`

Properties | [hide private]

Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(...)
(Constructor)

Constructs a sphere with the specified centre and radius. N.B. This is not a AVolume3D so cannot be used by `InsertGenerators`.

Parameters:
  - `centre` (Vector3) - the centre of the sphere
  - `radius` (double) - the radius of the sphere
Overrides: object.__init__

### __reduce__(...)

helper for pickle

Overrides: object.__reduce__
  (inherited documentation)

### __str__(...)
(Informal representation operator)

str(x)

Overrides: object.__str__
  (inherited documentation)