| 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 WARNING!!!: This property only exists when the scene is being rendered and the graphic elements have been created. | fRenderableElement | |
| controller : fEngineElementController
Retrieves controller from this element
| fElement | |
| customData : Object
As elements are not defined as "dynamic", this property can be used to store extra info about this element at run-time.
| 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 currently 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 | ||
|---|---|---|---|
|
assignMaterial(id:String):void
Changes the material for this plane.
| fPlane | ||
|
call(what:String, param:* = null):void
Calls a function of the base clip
| fRenderableElement | |
|
disableMouseEvents():void
Mouse management
| fRenderableElement | |
|
distanceTo(x:Number, y:Number, z:Number):Number
Returns the distance of this element to the given coordinate
| fElement | |
|
enableMouseEvents():void
Mouse management
| fRenderableElement | |
|
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 | |
|
show():void
Makes element visible
| fRenderableElement | |
|
stopFollowing(target:fElement):void
Stops element from following another element
| fElement | |
| Constant | Defined by | ||
|---|---|---|---|
| HIDE : String = "renderableElementHide" [static]
The fRenderableElement.HIDE constant defines the value of the
type property of the event object for a renderableElementHide event. | fRenderableElement | |
| MOVE : String = "elementmove" [static]
The fElement.MOVE constant defines the value of the
type property of the event object for a elementmove event. | fElement | |
| NEWCELL : String = "elementnewcell" [static]
The fElement.NEWCELL constant defines the value of the
type property of the event object for a elementnewcell event. | fElement | |
| NEWMATERIAL : String = "planenewmaterial" [static]
The fPlane.NEWMATERIAL constant defines the value of the
type property of the event object for a planenewmaterial event. | fPlane | ||
| SHOW : String = "renderableElementShow" [static]
The fRenderableElement.SHOW constant defines the value of the
type property of the event object for a renderableElementShow event. | fRenderableElement | |
| 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 material, but you can open and close them
See also
| material | property |
public var material:fMaterialMaterial currently applied to this plane. This object is shared between all planes using the same definition
| assignMaterial | () | method |
public function assignMaterial(id:String):voidChanges the material for this plane.
Parametersid:String — Material Id
|
| NEWMATERIAL | constant |
public static const NEWMATERIAL:String = "planenewmaterial"
The fPlane.NEWMATERIAL constant defines the value of the
type property of the event object for a planenewmaterial event.
The event is dispatched when an new material is assigned to a plane