Xray Class
Class com.blitzagency.xray.Xray
Inheritance
>
Xray
Entry point for the Xray Connector Component. Establishes static properties for use in the host application.
| Property Summary |
|---|
| Array | Inspectable property for the component inspector in the Flash IDE. |
| static FPSMeter | fpsMeter is a singleton, and this is a static reference to it from Xray. |
| static FunctionName | Instance of the functionName class. |
| static ControlConnection | lc_exec handles executions and treeviews. |
| static LoggerConnection | lc_info handles all of the logging traffic. |
| static PointConverter | PointConverter is a static class, and this is a static reference to it from Xray. |
| static Number | RecursionControl is a static control number letting the loop know that a particular object's been looped. |
| Boolean | Inspectable property for the component inspector in the Flash IDE. |
| static XrayTrace | xrayTrace is a singleton, and this is a static reference to it from Xray. |
| Method Summary |
|---|
| static Void | adds class pacakges to the ClassPath |
| static MovieClip | This method does just what it says: creates a FPS meter on stage inside of the movieclip provided.
If a target_mc is not passed, _level0 is used. |
| static Void | Init is called by the onLoad event defined in the component on stage/in the library. We let the onLoad call init()
to avoid the local connections in com.blitzagency.xray.AdminTool from being connected at design time
when put on stage. Simply using _global.isLivePreview did not keep this from firing (as of Flash 7 anyway) |
| static Void | initConnections is called via component in the library when onLoad fires. If the connection names are not
being used by another Flash app, both boolean check variables will return true; |
| static | tf() is used within function calls. |
| static | Traces the supplied objects in the . |
| static Void | Traces the supplied objects in the Xray client. |
| static Void | Deals with recieving events from the FPSMeter object and sending to the interface via lc_exec.sendFPS() |
classPackages
public var classPackages:Array;
Inspectable property for the component inspector in the Flash IDE.
This lets the user add class packages if they're not under the normal mx or com locations.
Note: for this feature to work, the xray needs to be present on stage at runtime.
fpsMeter
fpsMeter is a singleton, and this is a static reference to it from Xray.
This dispatches an onFpsUpdate event and passes an object a single property: obj.fps
functionName
Instance of the functionName class. FunctionName returns a method's name if it can be located.
lc_exec
lc_exec handles executions and treeviews.
lc_info
lc_info handles all of the logging traffic.
pointConverter
PointConverter is a static class, and this is a static reference to it from Xray.
recursionControl
public static var recursionControl:Number;
RecursionControl is a static control number letting the loop know that a particular object's been looped.
the idea is that we'll switch it back and forth. I was deleting the check (using boolean flag) after the obj had been looped, but
that does't account for cross object refrences, it only helps in situations where a child references a parent property/object.
showFPS
public var showFPS:Boolean;
Inspectable property for the component inspector in the Flash IDE.
Setting showFPS to 'true' will cause the component to create a sub movieclip container with textfield
and will add a listener to the fpsMeter object for an easy view of Frames Per Second without the Xray Interface.
Note: for this feature to work, the xray needs to be present on stage at runtime.
xrayTrace
xrayTrace is a singleton, and this is a static reference to it from Xray.
The Xray class controls and deals with all of the incoming and outgoing LocalConnections.
addPackages
public static function addPackages(ary:Array):Void
Parameters:
ary:Array- - array of strings representing packages to include.
Returns:
nothing
createFPSMeter
public static function createFPSMeter(target_mc:MovieClip):MovieClip
Parameters:
target_mc:Movieclip- Where the movieclip is to be created
Returns:
movieclip reference to the FPS Meter
init
public static function init():Void
initConnections
public static function initConnections():Void
Returns:
nothing
tf
public static function tf()
tf() is used within function calls.
It will output the name of the called function,
the timeline in which it exists and the arguments sent.
NOTE: as of 1.2.7 this is still a relatively new and untested method in the . Try sending different object references
if "this" doesn't yeild any results. Basically, it needs an object/timeline to loop to match up arguments.callee with.
More info on this method can be found here:
http://labs.blitzagency.com/?p=51Parameters:
arguments- Arguments Array The arguments array of the function/method being called.
object- Object The reference to the object that the function is apart of (movieclip/class etc).
Example
function foo(parm1, parm2, parm3)
{
Connector.tf(arguments, this);
}
trace
public static function trace()
tt
public static function tt():Void
updateFps
public static function updateFps(obj:Object):Void
Documentation generated by BLDoc Community Edition from B-Line Express.