Move3D

Package	spark.effects
Class	public class Move3D
Inheritance	Move3D AnimateTransform3D AnimateTransform Animate Effect EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The Move3D class moves a target object in the x, y, and z dimensions. The x, y, and z property specifications of the Move3D effect specify the change in x, y, and z that should occur to the transform center around which the overall transform effect occurs.

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 expanded

Hide MXML Syntax

The <s:Move3D> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <s:Move3D
    Properties
    id="ID"
    xBy="no default"
    xFrom="no default"
    xTo="no default"
    yBy="no default"
    yFrom="no default"
    yTo="no default"
    zBy="no default"
    zFrom="no default"
    zTo="no default"
  />

Default MXML PropertymotionPaths

View the examples

More examples

Applying 3D effects
Setting the transform center of a 3D effect
Component layout and 3D effects

Learn more

About effects
About Spark effects
Spark 3D effects
Handling Spark effect events
About transitions

Related API Elements

spark.effects.Move

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
		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
		xBy : Number Number of pixels by which to modify the x position of the target.	Move3D
		xFrom : Number Initial x position of the target, in pixels.	Move3D
		xTo : Number Final x, in pixels.	Move3D
		yBy : Number Number of pixels by which to modify the y position of the target.	Move3D
		yFrom : Number Initial y position of the target, in pixels.	Move3D
		yTo : Number Final y position of the target, in pixels.	Move3D
		zBy : Number Number of pixels by which to modify the z position of the target.	Move3D
		zFrom : Number Initial z position of the target.	Move3D
		zTo : Number Final z position of the target.	Move3D

Protected Properties

	Property		Defined By
		applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.	Effect
		endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.	Effect

Public Methods

	Method		Defined By
		Move3D(target:Object = null) Constructor.	Move3D
		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
		captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values.	Effect
		captureMoreStartValues(targets:Array):void 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
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it.	Effect
		createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target.	Effect
		deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances.	Effect
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.	Effect
		getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property changed by this effect.	Effect
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		pause():void Pauses the effect until you call the resume() method.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect.	Effect
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		resume():void Resumes the effect after it has been paused by a call to the pause() method.	Effect
		reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

	Method		Defined By
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect

Events

Click for more information on events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
effectEnd	Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method.	Effect
effectRepeat	Dispatched when the effect begins a new repetition, for any effect that is repeated more than once.	Animate
effectStart	Dispatched when the effect starts playing.	Effect
effectStop	Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.	Effect
effectUpdate	Dispatched every time the effect updates the target.	Animate

Property Detail

xBy

property

public var xBy:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Number of pixels by which to modify the x position of the target. Values may be negative.

xFrom

property

public var xFrom:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Initial x position of the target, in pixels. If omitted, Flex uses either the value in the starting view state, if the effect is playing in a transition, or the current value of the target.

xTo

property

public var xTo:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Final x, in pixels. If omitted, Flex uses either the value in the starting state, if the effect is playing in a state transition, or the current value of the target.

yBy

property

public var yBy:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Number of pixels by which to modify the y position of the target. Values can be negative.

yFrom

property

public var yFrom:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Initial y position of the target, in pixels. If omitted, Flex uses either the value in the start view state, if the effect is playing in a transition, or the current value of the target.

yTo

property

public var yTo:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Final y position of the target, in pixels. If omitted, Flex uses either the value in the end view state, if the effect is playing in a transition, or the current value of the target.

zBy

property

public var zBy:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Number of pixels by which to modify the z position of the target. Values may be negative.

zFrom

property

public var zFrom:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Initial z position of the target. If omitted, Flex uses either the value in the starting view state, if the effect is playing in a transition, or the current value of the target.

zTo

property

public var zTo:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Final z position of the target. If omitted, Flex uses either the value in the starting state, if the effect is playing in a state transition, or the current value of the target.

Constructor Detail

Move3D

()

Constructor

public function Move3D(target:Object = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor.

Parameters

target:Object (default = null) — The Object to animate with this effect.

Examples How to use this example

Move3DEffectExample.mxml

<?xml version="1.0"?>
<!-- Simple example to demonstrate the s:Move3D 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:Move3D id="moveEffect" target="{targetBox}" xBy="100" zBy="100"
            repeatCount="2" repeatBehavior="reverse" 
            effectStart="playButton.enabled=false" effectEnd="playButton.enabled=true;"/>
    </fx:Declarations>

    <s:Panel title="Move3D Effect Example"
        width="75%" height="75%" >

        <mx:HBox width="100%" height="100%">
            <!-- Our target to affect-->
            <mx:VBox id="targetBox" width="50%"  horizontalAlign="center">
                <mx:Label text="Nokia 9930" />
                <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 Move3D effect changes the location of a target using the following parameters: xFrom, xTo, xBy, yFrom, xTo, yBy. Click 'Move3D' 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="Move3D" click="moveEffect.play();"/>
    </s:Panel>
</s:Application>

Legal Notices | Online Privacy Policy

Move3D - AS3 Flex

Classes x

xBy

xFrom

xTo

yBy

yFrom

yTo

zBy

zFrom

zTo

Move3D