Reference for PhotoBuster CS

Method

Description

captureToClient() Capture the target to a bitmap and send to client script which specify in the serverToClient. The bitmap will send to the script in format of string which is base64 encoded. The variable is named "fileContent". In addition, it will send a variable with name "fileType" which specify the type of the bitmap and it will send a variable with name "fileName" which defined in PhotoBuster.imageFilename.
captureToServer() Capture the target to a bitmap and send to client script which specify in the serverToServer. The bitmap will send to the script in format of string which is base64 encoded. The variable is named "fileContent". In addition, it will send a variable with name "fileType" which specify the type of the bitmap and it will send a variable with name "fileName" which defined in PhotoBuster.imageFilename.
startMove() Start the object moving mode.
stopMove() Stop the object moving mode.
startCrop() Start the croping mode.
stopCrop() Stop the croping mode.
startDraw() Start the drawing mode.
stopDraw()() Stop the drawing mode.
startDrawText() Adding text to the target.
stopDrawText() Stop the adding text mode.
clear() Clear all object on the canvas.

 

PhotoBuster.gotoItem()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.captureToClient()

Returns None

Description Method; Capture the target to a bitmap and send to client script which specify in the serverToClient.

Code Example :

photobuster_mc.scriptToClient = "saveToFile.php";   
photobuster_mc.imageType = "jpg";
photobuster_mc.captureToClient();

 

PhotoBuster.captureToServer()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.captureToServer()

Returns None

Description Method; Capture the target to a bitmap and send to client script which specify in the serverToServer.

Code Example :

photobuster_mc.scriptToServer = "sendToEmail.php";   
photobuster_mc.imageType = "jpg";
photobuster_mc.scriptParameter = "[email protected]";
photobuster_mc.captureToServer();

 

PhotoBuster.startMove()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.startMove()

Returns None

Description Method; Start the object moving mode.

Code Example :

photobuster_mc.startMove();

 

PhotoBuster.stopMove()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.stopMove()

Returns None

Description Method; Add an item into the menu with specified index.

Code Example :

photobuster_mc.stopMove();

 

PhotoBuster.startCrop()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.startCrop()

Returns None

Description Method; Start the croping mode.

Code Example :

photobuster_mc.startCrop();

 

PhotoBuster.stopCrop()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.stopCrop()

Returns None

Description Method; Stop the croping mode.

Code Example :

  photobuster_mc.stopCrop();

 

PhotoBuster.startDraw()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.startDraw()

Returns None

Description Method; Start the drawing mode.

Code Example :

photobuster_mc.startDraw();

 

PhotoBuster.stopDraw()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.stopDraw()

Returns None

Description Method; Stop the drawing mode.

Code Example :

photobuster_mc.stopDraw();

 

PhotoBuster.startDrawText()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.startDrawText()

Returns None

Description Method; Adding text to the target.

Code Example :

photobuster_mc.startDrawText();

 

PhotoBuster.stopDrawText()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.stopDrawText()

Returns None

Description Method; Stop the adding text mode.

Code Example :

photobuster_mc.stopDrawText();

 

PhotoBuster.clear()

Availability Flash Player 9.

Edition Flash CS3.

Usage PhotoBuster.clear()

Returns None

Description Method; Clear all object on the canvas.

Code Example :

  photobuster_mc.clear();

Event

Description

complete

Broadcast when complete loading the external server script.


Code Example :

function eventHandle(event:Event):void {
switch(event.type) {
//Complete Event
case Event.COMPLETE:
//do something when complete loading the script
var loader:URLLoader = URLLoader(event.target);
trace("completeHandler: " + loader.data);
break;
} }
photobuster_mc.addEventListener(Event.COMPLETE,eventHandle);

Property

Type

Description

Default Value

Possible Value

target String The target for capturing. Must be instance name of movieclip. Any instance name of movieclip.
trigger Object Specify the button for trigger the action for save,move,crop,draw and text.

Object with format:
{save:"",move:"", crop:"",draw:"",text:""}

scriptToClient String The script speicfy for output the captured bitmap to client side. Relative path or absolute path to the script. e.g. saveToFile.php
scriptToServer String The script speicfy for output the captured bitmap to server side. Relative path or absolute path to the script. e.g. sendToEmail.php
scriptParameter String Addition parameter send to the script specify in scriptToClient or scriptToServer. The format should be look like var1=value,var2=value2... Any string format with:
var1=value, var2=value2...
sendToServer Boolean Enable/disable to use scriptToServer script.
true
true/false
toolbarVisible Boolean Enable/disable the visibility of internal toolbar.
true
true/false
toolbarShadow Boolean Enable/disable the shadow effect of internal toolbar.
true
true/false
toolbarDragDrop Boolean Enable/disable the ability for dragging of internal toolbar.
true
true/false
penColor uint Default color of the drawing tool.
0x000000
_blank, _self, _parent, or other name
penWidth Number Default pen width of the drawing tool.
2
top / middle / bottom
waterMark String The class name specify for use as a watermark. When filled in with a class name, the ouput bitmap will apply with the watermark. Any string
waterMarkPosition String Set the water mark position.
Top Left
Top Left,Top Right, Bottom Left, Bottom Right,Center
imageFilename String The default image filename send to the script.
imagename
Any string
imageType String The type of the image output to the script.
true
jpg/png
jpgQuality Number The quality of the output image ( for jpg only).
80
1-100
 
Item Parameter Name Description
1 target The target for capturing. Must be instance name of movieclip.
2 toolbarDragDrop Enable/disable the ability for dragging of internal toolbar.
3 toolbarShadow Enable/disable the shadow effect of internal toolbar.
4 toolbarVisible Enable/disable the visibility of internal toolbar.
5 penColor Default color of the drawing tool.
6 penWidth Default pen width of the drawing tool.
7 waterMark The class name specify for use as a watermark. When filled in with a class name, the ouput bitmap will apply with the watermark.
8 waterMarkPosition Set the water mark position.
     
 
Item Parameter Name Description
1 scriptToClient The script speicfy for output the captured bitmap to client side.
2 sendToServer Enable/disable to use scriptToServer script.
3 scriptToServer The script speicfy for output the captured bitmap to server side.
4 scriptParameter Addition parameter send to the script specify in scriptToClient or scriptToServer. The format should be look like var1=value,var2=value2...
     
 
Item Parameter Name Description
1 imageType The type of the image output to the script.
2 jpgQuality The quality of the output image ( for jpg only).
3 imageFilename The default image filename send to the script.
     
 
Item Parameter Name Description
1 trigger Specify the button for trigger the action for save,move,crop,draw and text.
2
3
4
5