Packageorg.cove.ape
Classpublic class Group
InheritanceGroup Inheritance AbstractCollection

The Group class can contain Particles, Constraints, and Composites. Groups can be assigned to be checked for collision with other Groups or internally.



Public Properties
 PropertyDefined by
  collideInternal : Boolean
Determines if the members of this Group are checked for collision with one another.
Group
  collisionList : Array
[read-only] Returns the array of every Group assigned to collide with this Group instance.
Group
  composites : Array
[read-only] Returns an Array containing all the Composites added to this Group
Group
 Inheritedconstraints : Array
The Array of all AbstractConstraint instances added to the AbstractCollection
AbstractCollection
 Inheritedparticles : Array
The Array of all AbstractParticle instances added to the AbstractCollection
AbstractCollection
 Inheritedsprite : Sprite
Provides a Sprite to use as a container for drawing or adding children.
AbstractCollection
Public Methods
 MethodDefined by
  
Group(collideInternal:Boolean = false)
The Group class is the main organizational class for APE.
Group
  
Adds an Group instance to be checked for collision against this one.
Group
  
addCollidableList(list:Array):void
Adds an array of AbstractCollection instances to be checked for collision against this one.
Group
  
Adds a Composite to the Group.
Group
 Inherited
Adds a constraint to the Collection.
AbstractCollection
 Inherited
Adds an AbstractParticle to the AbstractCollection.
AbstractCollection
  
cleanup():void
Calls the cleanup() method of every member of this Group.
Group
  
getAll():Array
Returns an array of every particle, constraint, and composite added to the Group.
Group
  
init():void
Initializes every member of this Group by in turn calling each members init() method.
Group
  
paint():void
Paints all members of this Group.
Group
  
Removes a Group from the collidable list of this Group.
Group
  
Removes a Composite from the Group.
Group
 Inherited
Removes a constraint from the Collection.
AbstractCollection
 Inherited
Removes an AbstractParticle from the AbstractCollection.
AbstractCollection
Property detail
collideInternalproperty
collideInternal:Boolean  [read-write]

Determines if the members of this Group are checked for collision with one another.

Implementation
    public function get collideInternal():Boolean
    public function set collideInternal(value:Boolean):void
collisionListproperty 
collisionList:Array  [read-only]

Returns the array of every Group assigned to collide with this Group instance.

Implementation
    public function get collisionList():Array
compositesproperty 
composites:Array  [read-only]

Returns an Array containing all the Composites added to this Group

Implementation
    public function get composites():Array
Constructor detail
Group()constructor
public function Group(collideInternal:Boolean = false)

The Group class is the main organizational class for APE. Once groups are created and populated with particles, constraints, and composites, they are added to the APEngine. Groups may contain particles, constraints, and composites. Composites may only contain particles and constraints.

Parameters
collideInternal:Boolean (default = false)
Method detail
addCollidable()method
public function addCollidable(g:Group):void

Adds an Group instance to be checked for collision against this one.

Parameters
g:Group
addCollidableList()method 
public function addCollidableList(list:Array):void

Adds an array of AbstractCollection instances to be checked for collision against this one.

Parameters
list:Array
addComposite()method 
public function addComposite(c:Composite):void

Adds a Composite to the Group.

Parameters
c:Composite — The Composite to be added.
cleanup()method 
public override function cleanup():void

Calls the cleanup() method of every member of this Group. The cleanup() method is called automatically when an Group is removed from the APEngine.

getAll()method 
public override function getAll():Array

Returns an array of every particle, constraint, and composite added to the Group.

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

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

paint()method 
public override function paint():void

Paints all members of this Group. This method is called automatically by the APEngine class.

removeCollidable()method 
public function removeCollidable(g:Group):void

Removes a Group from the collidable list of this Group.

Parameters
g:Group
removeComposite()method 
public function removeComposite(c:Composite):void

Removes a Composite from the Group.

Parameters
c:Composite — The Composite to be removed.