When true, the targets will raise to the top of their display lists, though not above the Transform Tool, when assigned as targets of the tool.

The "committed" matrix transformation of a target object. This is the matrix on which other transformations are based. This is set when the target is set and when is committed with methods like commitTarget(). When preTransform and postTransform are applied, they're applied to the baseMatrix value to resolve the calculatedMatrix.

A reference point (metric) indicating the location of the local bottom left corner of the target object in the TransformTool coordinate space.

A reference point (metric) indicating the location of the local bottom right corner of the target object in the TransformTool coordinate space.

The current transformation matrix of the Transform Tool. This is updated when the target is defined and when calculateTransform is called. Controls will automatically call calculateTransform when used, updating the calculatedMatrix during transformations.

A representation of the TransformTool's display list in array form. Control sets are assigned to this property.

The cursor to be displayed by the Transform Tool. Cursors are generally defined in and set by controls. Using the ControlCursor control, the cursor can be seen in the TransformTool instance itself. Otherwise, cursors will have to be manually displayed by listening for the CURSOR_CHANGED event.

The event that invoked a change in the cursor.

When true, the native mouse cursor will be hidden with Mouse.hide() when the cursor is non-null.

Indicates that a transform control has assumed control of the tool for interaction. Other controls would check this value to see if it is able to interact with the tool without interference from other controls.

When true, the target is visually transformed with the tool between target commits as the user changes the transform with interactive controls. If false, target objects are only updated when the target is committed which (typically) occurs only after interaction with a control has completed.

The current location of the registration point in the context of the target object's coordinate space. This value will always be a Point instance. When there is no target, the value will be (0, 0). The registration manager uses this value to store registration points for objects.

The maximum height along the transformed y axis that a target object is allowed to have. If both a maxHeight and maxScaleY are specified, the value resulting in the smallest value will be used.

The maximum rotation allowed for a transformed target object. Ranges between minRotation and maxRotation depend on which value of the two is greater.

The maximum scale along the transformed x axis that a target object is allowed to have. If both a maxWidth and maxScaleX are specified, the value resulting in the smallest value will be used.

The maximum scale along the transformed y axis that a target object is allowed to have. If both a maxHeight and maxScaleY are specified, the value resulting in the smallest value will be used.

The maximum width along the transformed x axis that a target object is allowed to have. If both a maxWidth and maxScaleX are specified, the value resulting in the smallest value will be used.

The minimum height along the transformed y axis that a target object is allowed to have. If both a minHeight and minScaleY are specified, the value resulting in the highest value will be used.

The minimum rotation allowed for a transformed target object. Ranges between minRotation and maxRotation depend on which value of the two is greater.

The minimum scale along the transformed x axis that a target object is allowed to have. If both a minWidth and minScaleX are specified, the value resulting in the highest value will be used.

The minimum scale along the transformed y axis that a target object is allowed to have. If both a minHeight and minScaleY are specified, the value resulting in the highest value will be used.

The minimum width along the transformed x axis that a target object is allowed to have. If both a minWidth and minScaleX are specified, the value resulting in the highest value will be used.

Determines whether or not transforming is allowed to result in negative scales. When true, negative scaling is allowed and a transformed target object can be mirrored along its x and/or y axes. When false, negative scaling is not allowed and scale for both axes will always be positive.

A reference point (metric) indicating the location of the registration point within the TransformTool coordinate space.

The registration manager used to keep track of registration points in target objects. When using multiple instances of TransformTool, you may want to have each instance use the same registration manager so that each Transform Tool uses the same registration points for objects.

Target display object to be transformed by the TransformTool.

A saved reference to the event that selected the target when TransformTool.select was used. This allows controls to use that event to perform appropriate actions during selection, such as starting a drag (move) operation on the target.

A reference point (metric) indicating the location of the local top left corner of the target object in the TransformTool coordinate space.

A reference point (metric) indicating the location of the local top right corner of the target object in the TransformTool coordinate space.

Determines the method by which tool transformations are applied to the target display object.

Constructor for new TransformTool instances.

Adds registration offset to transformation matrix. This assumes deriveFinalTransform has already been called.

Applies the transform defined by calculatedMatrix to the target object. How this is applied depends on the value of transformMethod.

Calculates the value of calculatedMatrix by applying the values of preTransform and postTransform to the baseMatrix. The value of calculatedMatrix is used when transforms are being applied to the tool and its target object.

Parameters

Cleanup steps when defining a new cursor value. You may need to override this method to control the order of operations when adding content to the set cursor setter. This is called before a new cursor value is set.

