Overview
Registering and Playing
Main Components
Points
Import swf, bitmap and media
Movie Clips
Animating
Frames and Levels
Basic Parameters

Overview

AdChiosk Flash is a collective group of effects that play from AdChiosk main to the screen transparently at a specific location, size and a predefine time period. As in AdChiosk main, it allows an entering and a leaving points from which it can dart in and out of the screen according to your needs. It can also play your swf file ( created from other tool ) with the above features by using the ride effect, therefore providing you the flexibility to create your own flashes with minimun effort.

• Authoring tool
  
  We are planning for the release of flash effect authoring tool in Jan 2008, in the meantime to have an idea of what are the various parameters and tags means check out the example and documentation in the individual xml file.
  

Registering and Playing

• Registering the effects
  
  All latest effects are registered in adchiosk.register, to edit or change the order, simply edit this file. To register a new effect, edit adchiosk.register using any text editor and add the executable name and associate xml input file to it but please ensure the executable names are unique.
  
  If you have copies of the same effect ( ie. more then one xml parameter files with different parameter values ), do not add more then 1 non unique effect into the register file, instead associate the effects in your primary signage xml input by hand or using the Scheduler.
  

• Assocating the effects by hand
  
  Open you signage ( created from designer or text editor ) xml input, here there are few ways to implement multiple effects of the same name.
  
  Duplicate Simple by indicating the name under the "Flasheffect" tag and added newname="new_effect_name". The reason to do so is that you cannot run the same effect in the same instance of time or when it overlaps each other.
  
  <Flasheffect name="fly" newname="fly1" />
  
  Different parameters file Obviously you may have very different movie clips for the same effect and setup a different paramter file for each of them, to reference:
  
  <Flasheffect name="fly" newname="fly1" input="fly1.xml" />
  
  Different parameter values As there may be hundreds of parameter values for each effect, you may allow to override the primary effect parameters on the fly without creating a xml file for each one of them. Some of these basic paramters are: x, y, width, height, timeout, cutoff-frames, speed, qty
  
  <Flasheffect name="fly" newname="fly1" x="0" y="200" timeout="10" />
  
  
  

• Referencing the effects by hand
  
  To play your flash effect, in the schedule block and under the "Slice" tag, add:
  
  <Flasheffect name="fly" after="1" />
  
  This will play your effect 1 second after your window is shown. The minimun time allow is 0.2 second. You may stack as many effects and as many loops but within each "slice" duration time.
  

• Assocating and referencing the effects using the Scheduler
  
  You can quickly, add or associate the effects with the Scheduler download and test drive now.
  
  
  

Main Components

All AdChiosk flash effects support a consistent sets of main parameters, taken from each inidividual effects parameter xml files. The main components consisit of a parameter tag where you specifiy the values for it's primary theme, followed by the various components below.

• Sets  <Set ..... > .................</Set>
  
  Some effects supports more then one instances, in this case enter the individual parameter values and all clips, points under this tag.
  

• Brushes  <Brush type="line" ..... > .................</Brush>
  
  Brushes allows you to draw lines, curves or brush clips onto your main rectangle area. You can stack as many brushes on top of each other. Line or curve type brush supports from ascending and descending line and fill alpha.
  
  
  type   "line"
  
  When brushing with line, it must be accompany by at least one set of points and the following types of "joint"
  With one set of points.
  • string - join 2 points end to end inwards
  • sweep - from origin ( first point ) to all others
  • blade - from origin to others like a blade
  • fan - from origin to others, no gaps in between
  
  
  With 2 sets of points.
  • string - join 2 corresponding points
  • blade - join 2 corresponding points like a blade
  • fan - join 2 corresponding points no gaps in between
  • zigzag - join 2 corresponding points zigzag
  
  
  type   "curve"
  
  When brushing with curve, it must be accompany by at least one set of points and the following types of "joint"
  With one set of points.
  • string - join 2 points end to end inwards
  • petal - from origin ( first point ) to all others
  • blade - from origin to others like a blade
  • fan - from origin to others, no gaps in between
  
  
  With 2 sets of points.
  • string - join 2 corresponding points
  • blade - join 2 corresponding points like a blade
  • fan - join 2 corresponding points no gaps in between
  
  
  Other variables, when a curve is being plotted, it needs 2 angles and 2 distances from originating position.
  • angle1 - first angle
  • angle2 - second angle
  • d1 - first distance
  • d2 - second distance
  
  type   "ascending","descending","hill","valley","random"
  
  When using these types, it brushes with clips, so at least one must be specified.
  • qty - number of rows/cols
  • xspace - number of pixel to shift in x direction
  • yspace - number of pixel to shift in y direction
  • direction - "left", "up"
  
  

