Package esys :: Package lsm :: Package geometry :: Module GeometryPy :: Class ParticleCollection
[hide private]
[frames] | no frames]

Class ParticleCollection

 object --+    
          |    
??.instance --+
              |
             ParticleCollection
Known Subclasses:

A collection of SimpleSphere objects.

Instance Methods [hide private]
 
__getstate__(...)
 
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
ParticleCollectionParticleIterator
__iter__(...)
Returns an iterator for enumerating particles in this collection.
int
__len__(...)
Returns number of particles in this collection.
 
__reduce__(...)
helper for pickle
 
__setstate__(...)
SimpleSphere
createParticle(...)
Creates a particle in this collection, lifetime of particle is tied to this collection.
int
getNumParticles(...)
Returns the number of particles in this collection.
esys.lsm.util.FoundationPy.BoundingBox
getParticleBBox(...)
Returns the axis aligned bounding box of all particles in this collection.
 
rotate(...)
Rotates all particles in this collection about a specifed axis of rotation which passes through a specified point.
 
translate(...)
Translates all particles in this collection by the specified amount.

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  __getstate_manages_dict__ = True
  __instance_size__ = 64
  __safe_for_unpickling__ = True
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

__iter__(...)

 

Returns an iterator for enumerating particles in this collection.

Returns: ParticleCollectionParticleIterator
particle iterator.

__len__(...)
(Length operator)

 

Returns number of particles in this collection.

Returns: int
number of particles.

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

createParticle(...)

 

Creates a particle in this collection, lifetime of particle is tied to this collection.

Parameters:
  • particle (SimpleSphere) - A copy of this particle is created.
Returns: SimpleSphere
reference to newly created particle.

getNumParticles(...)

 

Returns the number of particles in this collection.

Returns: int
number of particles

getParticleBBox(...)

 

Returns the axis aligned bounding box of all particles in this collection.

Returns: esys.lsm.util.FoundationPy.BoundingBox
tight bounding box for all particles in this collection.

rotate(...)

 

Rotates all particles in this collection about a specifed axis of rotation which passes through a specified point.

Parameters:

translate(...)

 

Translates all particles in this collection by the specified amount.

Parameters: