DashLine Documentation
Author: Alex Uhlmann
Last Modified: 09/24/05 19:03:43
Summary
DashLine class:
DashLine Properties:
DashLine Methods:
version: Documentation not provided.
description:
DashLine is a class for drawing dashed (and dotted) lines. If you specify a movieclip as first parameter, the shape will be drawn inside this movieclip. If you omit the mc parameter, the class will create a new movieclip in _root.apContainer_mc.
Example 1: draw a line with default parameters.
Example 2: do the same, just animate it.var myLine:DashLine = new DashLine(); myLine.draw();
Example 3: draw a line with custom parameters. A dotted line.var myLine:DashLine = new DashLine(); myLine.animate(0,100);
Example 4: (Example .swf) draw an animated line with custom parameters, that continues to animated to full size and back.var myLine:DashLine = new DashLine(0,0,275,200,1,8); myLine.lineStyle(1,0xff0000,100); myLine.draw();
var myLine:DashLine = new DashLine(0,0,275,200,4,20);
myLine.lineStyle(10,0xff0000,50);
myLine.animationStyle(2000,Sine.easeOut,"onCallback");
myLine.animate(0,100);
myListener.onCallback = function(source, value)
{
if(value == 100) {
source.animate(100, 0);
} else {
source.animate(0, 100);
}
}
usage:
var myLine:DashLine = new DashLine();
var myLine:DashLine = new DashLine(x1, y1, x2, y2, len, gap);
var myLine:DashLine = new DashLine(mc, x1, y1, x2, y2, len, gap);
parameters:
(Number)(static) default property. length of dash. Defaults to 8.
(Number)(static) default property. length of gap between dashes. Defaults to 8.
(MovieClip)(read only) Movieclip that contains the drawing.
(Number) Outline thickness.
(Number) Outline color of the drawing as hex number.
(Number) Outline transparency (alpha).
(Number) Duration of animation in milliseconds or frames. Default is milliseconds.
(Object) Easing equation in Robert Penner style. Default equation is Linear.easeNone. www.robertpenner.com/easing/
(String) Function to invoke after animation. See APCore class.
description: Draws the dashed line.
usage:
myLine.draw();
returns: Void.
description: Draws the line without clearing the movieclip.
usage:
myLine.drawBy();
returns: Void.
description: Draws an animated dashed line.
usage:
myLine.animate(start, end);
parameters:
returns: MovieClip that contains the drawing.
description: Draws an animated line without clearing the movieclip.
usage:
myLine.animateBy(start, end);
parameters:
returns: Void.
description: jumps to a specific step of the animation and stays there.
usage:
instance.goto(percentage);
parameters:
returns: void
description: define outline.
usage:
myLine.lineStyle();
myLine.lineStyle(lineThickness, lineRGB, lineAlpha);
parameters:
returns: Void.
description: set the animation style properties for your animation. Notice that if your easing equation supports additional parameters you can send those parameters with the easing parameter in animationStyle. You have to send an Array as easing parameter. The first element has to be the easing equation in Robert Penner style. The following parameters can be your additional parameters. i.e.:
See also "Customizable easing equations" in readme for more information.var myRotation:Rotation = new Rotation(mc); myRotation.animationStyle(2000,[Back.easeOut,4]); myRotation.run(360);
usage:
myLine.animationStyle(duration);
myLine.animationStyle(duration, callback);
myLine.animationStyle(duration, easing, callback);
parameters:
returns: Void.
description: Sets the registration point of the shape. Defaults to center. Top left is 0,0. The parameter object accepts either a position property with the value of "CENTER" or x and y properties of with coordinates as values of the registration point.
Example 1: Set the registration point of an ellipse to the upper left corner (0,0) instead of center.
var myEllipse:Ellipse = new Ellipse(275,200,100,50);
myEllipse.setRegistrationPoint( {x:0,y:0} );
myEllipse.draw();
internally AnimationPackage centers all shapes with
myInstance.setRegistrationPoint( {position:"CENTER"} );
usage:
myInstance.setRegistrationPoint(registrationObj);
parameters:
returns: Void.
description: returns a specific point of the outline.
usage: myInstance.getX1();
returns: Number
description: sets a specific point of the outline.
usage: myInstance.setX1();
parameters:
returns: Void.
description: returns a specific point of the outline.
usage: myInstance.getY1();
returns: Number
description: sets a specific point of the outline.
usage: myInstance.setY1();
parameters:
returns: Void.
description: returns a specific point of the outline.
usage: myInstance.getX2();
returns: Number
description: sets a specific point of the outline.
usage: myInstance.setX2();
parameters:
returns: Void.
description: returns a specific point of the outline.
usage: myInstance.getY2();
returns: Number
description: sets a specific point of the outline.
usage: myInstance.setY2();
parameters:
returns: Void.
description: removes all drawings. Identical to myInstance.movieclip.clear();
usage:
myInstance.clear();
returns: Void.
description: rounds animation results to integers. (might be usefull for animating pixelfonts). Default is false.
usage:
myInstance.roundResult(rounded);
parameters:
true rounds the result. Animates with integers. Less accuracy. false animates with floating point numbers.returns: Void.
description: Flash does not guaranteed that time-based tweening will reach the end value(s) of your animation. By default AnimationPackage guarantees that the end value(s) will be reached. The forceEnd method allows you to disable this guarantee and only accept the values from your easing equation. In certain situations this can lead to a smoother ending of the animation. Notice that in frame-based tweening the end value(s) will always be reached.
usage:
myInstance.forceEnd(forceEndVal);
parameters:
true or false.returns: Void.
description: returns the optimization mode. See setOptimizationMode for more information.
usage: getOptimizationMode();
returns: Boolean
description:
Allows to explicitly remove parts of the animation that don't change during
the animation.
This can add additional performance to your animation. Note that
setting this method to true has side effects. If all start and end values match,
the animation won't start and will immediatly invoke an onEnd event.
The order of values returned by getStartValue(s), getCurrentValue(s),
getEndValue(s) and the value property of the eventObject returned
by EventDispatcher might change if you set this method to true. You can
still retrieve the parts of the animation that are actually animated
if you access the Animator instance of your animation class via
myAnimator. Ask myInstance.myAnimator.setter to retrieve
all currently animated parts of the animation. See Animator
documentation. Of cource, if you know your input values you would
probably look at them.
Note that the AnimationCore class offers a static setOptimizationModes method (note the last "s" at the end) that allows you to remove parts of 'all' your animations that don't change during the animation.
usage:
myInstance.setOptimizationMode(optimize);
parameters:
returns: Void.
description: returns the current tween mode used by the instance. Please check with AnimationCore.setTweenModes for more information.
usage: getTweenMode();
returns: String that specifies the tween mode. Either AnimationCore.INTERVAL or AnimationCore.FRAMES.
description: sets the current tween mode used by the instance. Please check with AnimationCore.setTweenModes for more information.
usage: setTweenMode();
parameters:
returns: true if setting tween mode was successful,
false if not successful.
description: returns the current duration mode used by the instance. Please check with AnimationCore.setTweenModes for more information.
usage: getDurationMode();
returns: String that specifies the duration mode. Either AnimationCore.MS or AnimationCore.FRAMES.
description: sets the current duration mode used by the instance. Please check with AnimationCore.setTweenModes for more information.
usage: setDurationMode();
parameters:
returns: true if setting duration mode was successful,
false if not successful.
description: stops the animation if not locked..
usage: myInstance.stop();
returns: true if instance was successfully stopped.
false if instance could not be stopped, because it was locked.
description: pauses the animation if not locked. Call resume() to continue animation.
usage: myInstance.pause();
parameters:
returns: true if instance was successfully paused.
false if instance could not be paused, because it was locked.
description: continues the animation if not locked.
usage: myInstance.resume();
returns: true if instance was successfully resumed.
false if instance could not be resumed, because it was locked.
description: locks the animation to prevent pausing, resuming and stopping. Default is unlocked.
usage: myInstance.lock();
returns: Void.
description: unlocks the animation to allow pausing, resuming and stopping. Default is unlocked.
usage: myInstance.unlock();
returns: Void.
description: checks if the instance is currently animated.
usage: myInstance.isTweening();
returns: true if instance is tweening,
false if instance is not tweening.
description: returns the original, starting value of the current tween. Percentage.
usage: myInstance.getStartValue();
returns: Number
description: returns the targeted value of the current tween. Percentage.
usage: myInstance.getEndValue();
returns: Number
description: returns the current value of the current tween. Percentage.
usage: myInstance.getCurrentValue();
returns: Number
description: returns the current state of the animation in percentage. Especially usefull in combination with goto().
usage: myInstance.getCurrentPercentage();
returns: Number
description: returns the elapsed time or frames since the current tween started tweening.
usage: myInstance.getDurationElapsed();
returns: Number
description: returns the remaining time or frames since the current tween started tweening.
usage: myInstance.getDurationRemaining();
returns: Number
description: Subscribe to a predefined event. The following standard EventDispatcher events are broadcasted
onStart, broadcasted when animation starts.
onUpdate, broadcasted when animation updates.
onEnd, broadcasted when animation ends.
The even object returned, contains the following properties:
type (String) event broadcasted.
target (Object) event source.
value (Number) value to animate.
usage:
myLine.addEventListener(event, listener);
myLine.addEventListener(event, listener, handler);
parameters:
returns: Void.
description: Removes a listener from a subscribed event.
usage:
myLine.removeEventListener(event, listener);
myLine.removeEventListener(event, listener, handler);
parameters:
returns: Void.
description: GDispatcher specific feature. Removes all listeners for a specific event, or for all events.
usage:
myLine.removeAllEventListeners();
myLine.removeAllEventListeners(event);
parameters:
returns: Void.
description: GDispatcher specific feature. Checks if a listener is already subscribed to a certain event.
usage:
myLine.eventListenerExists(event, listener);
myLine.eventListenerExists(event, listener, handler);
parameters:
returns: true if event exists on listener.
false if event doesn't exist on listener.
description: returns a unique ID of the instance. Usefull for associative arrays.
usage: myInstance.getID();
returns: Number
description: returns the name of the class.
usage: myInstance.toString();
returns: String