• Guests  <Guest ..... > .................</Guest>
  
  Guests are clips that you can position anywhere in your rectangle area or apply an animation transistion or transformation to it. Each guest can supports multiple clips.
  

• Probes  <Probe ..... > .................</Probe>
  
  Probes can be use for water effects where it simulate a agitation for the ripples to be created. It can also play sound before the main event. Includes the basic clip, points withn the probe Tag. You can define multiple probes within the theme.
  

• Prelude  <Prelude ..... > .................</Prelude>
  
  For certain effects, you can sets a prelude to the primary theme. It lets you move clips or play sound before the main event. Includes the basic clip, points withn the prelude Tag.
  

Points

Points are fundamental part of AdChiosk Flash, almost everywhere you uses a set of points or path to dictate the movement of themes, clips or drawing of irregular shape objects or clips. All points are relative to it's parent rectangle.

• Straight  <Points type="straight" x1="0", y1="0", x2="400", y2="100", n="40" spread="gradient", origin="false", endpoint="true" />
  
  Specify 2 xy coordinates and the number of points between them with an optional spread, start point or endpoint.


• x1 - from x
• y1 - from y
• x2 - to x
• y2 - to x
• n - number of points
• spread - none or gradient ( ascending only )
• origin - including start point, true or false
• endpoint - including end point, true or false

• Rectangle  <Points type="rectangle" x="0" ..... />
  
  Specify points along a rectangle, allow you to specify a xy offset from parent rectangle.


• x - x offset from left
• y - y offset from top
• a - an angle between 2 points ( if n is specify this is ignore )
• a1 - starting point, an angle from top left
• a2 - ending angle
• w - width of rectangle
• h - height of rectangle
• n - number of points along the rectangle ( specify this overides a )
• direction - cw or ccw ( default - counter clockwise )

• Round  <Points type="round" x="0" ..... />
  
  Specify points along a round circle, allow you to specify a xy offset from parent rectangle.


• x - x offset from parent left to left of this rectangle
• y - y offset from parent top to top of this rectangle
• a1 - starting point, an angle from geometry 0
• a2 - ending angle
• r - radius of circle
• n - number of points along the rectangle ( specify this overides a )
• direction - cw or ccw ( default - counter clockwise )
• spread - none or gradient ( ascending only )

• Curve  <Points type="curve" x="0" ..... />
  
  Specify points along a cubic curve. A cubic curve has one start, one end and 2 control points in between.


• x1, y1 - starting xy position
• x2, y2 - first control point
• x3, y3 - second control point
• x4, y4 - ending xy position
• n - number of points
• spread - none or gradient ( ascending only )

• Curves  <Points type="curves" n="20" > <List x="10" y="100" /> ...... </Points>
  
  Curves has more then 2 control points, you can have as many xy points as you wish, however, you must specify the xy points inside a string of list tag.


• n - number of points
• x - x position
• y - y position

• Quandrant  <Points type="quadrant" x="20" ..... />
  
  Qradrant of zaggy points spread outwards from origin ( x, y), criscrossing quadrant within a circle. A circle is divided into 8 quadrants starting from geometry 0 to 45.


• x - x position ( origin )
• y - y position ( origin )
• sq - starting quadrant
• q - number of quadrants to spread out
• n - number of points
• distance - no of pixels of each zigzag
• reverse - true or false, reverse the flow from outer to origin
• random - true or false, randomise quadrant

• Rectangle Block  <Points type="rectangle-block" x="0" ..... />
  
  Specify randomise points within the rectangle area.


• x - x offset from left
• y - y offset from top
• w - width of rectangle
• h - height of rectangle
• n - number of points
• block-type - random ( no other value )

• Round Block  <Points type="round-block" x="0" ..... />
  
  Specify randomise points within the circle area.


• x - x offset from parent left to left of this rectangle
• y - y offset from parent top to top of this rectangle
• a1 - starting point, an angle from geometry 0
• a2 - ending angle
• r - radius of circle
• n - number of points
• block-type - random ( no other value )

• List  <Points ..... >....</Points>
  
  Specify as many list tag within the point tag that contains a pair of xy manual points.


• x - x coordinate
• y - y coordinate

Importing

You can import clips, embeded fonts in swf file, bitmap and media clips into AdChiosk flash with a reference name. When you created the movie clips into your swf file, you must have the export for actionscript click and assign a linkage name. For fonts, you need to have it embeded.

• Import  <Import url="asset\clips.swf" name="clips" ..... />
  


• url - name and loacation of swf file or bitmap name
• name - a imported reference name
• level - movie clip depth

• Media  <Media url="asset\jingle1.mp3" name="tune1" ..... />
  


• url - name and loacation of media file
• name - a imported reference name

Movie Clips

