Package | org.cove.ape |
Class | public class Group |
Inheritance | Group ![]() |
Property | Defined 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 | ||
![]() | constraints : Array
The Array of all AbstractConstraint instances added to the AbstractCollection
| AbstractCollection | |
![]() | particles : Array
The Array of all AbstractParticle instances added to the AbstractCollection
| AbstractCollection | |
![]() | sprite : Sprite
Provides a Sprite to use as a container for drawing or adding children.
| AbstractCollection |
Method | Defined by | ||
---|---|---|---|
Group(collideInternal:Boolean = false)
The Group class is the main organizational class for APE.
| Group | ||
addCollidable(g:Group):void
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 | ||
addComposite(c:Composite):void
Adds a Composite to the Group.
| Group | ||
![]() |
addConstraint(c:AbstractConstraint):void
Adds a constraint to the Collection.
| AbstractCollection | |
![]() |
addParticle(p:AbstractParticle):void
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 | ||
removeCollidable(g:Group):void
Removes a Group from the collidable list of this Group.
| Group | ||
removeComposite(c:Composite):void
Removes a Composite from the Group.
| Group | ||
![]() |
removeConstraint(c:AbstractConstraint):void
Removes a constraint from the Collection.
| AbstractCollection | |
![]() |
removeParticle(p:AbstractParticle):void
Removes an AbstractParticle from the AbstractCollection.
| AbstractCollection |
collideInternal | property |
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
collisionList | property |
collisionList:Array
[read-only]Returns the array of every Group assigned to collide with this Group instance.
Implementation public function get collisionList():Array
composites | property |
composites:Array
[read-only]Returns an Array containing all the Composites added to this Group
Implementation public function get composites():Array
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.
ParameterscollideInternal:Boolean (default = false )
|
addCollidable | () | method |
public function addCollidable(g:Group):void
Adds an Group instance to be checked for collision against this one.
Parametersg:Group |
addCollidableList | () | method |
public function addCollidableList(list:Array):void
Adds an array of AbstractCollection instances to be checked for collision against this one.
Parameterslist:Array |
addComposite | () | method |
public function addComposite(c:Composite):void
Adds a Composite to the Group.
Parametersc: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.
ReturnsArray |
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.
Parametersg:Group |
removeComposite | () | method |
public function removeComposite(c:Composite):void
Removes a Composite from the Group.
Parametersc:Composite — The Composite to be removed.
|