Packagecom.divillysausages.gameobjeditor
Classpublic class ObjHighlighter
InheritanceObjHighlighter Inheritance flash.display.Shape

If an object is a DisplayObject and we want to highlight it's position, then this will draw a rectangle around it so it can found easier


Public Properties
 PropertyDefined By
  highlight : Boolean
Should we highlight the current object?
ObjHighlighter
  lineAlpha : Number
[write-only] The alpha of the line to draw when we're highlighting the current object
ObjHighlighter
  lineColour : uint
[write-only] The colour of the line to draw when we're highlighting the current object
ObjHighlighter
  lineSize : Number
[write-only] The size of the line to draw when we're highlighting the current object
ObjHighlighter
Public Methods
 MethodDefined By
  
ObjHighlighter(s:Stage)
Creates the ObjHighlighter object
ObjHighlighter
  
clear():void
Clears the highlight graphics
ObjHighlighter
  
update(obj:*):void
Updates the ObjHighlighter.
ObjHighlighter
Property Detail
highlightproperty
highlight:Boolean

Should we highlight the current object?

The default value is false.


Implementation
    public function get highlight():Boolean
    public function set highlight(value:Boolean):void
lineAlphaproperty 
lineAlpha:Number  [write-only]

The alpha of the line to draw when we're highlighting the current object

The default value is 0.5.


Implementation
    public function set lineAlpha(value:Number):void
lineColourproperty 
lineColour:uint  [write-only]

The colour of the line to draw when we're highlighting the current object

The default value is 0xff0000.


Implementation
    public function set lineColour(value:uint):void
lineSizeproperty 
lineSize:Number  [write-only]

The size of the line to draw when we're highlighting the current object

The default value is 1.0.


Implementation
    public function set lineSize(value:Number):void
Constructor Detail
ObjHighlighter()Constructor
public function ObjHighlighter(s:Stage)

Creates the ObjHighlighter object

Parameters
s:Stage — A reference to the Stage so we can add/remove ourselves
Method Detail
clear()method
public function clear():void

Clears the highlight graphics

update()method 
public function update(obj:*):void

Updates the ObjHighlighter. If we're meant to highlight the current object, then we draw a rectangle around it so we can see where it is

Parameters

obj:* — The object we want to draw around





Thu Apr 21 2011, 11:21 PM +02:00