| Package | org.ffilmation.engine.core |
| Class | public class fPlane |
| Inheritance | fPlane  fRenderableElement fElement flash.events.EventDispatcher |
| Subclasses | fFloor, fWall |
fPlanes are the 2d surfaces that provide the main structure for any scene. Once created, planes can't be altered as the render engine relies heavily on precalculations that depend on the structure of the scene.
Planes cannot be instantiated directly. Instead, fWall and fFloor are used.
fPlane contains all the lighting, occlusions and shadowcasting code. They also support bump mapping
YOU CAN'T CREATE INSTANCES OF THIS OBJECT
| Property | Defined by | ||
|---|---|---|---|
 | castShadows : Boolean = true
Boolean value indicating if this object casts shadows.
| fRenderableElement | |
| container : MovieClip The container is the base MovieClip that contains everything. | fRenderableElement | |
| controller : fEngineElementController
Assigns a controller to this element
| fElement | |
| flashClip : MovieClip
A reference to the library movieclip that was attached to create the element, so you
can acces methods inside, nested clips or whatever
| fRenderableElement | |
| holes : Array
Array of holes in this plane.
| fPlane | ||
| id : String
The string identifier of this element.
| fElement | |
| material : fMaterial
Material applied to this plane
| fPlane | ||
| receiveLights : Boolean = true
Boolean value indicating if this object receives lighting.
| fRenderableElement | |
| receiveShadows : Boolean = true
Boolean value indicating if this object receives shadows.
| fRenderableElement | |
| solid : Boolean = true
Boolean value indicating if this object collides with others.
| fRenderableElement | |
| x : Number
X coordinate fot this element
| fElement | |
| xmlObj : XML
This is the XML node from the scene XML that generated this element.
| fElement | |
| y : Number
Y coordinate for this element
| fElement | |
| z : Number
Z coordinate for this element
| fElement | |
| Method | Defined by | ||
|---|---|---|---|
|
call(what:String, param:* = null):void
Calls a function of the base clip
| fRenderableElement | |
|
distanceTo(x:Number, y:Number, z:Number):Number
Returns the distance of this element to the given coordinate
| fElement | |
|
Makes element follow target element
| fElement | |
|
gotoAndPlay(where:*):void
Passes the stardard gotoAndPLay command to the base clip of this element
| fRenderableElement | |
|
gotoAndStop(where:*):void
Passes the stardard gotoAndStop command to the base clip of this element
| fRenderableElement | |
|
hide():void
Makes element invisible
| fRenderableElement | |
|
moveTo(x:Number, y:Number, z:Number):void
Moves the element to a given position
| fElement | |
|
resetShadowsInt():void
| fPlane | ||
|
show():void
Makes element visible
| fRenderableElement | |
|
stopFollowing(target:fElement):void
Stops element from following another element
| fElement | |
| holes | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var holes:ArrayArray of holes in this plane. You can't create holes dynamically, they must be in the plane's definition, but you can open and close them as you wish
See also
| material | property |
public var material:fMaterialMaterial applied to this plane
| resetShadowsInt | () | method |
public function resetShadowsInt():void