| Package | com.eqsim.components |
| Class | public class RoundDialSmooth |
| Inheritance | RoundDialSmooth  RoundDial fl.core.UIComponent |
This class is an extension of RoundDial that provides round dial functionality
with a rate-limited needle (based on a user-specified needle rate). Developers can set its
value in two ways. First, by setting the val property to have the
dial jump immediately to that value. Second, by setting the targVal
property, the dial will reach the target value based on the set needle rate (needleRate).
For convenience, the gauge generates an event, onTargetArrival when it reaches the target value (only if
set using targVal).
To simulate the smooth needle movement, this component updates the needle approximately every
1/20th of a second (note: because it uses Flash's Timer() this interval can be up to twice as slow if the
frame rate is set around 20 fps, due to "features" of the setInterval implementation). Therefore,
if you have more than a few of these components on the stage, you may find that it slows down other processes. If
you need many of these on the Stage at once, you might consider rewriting this to centralize the needle update and
need for all the timers.
Users can change the appearance (skin) of the
hand by modifying: centerDotClassName,
center of the dial by modifying: needleClassName,
the background graphic by modifying: backgroundClassName.
Showing the dial center and background are optional.
| Property | Defined By | ||
|---|---|---|---|
 | backgroundClassName : String
This property gives the class name of the background to use. | RoundDial | |
| centerDotClassName : String
This property gives the class name of the center dot (overlay) to use. | RoundDial | |
| centerVis : Boolean
Boolean property indicating whether the center graphic is visible (true) or not (false). | RoundDial | |
| evtReachTarg : String = onReachTarg
Property that holds the string name of the event generated by this component. | RoundDialSmooth | ||
| needleClassName : String
This property gives the class name of the needle to use. | RoundDial | |
| needleRate : Number
The rate the needle travels when the gauge is set using targVal property. | RoundDialSmooth | ||
| nXScale : Number
Scaling factor along the y axis (height) for the needle. | RoundDial | |
| nYScale : Number | RoundDial | |
| showBack : Boolean
Boolean property indicating whether the background graphic is visible (true) or not (false). | RoundDial | |
| targVal : Number | RoundDialSmooth | ||
| units : int
Number of units in a full cycle for the dial. | RoundDial | |
| val : Number [override]
| RoundDialSmooth | ||
| Property | Defined By | ||
|---|---|---|---|
| _backgroundClassName : String = defRoundDialBkgnd | RoundDial | |
| bkgndClip : Sprite | RoundDial | |
| _centerDotClassName : String = defRoundDialCenter | RoundDial | |
| _centerVis : Boolean = true | RoundDial | |
| dCenterClip : Sprite | RoundDial | |
| dialContainer : Sprite | RoundDial | |
| _inX : Boolean | RoundDialSmooth | ||
| _needleClassName : String = defRoundDialNeedle | RoundDial | |
| needleClip : Sprite | RoundDial | |
| _needleRate : Number = 10 | RoundDialSmooth | ||
| _nXScale : Number = 1 | RoundDial | |
| _nYScale : Number = 1 | RoundDial | |
| _showBack : Boolean = true | RoundDial | |
| _targVal : Number | RoundDialSmooth | ||
| _units : Number = 50 | RoundDial | |
| _unitsPupd : Number | RoundDialSmooth | ||
| _val : Number = 0 | RoundDial | |
| _xTimer : Timer | RoundDialSmooth | ||
| Method | Defined By | ||
|---|---|---|---|
| RoundDialSmooth | |||
destroy():void
Removes internal listeners and memory associated with the component. | RoundDialSmooth | ||
setTargVal(v:Number):void | RoundDialSmooth | ||
| Method | Defined By | ||
|---|---|---|---|
| changeBackground(n:String):void | RoundDial | |
| changeCenterOverlay(n:String):void | RoundDial | |
| changeNeedle(n:String):void | RoundDial | |
configUI():void [override]
configUI
Get the display objects created in preparation of launch. | RoundDialSmooth | ||
draw():void [override]
| RoundDialSmooth | ||
| setNeedle(v:Number):void
Sets the needle to the passed in value v. | RoundDial | |
xCbk(te:TimerEvent):void
Used as callback to update the needle based on increment appropriate for set needle speed. | RoundDialSmooth | ||
| _inX | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _inX:Boolean| _needleRate | property |
protected var _needleRate:Number = 10| _targVal | property |
protected var _targVal:Number| _unitsPupd | property |
protected var _unitsPupd:Number| _xTimer | property |
protected var _xTimer:Timer| evtReachTarg | property |
public var evtReachTarg:String = onReachTargProperty that holds the string name of the event generated by this component. This must be set through the component property panel or programmatically through the initObject parameter of attachMovie/createClassObject.
| needleRate | property |
needleRate:Number
The rate the needle travels when the gauge is set using targVal property. The
rate is in units per second. You can change this property to change the rate, but not during
needle movement (in that case, use setVal() to fix the needle position, adjust
the rate, and set the new target rate).
public function get needleRate():Number public function set needleRate(value:Number):void| targVal | property |
targVal:Number public function get targVal():Number public function set targVal(value:Number):void| val | property |
val:Number[override]
public function get val():Number public function set val(value:Number):void| RoundDialSmooth | () | Constructor |
public function RoundDialSmooth()
| configUI | () | method |
override protected function configUI():voidconfigUI Get the display objects created in preparation of launch. Note that we get called before our constructor, and before we are notified that we are on the stage!
| destroy | () | method |
public function destroy():voidRemoves internal listeners and memory associated with the component.
| draw | () | method |
override protected function draw():void
| setTargVal | () | method |
public function setTargVal(v:Number):void
Parameters
v:Number |
| xCbk | () | method |
protected function xCbk(te:TimerEvent):voidUsed as callback to update the needle based on increment appropriate for set needle speed.
Parameters
te:TimerEvent |