| Package | spark.effects |
| Class | public class Scale3D |
| Inheritance | Scale3D  AnimateTransform3D AnimateTransform Animate Effect EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Like all AnimateTransform-based effects, this effect only works on subclasses of UIComponent and GraphicElement, as these effects depend on specific transform functions in those classes. Also, transform effects running in parallel on the same target run as a single effect instance Therefore, the transform effects share the transform center set by any of the contributing effects.
MXML Syntax
Show MXML Syntax
Hide MXML SyntaxThe <s:Scale3D> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<s:Scale3D
Properties
id="ID"
scaleXBy="no default"
scaleXFrom="no default"
scaleXTo="no default"
scaleYBy="no default"
scaleYFrom="no default"
scaleYTo="no default"
scaleZBy="no default"
scaleZFrom="no default"
scaleZTo="no default"
/>
Default MXML PropertymotionPaths
More examples
Learn more
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | applyChangesPostLayout : Boolean [override]
Used by the subclasses of AnimateTransform to specify
whether the effect changes transform values used by the layout
manager, or whether it changes values used after layout is run. | AnimateTransform3D | |
| applyLocalProjection : Boolean
If true, the effect creates a perspective projection
using the other projection-related properties in the effect
and applies it to the target component's parent when it starts playing. | AnimateTransform3D | |
| autoCenterProjection : Boolean = true
Set to false to disable a 3D effect from automatically setting
the projection point to the center of the target. | AnimateTransform3D | |
| autoCenterTransform : Boolean = false
Specifies whether the transform effect occurs
around the center of the target, (width/2, height/2)
when the effect begins playing. | AnimateTransform | |
| className : String [read-only]
The name of the effect class, such as "Fade". | Effect | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| customFilter : mx.effects:EffectTargetFilter
Specifies a custom filter object, of type EffectTargetFilter,
used by the effect to determine the targets
on which to play the effect. | Effect | |
| disableLayout : Boolean
If true, the effect disables layout on its
targets' parent containers, setting the containers autoLayout
property to false, and also disables any layout constraints on the
target objects. | Animate | |
| duration : Number
Duration of the effect in milliseconds. | Effect | |
| easer : IEaser
The easing behavior for this effect. | Animate | |
| effectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control
of a data effect. | Effect | |
| fieldOfView : Number
Specifies an angle, in degrees between 0 and 180,
for the field of view in three dimensions. | AnimateTransform3D | |
| filter : String
Specifies an algorithm for filtering targets for an effect. | Effect | |
| focalLength : Number
The distance between the eye or the viewpoint's origin (0,0,0)
and the display object located in the z axis. | AnimateTransform3D | |
| hideFocusRing : Boolean
Determines whether the effect should hide the focus ring
when starting the effect. | Effect | |
| instanceClass : Class
An object of type Class that specifies the effect
instance class class for this effect class. | Effect | |
| interpolator : IInterpolator
The interpolator used by this effect to calculate values between
the start and end values of a property. | Animate | |
| isPlaying : Boolean [read-only]
A read-only flag which is true if any instances of the effect
are currently playing, and false if none are. | Effect | |
| perElementOffset : Number
Additional delay, in milliseconds, for effect targets
after the first target of the effect. | Effect | |
| playheadTime : Number
Current time position of the effect. | Effect | |
| projectionX : Number = 0
Sets the projection point
as the offset of the projection point in the x direction
from the (0, 0) coordinate of the target. | AnimateTransform3D | |
| projectionY : Number = 0
Sets the projection point
as the offset of the projection point in the y direction
from the (0, 0) coordinate of the target. | AnimateTransform3D | |
| relevantProperties : Array
An Array of property names to use when performing filtering. | Effect | |
| relevantStyles : Array
An Array of style names to use when performing filtering. | Effect | |
| removeLocalProjectionWhenComplete : Boolean = false
If true, the effect removes the perspective projection
from the target component's parent when it completes playing. | AnimateTransform3D | |
| scaleXBy : Number
The factor by which to scale the object in the x direction. | Scale3D | ||
| scaleXFrom : Number
The starting scale factor in the x direction. | Scale3D | ||
| scaleXTo : Number
The ending scale factor in the x direction. | Scale3D | ||
| scaleYBy : Number
The factor by which to scale the object in the y direction. | Scale3D | ||
| scaleYFrom : Number
The starting scale factor in the y direction. | Scale3D | ||
| scaleYTo : Number
The ending scale factor in the y direction. | Scale3D | ||
| scaleZBy : Number
The factor by which to scale the object in the z direction. | Scale3D | ||
| scaleZFrom : Number
The starting scale factor in the z direction. | Scale3D | ||
| scaleZTo : Number
The ending scale factor in the z direction. | Scale3D | ||
| startDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect. | Effect | |
| target : Object
The object to which this effect is applied. | Effect | |
| targets : Array
An Array of objects that are targets for the effect. | Effect | |
| transformX : Number
Sets the x coordinate for the transform center, unless overridden
by the autoCenterTransform property. | AnimateTransform | |
| transformY : Number
Sets the y coordinate for the transform center, unless overridden
by the autoCenterTransform property. | AnimateTransform | |
| transformZ : Number
Sets the z coordinate for the transform center, unless overridden
by the autoCenterTransform property. | AnimateTransform | |
| triggerEvent : Event
The Event object passed to this Effect
by the EffectManager when an effect is triggered,
or null if the effect is not being
played by the EffectManager. | Effect | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | Scale3D | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | |
|
Captures the current values of the relevant properties
of an additional set of targets
Flex uses this function when a data change
effect is run.
| Effect | |
|
Captures the current values of the relevant properties
on the effect's targets. | Effect | |
|
Creates a single effect instance and initializes it. | Effect | |
|
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | |
|
Removes event listeners from an instance
and removes it from the list of instances. | Effect | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | |
|
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Pauses the effect until you call the resume() method. | Effect | |
|
Begins playing the effect. | Effect | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | |
|
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Stops the effect, leaving the effect targets in their current state. | Effect | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Property Detail
scaleXBy | property |
public var scaleXBy:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The factor by which to scale the object in the x direction. This is an optional parameter that can be used instead of one of the other from/to values to specify the delta to add to the from value or to derive the from value by subtracting from the to value.
scaleXFrom | property |
public var scaleXFrom:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The starting scale factor in the x direction. A scale value of 0.0 is invalid.
scaleXTo | property |
public var scaleXTo:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The ending scale factor in the x direction. A scale value of 0.0 is invalid.
scaleYBy | property |
public var scaleYBy:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The factor by which to scale the object in the y direction. This is an optional parameter that can be used instead of one of the other from/to values to specify the delta to add to the from value or to derive the from value by subtracting from the to value.
scaleYFrom | property |
public var scaleYFrom:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The starting scale factor in the y direction. A scale value of 0.0 is invalid.
scaleYTo | property |
public var scaleYTo:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The ending scale factor in the y direction. A scale value of 0.0 is invalid.
scaleZBy | property |
public var scaleZBy:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The factor by which to scale the object in the z direction. This is an optional parameter that can be used instead of one of the other from/to values to specify the delta to add to the from value or to derive the from value by subtracting from the to value.
scaleZFrom | property |
public var scaleZFrom:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The starting scale factor in the z direction. A scale value of 0.0 is invalid.
scaleZTo | property |
public var scaleZTo:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The ending scale factor in the z direction. A scale value of 0.0 is invalid.
Constructor Detail
Scale3D | () | Constructor |
Examples How to use this example
Scale3DEffectExample.mxml
<?xml version="1.0"?>
<!-- Simple example to demonstrate the s:Scale3D class. -->
<s:Application
xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:mx="library://ns.adobe.com/flex/mx"
xmlns:s="library://ns.adobe.com/flex/spark">
<fx:Declarations>
<s:Scale3D id="atScale3D" target="{targetBox}" scaleXBy="-.25" repeatCount="2"
repeatBehavior="reverse" effectStart="playButton.enabled=false"
effectEnd="playButton.enabled=true;"/>
</fx:Declarations>
<s:Panel title="Scale3D Effect Example"
width="75%" height="75%" >
<mx:HBox width="100%" height="100%">
<!-- Our target to affect-->
<mx:VBox id="targetBox" width="50%" horizontalAlign="center" paddingTop="5">
<mx:Image id="targetImg" source="@Embed(source='assets/Nokia_6630.png')"/>
</mx:VBox>
<mx:VBox id="detailsBox" width="50%" left="0">
<mx:Text width="99%" color="blue"
text="The Scale3D effect changes the scale of a target using the following parameters: scaleXFrom, scaleXTo, scaleXBy, scaleYFrom, scaleYTo, scaleYBy, scaleZFrom, scaleZTo, scaleZBy. Click 'Scale3D' to watch the effect."/>
</mx:VBox>
</mx:HBox>
<s:Rect left="0" right="0" bottom="0" height="30">
<s:fill>
<s:LinearGradient rotation="90">
<s:GradientEntry color="0xE2E2E2" />
<s:GradientEntry color="0xD9D9D9" />
</s:LinearGradient>
</s:fill>
</s:Rect>
<s:Button id="playButton"
left="5" bottom="5"
label="Scale3D" click="atScale3D.play();"/>
</s:Panel>
</s:Application>
Mon Apr 10 2017, 12:28 PM -07:00