Packagecom.senocular.display.transform
Classpublic class ControlRegistration
InheritanceControlRegistration Inheritance ControlInteractive Inheritance Control Inheritance flash.display.Sprite

Displays and allows users to move the registration point being used by the Transform Tool's target instance. The registration point is the point around which all transformations take place.



Public Properties
 PropertyDefined By
 Inheritedcursor : Cursor
The cursor to be used when interacting with this control.
ControlInteractive
  editable : Boolean
Determines whether or not the registration point can be moved by the user.
ControlRegistration
 InheritedfillAlpha : Number
The alpha of the color used for filled shapes in dynamically drawn control graphics.
Control
 InheritedfillColor : uint
The color to be used for filled shapes in dynamically drawn control graphics.
Control
 InheritedlineAlpha : Number
The alpha of the color used for outlines in dynamically drawn control graphics.
Control
 InheritedlineColor : uint
The color to be used for outlines in dynamically drawn control graphics.
Control
 InheritedlineThickness : Number
The thickness used for outlines in dynamically drawn control graphics.
Control
 Inheritedtool : TransformTool
A reference to the TransformTool instance the control was placed, defined in the ADDED_TO_STAGE event.
Control
Protected Properties
 PropertyDefined By
 InheritedactiveLocalX : Number
Mouse location in x axis within the target object coordinate space while the control is being dragged.
ControlInteractive
 InheritedactiveLocalY : Number
Mouse location in y axis within the target object coordinate space while the control is being dragged.
ControlInteractive
 InheritedactiveMouseEvent : MouseEvent
The most recent mouse event received by the activeTarget dispatcher when consuming mouse events.
ControlInteractive
 InheritedactiveTarget : IEventDispatcher
The object from which mouse events are consumed.
ControlInteractive
 InheritedactiveX : Number
Mouse location in x axis within the Transform Tool coordinate space while the control is being dragged.
ControlInteractive
 InheritedactiveY : Number
Mouse location in y axis within the Transform Tool coordinate space while the control is being dragged.
ControlInteractive
 InheritedbaseLocalMatrixInverted : Matrix
Inverted base matrix used to convert locations in the Transform Tool coordinate space into locations within the target object coordinate space.
ControlInteractive
 InheritedbaseLocalRegistration : Point
Registration point location within the target object coordinate space when the control is first clicked.
ControlInteractive
 InheritedbaseLocalX : Number
Mouse location in x axis within the target object coordinate space after offsets are applied when the control is first clicked.
ControlInteractive
 InheritedbaseLocalY : Number
Mouse location in y axis within the target object coordinate space when the control is first clicked.
ControlInteractive
 InheritedbaseRegistration : Point
Registration point location within the Transform Tool coordinate space when the control is first clicked.
ControlInteractive
 InheritedbaseX : Number
Mouse location in x axis within the Transform Tool coordinate space when the control is first clicked.
ControlInteractive
 InheritedbaseY : Number
Mouse location in y axis within the Transform Tool coordinate space when the control is first clicked.
ControlInteractive
 InheritedlocalMouse : Point
Mouse location within the target object coordinate space when the control is first clicked.
ControlInteractive
 Inheritedmouse : Point
Mouse location within the Transform Tool coordinate space when the control is first clicked.
ControlInteractive
 InheritedoffsetMouse : Point
Offset for the mouse position.
ControlInteractive
Public Methods
 MethodDefined By
  
Constructor for creating new ControlRegistration instances.
ControlRegistration
  
draw():void
[override] Draws the visuals of the control.
ControlRegistration
  
redraw(event:Event):void
[override] Handler for the TransformTool.REDRAW event.
ControlRegistration
Protected Methods
 MethodDefined By
  
activeMouseMove(event:MouseEvent):void
[override] Handler for the MouseEvent.MOUSE_MOVE event from the activeTarget object.
ControlRegistration
 Inherited
activeMouseUp(event:MouseEvent):void
Handler for the MouseEvent.MOUSE_UP event (capture and no capture) from the activeTarget object.
ControlInteractive
 Inherited
added(event:Event):void
Handler for the Event.ADDED event (capture).
Control
 Inherited
addedToStage(event:Event):void
Handler for the Event.ADDED_TO_STAGE event.
Control
 Inherited
calculateAndUpdate(commit:Boolean = true, enforceNegativeScaling:Boolean = true):void
Calls calculateTransform and update from the parent TransformTool instance.
ControlInteractive
 Inherited
Clears variables and listeners for tracking the mouse location.
ControlInteractive
 Inherited
Cleanup steps when defining a new cursor value.
ControlInteractive
 Inherited
Cleanup steps when defining a new tool value.
Control
  