Cleanup steps when defining a new target value. You may need to override this method to control the order of operations when adding content to the set target setter. This is called before a new target value is set.

Applies the calculatedMatrix transform to the target object and commits the target to the transformation. This will reset all transformation modifiers (preTransform and postTransform) and set the baseMatrix to the updated transform of the target.

Helper selection handler for deselecting target objects. Set this handler as the listener for an event that would cause the deselection of a target object.

Parameters

Fits the Transform Tool to match the current state of the target. Use this when the target object is transformed outside of the Transform Tool.

Returns the height of the target object based on its size within its transformed y axis and the current value of calculatedMatrix. This is different from the normal height reported by DisplayObject which is based on the height of the object within its parent's coordinate space. If no target exists 0 is returned.

Returns the rotation of target object based on the current value of calculatedMatrix. A matrix's general rotation is based on the rotation of its x axis.

Returns the rotation of a matrix on its x axis.

Parameters

Returns the rotation of a matrix on its y axis.

Parameters

Returns the scale of a matrix along its x axis.

Parameters

Returns the scale of a matrix along its y axis.

Parameters

Returns the width of the target object based on its size within its transformed x axis and the current value of calculatedMatrix. This is different from the normal width reported by DisplayObject which is based on the width of the object within its parent's coordinate space. If no target exists 0 is returned.

Determines if a matrix is scaled positively or not.

Parameters

Compares two matrices to see if they're equal.

Parameters

For zero-scale transformations, this function will reset the base scale to represent a positive value represented by the amount value. This would be needed if transformations expect a non-zero scale, for example if scaling the existing scale which, if zero, would not scale at all.

Parameters

Moves the Transform Tool and the target object to the tops of their respective parent display lists. This is automatically called when a target is set and autoRaise is true.

Resets the registration point to its default location relative to the (0,0) position in the target object's local coordinate space.

Resets the transformation of the target object to it's unmodified state.

Resets the values of preTransform, postTransform, and optionally baseMatrix to their defaults. The pre and post transforms are set to their identity matrices. The baseMatrix is set to the transform matrix of the target object.

Parameters

Goes under the assumption that scaling is handled by the preTransform and rotation is handled by the postTransform matrices.

Parameters

Applies restrictions to rotation.

Applies restrictions to scaling.

Parameters

Retrieves the current registration point from the registration manager assigning it to localRegistration.

Saves the current registration point value in localRegistration to the registration manager.

Helper selection handler for selecting target objects. Set this handler as the listener for a MouseEvent.MOUSE_DOWN event of an object or a container of objects to have targets automatically set to the Transform Tool when clicked. This event handler uses either Event.target or Event.currentTarget as TransformTool.target depending on which is in the same display object container as the Transform Tool itself.

Parameters

Sets the cursor for the transform tool with a respective cursor event that identifies the event that caused the change in the cursor.

Parameters

Sets the height of calculatedMatrix based on the size of the current target. If target is null or the value passed is not a number, calculatedMatrix is unchanged.

Parameters

Sets the rotation of a matrix. The rotation set is based on the x axis.

Parameters

Sets the scale of a matrix along its x axis.

Parameters

Sets the scale of a matrix along its y axis.

Parameters

Parameters

Setup steps when defining a new cursor value. You may need to override this method to control the order of operations when adding content to the set cursor setter. This is called after a new cursor value is set.

Sets the width of calculatedMatrix based on the size of the current target. If target is null or the value passed is not a number, calculatedMatrix is unchanged.

Parameters

Performs a full update of the Transform Tool. This includes: updating the metrics, updating the target (with optional commit) and updating the controls.

Parameters

Dispatches an update event (REDRAW) allowing controls within the tool to update themselves to match the current calculatedMatrix transform.

Updates references used to identify points of interest in the Transform Tool. These include points like the registration point, topLeft, bottomRight, etc. Metrics should be updated when the calculatedMatrix is updated and controls need to be redrawn as many controls use these properties to position themselves.

Applies the calculatedMatrix transform to the target object. Updates are only applied here if livePreview is true. For non-livePreview updates, commitTarget is required.

Event constant for commit event types.

Event constant for cursorChanged event types.

Event constant for redraw event types.

Event constant for restrict event types.

Event constant for targetChanged event types.

Event constant for targetTransformed event types.

Event constant for transformChanged event types.

Transform method for transforming a target object by updating DisplayObject.transform.matrix.

Transform method for transforming a target object by updating properties such as DisplayObject.width, DisplayObject.height and DisplayObject.rotation.