com.senocular.display.transform.ControlRegistration

	Property	Defined By
		cursor : 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
		fillAlpha : Number The alpha of the color used for filled shapes in dynamically drawn control graphics.	Control
		fillColor : uint The color to be used for filled shapes in dynamically drawn control graphics.	Control
		lineAlpha : Number The alpha of the color used for outlines in dynamically drawn control graphics.	Control
		lineColor : uint The color to be used for outlines in dynamically drawn control graphics.	Control
		lineThickness : Number The thickness used for outlines in dynamically drawn control graphics.	Control
		tool : TransformTool A reference to the TransformTool instance the control was placed, defined in the ADDED_TO_STAGE event.	Control

Protected Properties

	Property		Defined By
		activeLocalX : Number Mouse location in x axis within the target object coordinate space while the control is being dragged.	ControlInteractive
		activeLocalY : Number Mouse location in y axis within the target object coordinate space while the control is being dragged.	ControlInteractive
		activeMouseEvent : MouseEvent The most recent mouse event received by the activeTarget dispatcher when consuming mouse events.	ControlInteractive
		activeTarget : IEventDispatcher The object from which mouse events are consumed.	ControlInteractive
		activeX : Number Mouse location in x axis within the Transform Tool coordinate space while the control is being dragged.	ControlInteractive
		activeY : Number Mouse location in y axis within the Transform Tool coordinate space while the control is being dragged.	ControlInteractive
		baseLocalMatrixInverted : Matrix Inverted base matrix used to convert locations in the Transform Tool coordinate space into locations within the target object coordinate space.	ControlInteractive
		baseLocalRegistration : Point Registration point location within the target object coordinate space when the control is first clicked.	ControlInteractive
		baseLocalX : Number Mouse location in x axis within the target object coordinate space after offsets are applied when the control is first clicked.	ControlInteractive
		baseLocalY : Number Mouse location in y axis within the target object coordinate space when the control is first clicked.	ControlInteractive
		baseRegistration : Point Registration point location within the Transform Tool coordinate space when the control is first clicked.	ControlInteractive
		baseX : Number Mouse location in x axis within the Transform Tool coordinate space when the control is first clicked.	ControlInteractive
		baseY : Number Mouse location in y axis within the Transform Tool coordinate space when the control is first clicked.	ControlInteractive
		localMouse : Point Mouse location within the target object coordinate space when the control is first clicked.	ControlInteractive
		mouse : Point Mouse location within the Transform Tool coordinate space when the control is first clicked.	ControlInteractive
		offsetMouse : Point Offset for the mouse position.	ControlInteractive

	Method	Defined By
		ControlRegistration(cursor:Cursor = null) 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

Show Inherited Protected Methods

	Method		Defined By
		activeMouseMove(event:MouseEvent):void [override] Handler for the MouseEvent.MOUSE_MOVE event from the activeTarget object.	ControlRegistration
		activeMouseUp(event:MouseEvent):void Handler for the MouseEvent.MOUSE_UP event (capture and no capture) from the activeTarget object.	ControlInteractive
		added(event:Event):void Handler for the Event.ADDED event (capture).	Control
		addedToStage(event:Event):void Handler for the Event.ADDED_TO_STAGE event.	Control
		calculateAndUpdate(commit:Boolean = true, enforceNegativeScaling:Boolean = true):void Calls calculateTransform and update from the parent TransformTool instance.	ControlInteractive
		cleanupActiveMouse():void Clears variables and listeners for tracking the mouse location.	ControlInteractive
		cleanupCursor():void Cleanup steps when defining a new cursor value.	ControlInteractive
		cleanupTool():void 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
		mouseDown(event:MouseEvent):void Handler for the MouseEvent.ROLL_OUT event for the control object.	ControlInteractive
		mouseUp(event:MouseEvent):void Handler for the MouseEvent.MOUSE_UP event for the control object.	ControlInteractive
		move():void Moves the transform using the current mouse position (applied to postTransform).	ControlInteractive
		moveRegistration():void Moves the registration point using the current mouse position.	ControlInteractive
		removedFromStage(event:Event):void [override] Handler for the Event.REMOVED_FROM_STAGE event.	ControlInteractive
		restrict(event:Event):void Handler for the TransformTool.RESTRICT event.	ControlInteractive
		rollOut(event:MouseEvent):void Handler for the MouseEvent.ROLL_OUT event for the control object.	ControlInteractive
		rollOver(event:MouseEvent):void Handler for the MouseEvent.ROLL_OVER event for the control object.	ControlInteractive
		rotate():void Rotates a transform using the current mouse position (applied to postTransform).	ControlInteractive
		scale():void Scales the transform along both the x and y axes using the current mouse position (applied to preTransform).	ControlInteractive
		scaleXAxis():void Scales the transform along the axis using the current mouse position (applied to preTransform).	ControlInteractive
		scaleYAxis():void Scales the transform along the y axis using the current mouse position (applied to preTransform).	ControlInteractive
		setupActiveMouse():void Intializes variables and listeners for tracking the mouse location.	ControlInteractive
		setupCursor():void Setup steps when defining a new cursor value.	ControlInteractive
		setupTool():void [override] Setup steps when defining a new tool value.	ControlInteractive
		skewXAxis():void Skews the transform along the x axis using the current mouse position (applied to preTransform).	ControlInteractive
		skewYAxis():void Skews the transform along the y axis using the current mouse position (applied to preTransform).	ControlInteractive
		targetChanged(event:Event):void [override] Handler for the TransformTool.TARGET_CHANGED event.	ControlInteractive
		uniformScale():void Scales the transform along both the x and y axes using the current mouse position in a uniform fashion (applied to preTransform).	ControlInteractive
		updateActiveMouse():void Updates active references for mouse positions.	ControlInteractive
		updateBaseMouse():void Updates base references for mouse positions.	ControlInteractive
		updateBaseReferences():void Updates the values of the base references.	ControlInteractive
		updateMousePositions(event:MouseEvent = null):void Updates mouse position references from the provided mouse event.	ControlInteractive

	Constant	Defined By
		MIN_SCALE_BASE : Number = .1 The minimum distance to allow scaling.	ControlInteractive

Property Detail

editable

property

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

Wed Dec 1 2010, 10:13 AM -08:00

Transform Tool API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
ControlRegistration	Properties \| Methods \| Constants

Package	com.senocular.display.transform
Class	public class ControlRegistration
Inheritance	ControlRegistration ControlInteractive Control flash.display.Sprite