Packageorg.flintparticles.threeD.zones
Classpublic class ParallelogramZone
InheritanceParallelogramZone Inheritance Object
Implements Zone3D

The PrallelogramZone zone defines a four sided zone n which opposite sides are parallel. If the two side vectors are perpendicular to each other, then the zone is rectangular.


Public Properties
 PropertyDefined By
  corner : Vector3D
A corner of the zone.
ParallelogramZone
  side1 : Vector3D
One side of the zone from the corner.
ParallelogramZone
  side2 : Vector3D
The other side of the zone from the corner.
ParallelogramZone
Public Methods
 MethodDefined By
  
ParallelogramZone(corner:Vector3D = null, side1:Vector3D = null, side2:Vector3D = null)
The constructor creates a PrallelogramZone zone.
ParallelogramZone
  
contains(p:Vector3D):Boolean
The contains method determines whether a point is inside the zone.
ParallelogramZone
  
getLocation():Vector3D
The getLocation method returns a random point inside the zone.
ParallelogramZone
  
getVolume():Number
The getVolume method returns the size of the zone.
ParallelogramZone
Property Detail
cornerproperty
corner:Vector3D

A corner of the zone.


Implementation
    public function get corner():Vector3D
    public function set corner(value:Vector3D):void
side1property 
side1:Vector3D

One side of the zone from the corner. The length of the vector indicates how long the side is.


Implementation
    public function get side1():Vector3D
    public function set side1(value:Vector3D):void
side2property 
side2:Vector3D

The other side of the zone from the corner. The length of the vector indicates how long the side is.


Implementation
    public function get side2():Vector3D
    public function set side2(value:Vector3D):void
Constructor Detail
ParallelogramZone()Constructor
public function ParallelogramZone(corner:Vector3D = null, side1:Vector3D = null, side2:Vector3D = null)

The constructor creates a PrallelogramZone zone.

Parameters
corner:Vector3D (default = null) — A corner of the zone.
 
side1:Vector3D (default = null) — One side of the zone from the corner. The length of the vector indicates how long the side is.
 
side2:Vector3D (default = null) — The other side of the zone from the corner. The length of the vector indicates how long the side is.
Method Detail
contains()method
public function contains(p:Vector3D):Boolean

The contains method determines whether a point is inside the zone. This method is used by the initializers and actions that use the zone. Usually, it need not be called directly by the user.

Parameters

p:Vector3D — The x coordinate of the location to test for.

Returns
Boolean — true if point is inside the zone, false if it is outside.
getLocation()method 
public function getLocation():Vector3D

The getLocation method returns a random point inside the zone. This method is used by the initializers and actions that use the zone. Usually, it need not be called directly by the user.

Returns
Vector3D — a random point inside the zone.
getVolume()method 
public function getVolume():Number

The getVolume method returns the size of the zone. This method is used by the MultiZone class. Usually, it need not be called directly by the user.

Returns
Number — a random point inside the zone.



© Richard Lord 2008-2011

Sun Feb 27 2011, 06:00 PM Z