PIMP (Panning Interactive Menu Pro) documentation version 1.0
 
UPDATE

The help documentation will be updated and improved with customer feedback.

* Before starting, check to see if you should download the latest Readme.htm file from the server and replace this one (version on right top)
* Check the latest FAQ, tips and help topics on the FORUM

> TOP <

 
Quick Start

When you receive the product you will receive a .zip file. The zip file will contain the following files

  • /images/
    folder containing normal and thumbnail images.
  • contents.xml
  • fullscreen.htm
  • pimp_as3.fla
  • pimp_as3.swf
  • /classes/panningmenu.as
  • Readme.htm
  • style.css
  • swobject.js

Do the following steps to start using PIMP;

  1. Unzip the .zip file.
  2. Open Flash CS3 (or higher).
  3. Open pimp_as3.fla.
  4. Frame 4 will contain the "manual" menu and frame 6 the "automatic" menu. Delete the one you won't use and the extra manual/automatic buttons in the right bottom
  5. Create (duplicate from existing) aditional menu items if needed and copy-paste-adjust instance names (and select export for actionscript)
  6. Adjust the required component parameters to your needs, check them below.
  7. Open and adjust the MC "extra menu" from the Library to your needs.

Extra steps you probably will want to do with next;

  1. Choose either thumbnail yes/no use for the portfolio Carousel. Open MC "carousel" in Library folder [carousel clips] and in actions layer you can change the usethumbs = true parameter.
    You can also see a lot of customizable parameters. All safely customizable variables are preceded by comment line
    // ^^^ customizable ^^^
  2. Adjust the Carousel items to your own, editable by XML file contents.xml
  3. Choose either "drag accelerated" or not for the scolling contents. You can change the component parameter to do that. This way you can have contents scroll instantly directly according to drag bar or accelarate/decelarate to new positions giving a smoother visual.
    By default "Home" and "About us" have accelated scroll, but "Staff Members" (and "News" an xml driven) uses not-accelated scroll, so you can see the difference.
  4. Adjust the NEWS items to your own, editable by XML file contents.xml


> TOP <

 
Component Parameters.
 

Some of the MENU components are more essential then others, the important ones you'll certainly want to check out are in bold.

automatic * If true -> Don't use the MovieClip "container manual", generate items automatically.
totalitems   Number of menu items used in the structure
startitem   Which item will be active/zoomed-in by default (can depend on 'order')
itemsperrow * ( If 'automatic' set to true ) Number of items generated per row
order * ( If 'automatic' set to true ) Order of items generated automatically
itemtexts   Texts which will appear in the item "connection hooks"
durzoom   Duration in frames of zooming in on an item
zoomscaledown   The amount of zoom-out which will be performed when clicking the background.
durmove   Duration in frames of moving from one item to another.
durdragback   Duration in frames of snapping back if you drag an item out of its drag boundaries (after zooming out to view all)
hookups   The "connection hooks" for the menu, for each line use from "nr item" - "nr hook" comma to "nr item" - "nr hook"
distanceX * ( If 'automatic' set to true ) Horizontal distance between automatically generated items
distanceY * ( If 'automatic' set to true ) Vertical distance between automatically generated items
curving   Number of curving anchor distance for lines. I.o.w higher value will give larger curves
curvefr   Extra larger movement factor for the metall ball going from one item to another, based roughly on line curve.
dragarea   The boundary drag area-square for items to be allowed to drag (after zooming out to view all)
topmenuX   The horizontal distance from the center of the quick side menu
topmenuY   The vertical distance from the center of the quick side menu

The scroll component parameter.

content target   The instance name of the MC being scrolled
mask target   The instance name of the MC being used as mask
mask height   The height of the mask area
drag scroll height   The distance of the scroll down button (and accordingly the clickable scroll drag area)
drag button height The height of the drag scroll bar
scroll duration drag   Duration of the scroll bar completing drag to final position
scroll speed up-down   Speed of scrolling movement up/down
instant scroll   Make scrolling move instantly instead of accelerated/decellerated
round off   Round off position on whole pixel (for pixelfont use)
no buttons scroll   Make the scrolling based on mouse instead of using scroll buttons/bar

> TOP <
Tips


Some tips to keep in mind when working with PIMP;

  • Don't extend content outside the item borders. (Pay attention using masked contents)
  • Replicate the automated content scrollers
    By default the "Home", "About us" and "Staff Members" (and "News" an xml driven) contain simple automatic MC scrollers, which scroll an entire MovieClip. This way you can use larger contents within an item. You can copy-paste-substitute items to use one in any item you like.
  • The News and Portfolio are xml driven
    Keep it in mind when planning your own changes.
  • You can direct link from within items to other items
    See the links on the small pictures in scroll content of item 1 "Home"
  • Pay attention with "export for actionscript"
    To make sure only the absolute nessesary is included, not all libarary contents are set to automatically export for actionscript. In the main timeline you'll see layers "export inclusion" which make sure that only those contents needed are actually included on export. If you're not sure on how to proceed, you can always choose "export in first frame" in Linkage properties for an item to make sure it's always included in the published .swf (even if it's not used in by the template visual)

> TOP <

 
PIMP Disclaimer
© 2009 Patrick Jansen Design

PIMP Component is Intellectual Property of Patrick Jansen. You should carefully read the following terms and conditions before using PIMP Component. Your use of files indicates your acceptance of this license agreement and warranty

You are specifically prohibited from charging, or requesting donations, for PIMP Component and from distributing these files (commercial or otherwise) without prior written permission. Unauthorized usage or distribution is prohibited and is in violation of international copyright laws.

Reverse-engineering, decompiling and/or any form of modification or reproduction of PIMP Component is prohibited. You are allowed to use PIMP component in commercial works, provided the end-works are not competitive or harmful to Patrick Jansen products. Any other usage of the PIMP not described herein can only be performed with specific authorization by Patrick Jansen.

Disclaimer of Warranty

THE Patrick Jansen Products (including but not limited to "XML List Menu" and "PIMP" and "ASTRO" and "PJ" and "Supreme 4" and "Elite" and "Pixel Font" and "X-mas Mix" components) AND THE ACCOMPANYING FILES ARE PROVIDED "AS IS" AND WITHOUT WARRANTIES AS TO PERFORMANCE OR MERCHANTABILITY OR ANY OTHER WARRANTIES WHETHER EXPRESSED OR IMPLIED. BECAUSE OF THE VARIOUS HARDWARE AND SOFTWARE ENVIRONMENTS INTO WHICH PATRICK JANSEN PRODUCTS MAY BE PUT, NO WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE IS OFFERED.

Patrick Jansen Product
s copyright registrations are available at USA Library of Congress - Copyright Office.
> TOP <