Stats monitor for Away3D or general use in any project. The widget was designed to
display all the necessary data in ways that are easily readable, while maintaining a
tiny size.
The following data is displayed by the widget, either graphically, through
text, or both.
- Current frame rate in FPS (white in graph/bar)
- SWF frame rate (Stage.frameRate)
- Average FPS (blue in graph/bar)
- Min/Max FPS (only on frame rate bar in minimized mode)
- Current RAM usage (pink in graph)
- Maximum RAM usage
- Number of polygons in scene
- Number of polygons last rendered (yellow in graph)
There are two display modes; standard and minimized, which are alternated by clicking
the button in the upper right corner, at runtime. The widget can also be configured to
start in minimized mode by setting the relevant constructor parameter.
All data can be reset at any time, by clicking the lower part of the widget (where
the RAM and POLY counters are located. The average FPS can be reset separately by
clicking it's displayed value. Furthermore, the stage frame rate can be increased or
decreased by clicking the upper and lower parts of the graph, respectively. Clicking close
to the center will increment in small values, and further away will increase the steps.
The graph itself is only visible in standard (as opposed to minimized) display mode.
The average FPS is calculated using one of two methods, configurable via constructor
parameters. By setting the meanDataLength to a non-zero value, the number of recorded
frame rate values on which the average is based can be configured. This has a tiny
impact on CPU usage, which is the reason why the default number is zero, denoting that
the average is calculated from a running sum since the widget was last reset.
instance:AwayStats [read-only]
Holds a reference to the stats widget (or if several have been created
during session, the one that was last instantiated.) Allows you to set
properties and register views from anywhere in your code.
Implementation
public static function get instance():AwayStats
public function AwayStats(view3d:View3D = null, minimized:Boolean = false, transparent:Boolean = false, meanDataLength:uint = 0, enableClickToReset:Boolean = true, enableModifyFrameRate:Boolean = true)Parameters
| view3d:View3D (default = null) |
| |
| minimized:Boolean (default = false) |
| |
| transparent:Boolean (default = false) |
| |
| meanDataLength:uint (default = 0) |
| |
| enableClickToReset:Boolean (default = true) |
| |
| enableModifyFrameRate:Boolean (default = true) |
Init Parameters
public function registerView(view3d:View3D):void
Add a view to the list of those that are taken into account when
calculating on-screen and total poly counts. Use this method when the
stats widget is not instantiated in the same place as where you create
your view, or when using several views, or when views are created and
destroyed dynamically at runtime.
Parameters
public function unregisterView(view3d:View3D):void
Remove a view from the list of those that are taken into account when
calculating on-screen and total poly counts. If the supplied view is
the only one known to the stats widget, calling this will leave the
list empty, disabling poly count statistics altogether.
Parameters
flash.display.Sprite