Packageorg.cove.ape
Classpublic class AbstractCollection
SubclassesComposite, Group

The abstract base class for all grouping classes.

You should not instantiate this class directly -- instead use one of the subclasses.



Public Properties
 PropertyDefined by
  constraints : Array
[read-only] The Array of all AbstractConstraint instances added to the AbstractCollection
AbstractCollection
  particles : Array
[read-only] The Array of all AbstractParticle instances added to the AbstractCollection
AbstractCollection
  sprite : Sprite
[read-only] Provides a Sprite to use as a container for drawing or adding children.
AbstractCollection
Public Methods
 MethodDefined by
  
AbstractCollection
  
Adds a constraint to the Collection.
AbstractCollection
  
Adds an AbstractParticle to the AbstractCollection.
AbstractCollection
  
cleanup():void
Calls the cleanup() method of every member of this AbstractCollection.
AbstractCollection
  
getAll():Array
Returns an array of every particle and constraint added to the AbstractCollection.
AbstractCollection
  
init():void
Initializes every member of this AbstractCollection by in turn calling each members init() method.
AbstractCollection
  
paint():void
paints every member of this AbstractCollection by calling each members paint() method.
AbstractCollection
  
Removes a constraint from the Collection.
AbstractCollection
  
Removes an AbstractParticle from the AbstractCollection.
AbstractCollection
Property detail
constraintsproperty
constraints:Array  [read-only]

The Array of all AbstractConstraint instances added to the AbstractCollection

Implementation
    public function get constraints():Array
particlesproperty 
particles:Array  [read-only]

The Array of all AbstractParticle instances added to the AbstractCollection

Implementation
    public function get particles():Array
spriteproperty 
sprite:Sprite  [read-only]

Provides a Sprite to use as a container for drawing or adding children. When the sprite is requested for the first time it is automatically added to the global container in the APEngine class.

Implementation
    public function get sprite():Sprite
Constructor detail
AbstractCollection()constructor
public function AbstractCollection()
Method detail
addConstraint()method
public function addConstraint(c:AbstractConstraint):void

Adds a constraint to the Collection.

Parameters
c:AbstractConstraint — The constraint to be added.
addParticle()method 
public function addParticle(p:AbstractParticle):void

Adds an AbstractParticle to the AbstractCollection.

Parameters
p:AbstractParticle — The particle to be added.
cleanup()method 
public function cleanup():void

Calls the cleanup() method of every member of this AbstractCollection. The cleanup() method is called automatically when an AbstractCollection is removed from its parent.

getAll()method 
public function getAll():Array

Returns an array of every particle and constraint added to the AbstractCollection.

Returns
Array
init()method 
public function init():void

Initializes every member of this AbstractCollection by in turn calling each members init() method.

paint()method 
public function paint():void

paints every member of this AbstractCollection by calling each members paint() method.

removeConstraint()method 
public function removeConstraint(c:AbstractConstraint):void

Removes a constraint from the Collection.

Parameters
c:AbstractConstraint — The constraint to be removed.
removeParticle()method 
public function removeParticle(p:AbstractParticle):void

Removes an AbstractParticle from the AbstractCollection.

Parameters
p:AbstractParticle — The particle to be removed.