FreeJ scripting

Class Layer

Object
   |
   +--Layer
Direct Known Subclasses:
MovieLayer, FlashLayer, ImageLayer, CamLayer, TextLayer, GeometryLayer, ParticleLayer

class Layer


This class should never be used directly, it is the parent class for all Layer implementations and provides basic layer methods that are inherited by all other layers.
Defined in Layer.js


Constructor Summary
Layer()
            This class is pure virtual and this constructor is never used
 
Method Summary
 void activate()
           Make the layer active and visible
 void add_filter(<string> filter_name)
           Add a frei0r effect filter to the layer it will append the filter to the chain applied to the layer the filter is specified by its name
 void deactivate()
           Deactivate the layer: stop reading and feeding
 void down()
           Lower the layer down one position in the chain of layers so that it goes in the back under the others
 String get_blit()
           Get the BLIT mode for the layer
 int get_blit_value()
           Get the BLIT value for the current blit
 String get_filename()
           Get the full path to the file which is currently opened in the layer
 int get_height()
           Get the current height of the layer
 String get_name()
           Get the name of the layer
 int get_width()
           Get the current width of the layer
 int get_x_position()
           Get the current X position of the layer
 int get_y_position()
           Get the current Y position of the layer
 Array list_filters()
           List all the effects chain applied on the layer
 void move()
           Move the layer at the specified position in the chain of layers it will place the layer at the specified depth between others
 void rem_filter(<string> filter_name)
           Remove a filter from the layer it will remove the named filter from the chain of the layer the filter is specified by its name
 void rotate(<int> degrees)
           Rotate the layer at the selected degrees, counterclockwise
 void set_blit(<string> blit_name)
           Select the BLIT mode for the layer
 void set_blit_value()
           Set the BLIT value for the current blit this command will fade the value between 0 and 256 it is useful for certain blits, for instance with ALPHA to set opacity
 void set_position(<int> x, <int> y)
           Set the position of the layer it switches the position to the desired x,y values chartesian axis with 0,0 at upper left corner
 void slide_position(<int> x, <int> y)
           Slide the position of the layer it smoothly drags the layer until the new position is reached the path algorithm is simple linear for now
 void spin(<float> spin_factor)
           Spin the layer into a rotation it will keep rotating the layer at the spin factor
 void up()
           Raise the layer up one position in the chain of layers so that it comes in the front on top of others
 void zoom(<float> x,<float> y)
           Zoom the layer by an x and y factor aspect ratio doesn't needs to be kept: the layer can be stretched zoom(val) = zoom(val,val).

Constructor Detail

Layer

Layer()

Method Detail

activate

void activate()

add_filter

void add_filter(<string> filter_name)

deactivate

void deactivate()

down

void down()

get_blit

String get_blit()

get_blit_value

int get_blit_value()

get_filename

String get_filename()

get_height

int get_height()

get_name

String get_name()

get_width

int get_width()

get_x_position

int get_x_position()

get_y_position

int get_y_position()

list_filters

Array list_filters()

move

void move()

rem_filter

void rem_filter(<string> filter_name)

rotate

void rotate(<int> degrees)

set_blit

void set_blit(<string> blit_name)

set_blit_value

void set_blit_value()

set_position

void set_position(<int> x, <int> y)

slide_position

void slide_position(<int> x, <int> y)

spin

void spin(<float> spin_factor)

up

void up()

zoom

void zoom(<float> x,<float> y)

FreeJ scripting

| FreeJ scripting documentation is Copyleft (C) 2000 - 2007 dyne.org foundation. Verbatim copying and distribution of this entire page is permitted in any medium, provided this notice is preserved.
Send inquiries & questions to dyne.org's hackers.
Documentation generated by JSDoc on Thu May 29 20:56:52 2008