Class sandy.view.ClipScreen

Implemented Interfaces

IScreen

Description

Screen

Method Index

new ClipScreen()
dispose(), getCamera(), getClip(), getColor(), getRatio(), getSize(), render(), setCamera(), setColor(), setSize()

Constructor Detail

ClipScreen

public function ClipScreen(w:Number, h:Number, bgColor:Number)

Create a new ClipScreen.

Method Detail

getColor

public function getColor(Void):Number

Returns the background color

Return

Number The color value

Specified By

getColor() in sandy.view.IScreen

setColor

public function setColor(n:Number):Void

Set the color of the background

Parameters

nThe color number

Specified By

setColor() in sandy.view.IScreen

setCamera

public function setCamera(c:Camera3D):Void

Set the Camera3D for the screen.

Parameters

cThe Camera3D.

Specified By

setCamera() in sandy.view.IScreen

getCamera

public function getCamera(Void):Camera3D

Get the screen corresponding Camera3D.

Return

c The Camera3D.

setSize

public function setSize(r:Rectangle):Void

Resize the screen. It makes the screen bigger or smaller, and the center of the rendered animation is modified too.

Parameters

rThe new dimension of the viewport. Remember that you certainly have to change the camera projection too.

Specified By

setSize() in sandy.view.IScreen

getSize

public function getSize(Void):Rectangle

Returns the rectangle representing the screen dimensions.

Return

A Rectangle.

Specified By

getSize() in sandy.view.IScreen

getRatio

public function getRatio(Void):Number

Returns the ratio between the wide and height of the screen as a number

Parameters

Void

Return

The dimension ratio between width and height (width/height)

Specified By

getRatio() in sandy.view.IScreen

getClip

public function getClip(Void):MovieClip

Return the container clip. This is very usefull if you want to apply a filter to the whole scene! The filter will be applied on the parent MovieClip, rathen than the skins who apply the filters to the faces only.

Return

The clip container.

Specified By

getClip() in sandy.view.IScreen

render

public function render(a:Array):Void

render the array of Face passed in arguments.

Parameters

aThe array of Face.

Specified By

render() in sandy.view.IScreen

dispose

public function dispose(Void):Void

Dispose the ClipScreen.

Specified By

dispose() in sandy.view.IScreen