AdChiosk flash effect can import movieclips from swf file or by creating them from bitmap files or from shapes that your define. All these must be define within the enclosing "Clip" tag.

• Clips  <Clip x="0" ..... />
  
  Clip are the parent tag for the following assets, image, text and shape group of tags.
  
  
  • x - x position
  • y - y position
  • alpha - an alpha value
  • rotation - an angle
  • scale-width - a value in percentage
  • scale-height - a value in percentage
  • level - movie clip depth
  • type - seed or child or nothing ( default )
  
  

• Assets  <Asset import-name="clips" name="star1"..... />
  
  Assets are movie clips that you created into swf file and tuck in the library with a linkage name.
  
  
  • import-name - import reference name
  • name - the "linkage name" in the flash IDE library
  
  

• Image  <Image import-name="image1" width="100"..... />
  
  Image are bitmap file or various format that flash supports.
  
  
  • import-name - import reference name
  • width - width of bitmap
  • height - height of bitmap
  • color - apply this color to imported bitmap
  
  

• Text  <Text import-name="fonts" name="beauty"..... />
  
  Text can be embeded in swf file with the right font or just any text with the font installed on the target computer. If import-name is specified, it takes from imported font in the swf file.
  
  
  • import-name - import reference name
  • name - the "linkage name" in the flash IDE library, otherwise the actual font name
  • font-size - size to apply
  • font-style - "bold", "italic"
  • color - color to apply
  • content - the wording to display
  
  

• Shape  <Shape type="ellipse" radius1="100"..... />
  
  Shapes are define as is, our plan release of flash effect editing tool is in Jan 2008 will cater to this needs. The requirements of shapes for construction are base on flash, ie. it will have line, fill, gradient, alpha etc... Here are the various shapes.
  
  ellipse
  • radius1 - x radius
  • radius2 - y radius
  
  rectangle
  • width - width in pixel
  • height - height in pixel
  
  round-rectangle
  • width - width in pixel
  • height - height in pixel
  
  star
  • radius1 - inner radius
  • radius2 - outer radius
  • points - number of points
  • angle - starting angle from north clockwise
  
  polygon
  • radius1 - inner radius
  • radius2 - outer radius
  • points - number of points
  • angle - starting angle from north clockwise
  
  burst - flowery shape
  • radius1 - inner radius
  • radius2 - outer radius
  • points - number of points
  • angle - starting angle from north clockwise
  
  gear
  • radius1 - inner radius
  • radius2 - outer radius
  • holesides - number of hole sides
  • holeradius - number of hole radius
  • angle - starting angle from north clockwise
  
  super
  • points - number of points
  • n1 -
  • n2 -
  • n3 -
  • range -
  • detail - default 1000
  • scaling -
  
  The following define the line, fill, gradients needed for construction of shape which you need to wrap within the shape Tag.
  
  
  Line  <Line color="0x00ff00" alpha="100"..... />
  • color - a hex value
  • thickness - in pixel
  • alpha - a percentage value
  
  Fill  <Fill color="0x00ff00" alpha="100"..... />
  • color - a hex value
  • alpha - a percentage value
  
  Gradient  <Gradient type="linear" tx="0"..... />
  • type - "linear", "radial"
  • tx - transalation in x direction
  • ty - transalation in y direction
  • width - width of gradient box
  • height - height of gradient box
  • rotation - rotation of gradient
  
  
  • <Colors> - list of colors value
  • <Alphas> - list of alphas value
  • <Ratios> - list of ratio value
    
    For more information, visit Adobe flash website for explaination of gradient box
  
  
  
• Filter
  
  You can apply filter to the clip through the following filters Tag. Please refer to Adobe flash website for more information.
  
  Shadow  <Shadow quality="3" strength="2"..... />
  • alpha - a percentage value
  • strength - value
  • quality - value
  • distance - value
  • blurx - value
  • blury - value
  • angle - an angle
  • color - a hex value
  • knockout - true or false
  • inner - true or false
  
  Blur  <Blur blurx="10" blury="10"..... />
  • quality - value
  • blurx - value
  • blury - value
  
  Bevel  <Bevel beveltype="inner" strength="1"..... />
  • beveltype - "inner","outer"
  • strength - value
  • quality - value
  • distance - value
  • blurx - value
  • blury - value
  • angle - an angle
  • highlightcolor - a hex value
  • highlightalpha - a percentage value
  • shadowcolor - a hex value
  • shadowalpha - a percentage value
  • knockout - true or false
  
  Glow  <Glow blurx="10" blury="10"..... />
  • alpha - a percentage value
  • strength - value
  • quality - value
  • blurx - value
  • blury - value
  • color - a hex value
  • knockout - true or false
  • inner - true or false