You are here: Home

Scaena - Documentation

3. Timeline script

Wednesday, 12 September 2007

Timeline

The timeline script contains mutiple sections of data:

All of them are required to feed the available functions of Scaena.

Sections

`resources`

List of URLs from titled images/slides which can have separate duration and a link to a named frame or effect.

Attributes

Name	Type	Required	Description	Examples
path	String	true	Base path of the images	pics/ ../pics/ http://www.mydomain.com/pics/

`image`

Image resource item for a ScaenaSlide object.

Attributes

Name	Type	Required	Description	Examples
title	String	false	Title of the slide	Welcome
frame	String	false	Associated frame	intro
effect	String	false	Associated effect	cube
time	Number	false	Display time in milliseconds (overrides the global duration time and the time of the associated frame or effect)	3000 (=3 sec.)
url	String	true	Path of the external image (only JPGs are currently supported)	welcome.jpg

Example

`setup`

All meta data for Scaena to setup the slideshow.

Attributes

(Not available)

`scene`

Setup information for the 3D scene.

Attributes

Name	Type	Required	Description	Examples
width	Number	true	Width of the 3D scene	2500
height	Number	true	Height of the 3D scene	2000

`container`

Position of the container which hosts Scaena.

Attributes

Name	Type	Required	Description	Examples
x	Number	true	X position of the container	[scene.@width]/10
y	Number	true	Y position of the container	[scene.@height]/10

`camera`

Position of the container which hosts Scaena.

Attributes

Name	Type	Required	Description	Examples
x	Number	false	X position of the camera	0
y	Number	false	Y position of the camera	0
z	Number	false	Z position of the camera	-4900
zoom	Number	false	Zoom factor of the camera's perspective	10
sort	Boolean	false	Use z-sorting of 3D objects while rendering	false

`bitmap`

Defines the dimensions of the images/slides.

Attributes

Name	Type	Required	Description	Examples
width	Number	true	Width of the images/slides	500
height	Number	true	Height of the images/slides	400

`movie`

Sets slideshow specific parameters.

Attributes

Name	Type	Required	Description	Examples
autoplay	Boolean	false	Automatically play slideshow after loading all resources	true
loop	Boolean	false	Play slideshow from beginning after last image/slide	true

`image`

Defines image/slide parameters. Some of them could be overwritten locally.

Attributes

Name	Type	Required	Description	Examples
time	Number	true	Display time of each image/slide in milliseconds	5000 (=5 sec.)
sizing	String	false	Images/slides sizing type	(empty) stretch fit crop
smoothing	Boolean	true	Allow anti-aliasing when stretching images/slides	true
color	Hex	false	Images/slides fill color when sizing has no exact ratio	0x000000 (black) 0x0000FF (blue)

`wireframe`

Sets the parameters for the debug grid which is diplayed when no images where loaded.

Attributes

Name	Type	Required	Description	Examples
horizontal	Number	true	Amount of horizontal segments for a fullsized plane	8
vertical	Number	true	Amount of vertical segments for a fullsized plane	6
color	Hex	true	Wireframe grid color	0xFF0000 (red) 0xFFFFFF (white)
alpha	Number	true	Alpha value of the grid	1 (100%) 0.5 (50%)

`reflection`

Defines the parameters for the optional reflection of images/slides.

Attributes

Name	Type	Required	Description	Examples
height	Number	true	Height of the reflection	[scene.@height]/2
rectangle	Rectangle	true	Rectangle which is reflected from the images/slides	0,0,[scene.@width],[scene.@height] (left, top, right, bottom)
offset	Number	true	Offset of the reflection in percent	0.75 (75%)
alpha	Array	true	Alpha value of the reflectio from top to bottom	60,0 (top =60%, bottom =0%)

`keyframes`

List of named frames which can have separate duration and are linked with an effect and it's parameters.

Attributes

(Not available)

`frame`

Keyframe with unique name which defines an effect with it's parameters.

Name	Type	Required	Description	Examples
name	String	true	Name of the frame	introduction
effect	String	true	Name of the associated effect	cube
time	Number	true	Display time of the associated image/slide in milliseconds	4000 (=4 sec.)

Custom effect parameters

Each effect of the effects script can have several custom parameters which can be set via child nodes at the listed keyframe. Below you can see our list of used parameters in each effect.

Name	Type	Required	Description	Examples
`duration`	Number	true	Animation time of the effect	introduction
`easing`	String	true	Name of the associated easing transition	linear easeInOutQuad easeOutBounce

< Prev		Next >

[ Back ]

Related Items

Support us

Through our partner cafepress.com we sell several clothes and more with our brand so called U8 web wear. With each purchase you get a unique product and support our work. Thanks!