doubleClick(event:MouseEvent):void
Handler for the MouseEvent.DOUBLE_CLICK event.
ControlRegistration
  
getVisible():Boolean
Determines whether or not the control should be visible.
ControlRegistration
 Inherited
mouseDown(event:MouseEvent):void
Handler for the MouseEvent.ROLL_OUT event for the control object.
ControlInteractive
 Inherited
mouseUp(event:MouseEvent):void
Handler for the MouseEvent.MOUSE_UP event for the control object.
ControlInteractive
 Inherited
move():void
Moves the transform using the current mouse position (applied to postTransform).
ControlInteractive
 Inherited
Moves the registration point using the current mouse position.
ControlInteractive
 Inherited
removedFromStage(event:Event):void
[override] Handler for the Event.REMOVED_FROM_STAGE event.
ControlInteractive
 Inherited
restrict(event:Event):void
Handler for the TransformTool.RESTRICT event.
ControlInteractive
 Inherited
rollOut(event:MouseEvent):void
Handler for the MouseEvent.ROLL_OUT event for the control object.
ControlInteractive
 Inherited
rollOver(event:MouseEvent):void
Handler for the MouseEvent.ROLL_OVER event for the control object.
ControlInteractive
 Inherited
rotate():void
Rotates a transform using the current mouse position (applied to postTransform).
ControlInteractive
 Inherited
scale():void
Scales the transform along both the x and y axes using the current mouse position (applied to preTransform).
ControlInteractive
 Inherited
scaleXAxis():void
Scales the transform along the axis using the current mouse position (applied to preTransform).
ControlInteractive
 Inherited
scaleYAxis():void
Scales the transform along the y axis using the current mouse position (applied to preTransform).
ControlInteractive
 Inherited
Intializes variables and listeners for tracking the mouse location.
ControlInteractive
 Inherited
Setup steps when defining a new cursor value.
ControlInteractive
 Inherited
setupTool():void
[override] Setup steps when defining a new tool value.
ControlInteractive
 Inherited
skewXAxis():void
Skews the transform along the x axis using the current mouse position (applied to preTransform).
ControlInteractive
 Inherited
skewYAxis():void
Skews the transform along the y axis using the current mouse position (applied to preTransform).
ControlInteractive
 Inherited
targetChanged(event:Event):void
[override] Handler for the TransformTool.TARGET_CHANGED event.
ControlInteractive
 Inherited
Scales the transform along both the x and y axes using the current mouse position in a uniform fashion (applied to preTransform).
ControlInteractive
 Inherited
Updates active references for mouse positions.
ControlInteractive
 Inherited
Updates base references for mouse positions.
ControlInteractive
 Inherited
Updates the values of the base references.
ControlInteractive
 Inherited
updateMousePositions(event:MouseEvent = null):void
Updates mouse position references from the provided mouse event.
ControlInteractive
Public Constants
 ConstantDefined By
 InheritedMIN_SCALE_BASE : Number = .1
The minimum distance to allow scaling.
ControlInteractive
Property Detail
editableproperty
editable:Boolean

Determines whether or not the registration point can be moved by the user. When true, the registration point can be moved. When false, it cannot. This only restricts repositioning via mouse interaction. The registration manager of a Transform Tool can still be used to modify the registration point used by a target object.


Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void
Constructor Detail
ControlRegistration()Constructor
public function ControlRegistration(cursor:Cursor = null)

Constructor for creating new ControlRegistration instances.

Parameters
cursor:Cursor (default = null) — The cursor to be used while interacting with the control instance.
Method Detail
activeMouseMove()method
override protected function activeMouseMove(event:MouseEvent):void

Handler for the MouseEvent.MOUSE_MOVE event from the activeTarget object. This is used to update the active mouse positions.

Parameters

event:MouseEvent

doubleClick()method 
protected function doubleClick(event:MouseEvent):void

Handler for the MouseEvent.DOUBLE_CLICK event. When double-clicked, a registration point will reset itself to its default location as defined by the (0,0) location in a target object's coordinate space.

Parameters

event:MouseEvent

draw()method 
override public function draw():void

Draws the visuals of the control. This is called when first added to the stage as a child of a TransformTool instance and when a child is added to the control's own display list. It can be called at any time to redraw the graphics of the control.

getVisible()method 
protected function getVisible():Boolean

Determines whether or not the control should be visible. When the Transform Tool is very small, and controls start to overlap with one another, ControlRegistration instances will hide themselves so that other controls can still be used without the registration point getting in the way.

Returns
Boolean — True if the ControlRegistration instance should be visible; false if not.
redraw()method 
override public function redraw(event:Event):void

Handler for the TransformTool.REDRAW event. This has no default behavior and is to be overriden by subclasses if needed.

Parameters

event:Event