|
FreeJ scripting | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--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()
Method Detail |
void activate()
void add_filter(<string> filter_name)
filter_name
- (in doublequotes)
void deactivate()
void down()
String get_blit()
int get_blit_value()
String get_filename()
int get_height()
String get_name()
int get_width()
int get_x_position()
int get_y_position()
Array list_filters()
void move()
void rem_filter(<string> filter_name)
filter_name
- (in doublequotes)
void rotate(<int> degrees)
degrees
- for the rotation
void set_blit(<string> blit_name)
blit_name
- (in doublequotes)
void set_blit_value()
blit_value
- a number from 0 to 256
void set_position(<int> x, <int> y)
x
- horizontal position, from left to right
y
- vertical position, from up to down
void slide_position(<int> x, <int> y)
x
- horizontal position, from left to right
y
- vertical position, from up to down
void spin(<float> spin_factor)
spin_factor
- value, advised boundary is -3 / +3
void up()
void zoom(<float> x,<float> y)
x
- horizontal zoom, value between 0.0 and 2.0 (1.0 = original size)
y
- vertical zoom, value between 0.0 and 2.0 (1.0 = original size)
|
FreeJ scripting | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |