Overview
A split screen wipe in which one node is gradually revealed in place over another. Effectively the wipe is an expanding rectangular viewport, that can start from either an edge of the screen or a corner.
Script Variable Summary
| access | name | type | Can Read | Can Init | Can Write | Default Value | description |
|---|---|---|---|---|---|---|---|
| public | BOTTOM_LEFT | Integer |  |
Wipe from the bottom left corner, outwards. |
|||
| public | BOTTOM_RIGHT | Integer | |
Wipe from the bottom right corner, outwards. |
|||
| public | BOTTOM_TO_TOP | Integer | |
Wipe from bottom to top (horizontal blinds). |
|||
| public | CUSTOM | Integer | |
Not supported, yet. |
|||
| public | LEFT_TO_RIGHT | Integer | |
Wipe from left to right (vertical blinds). |
|||
| public | RIGHT_TO_LEFT | Integer | |
Wipe from right to left (vertical blinds). |
|||
| public | TOP_LEFT | Integer | |
Wipe from the top left corner, outwards. |
|||
| public | TOP_RIGHT | Integer | |
Wipe from the top right corner, outwards. |
|||
| public | TOP_TO_BOTTOM | Integer | |
Wipe from top to bottom (horizontal blinds). |
Variable Summary
| access | name | type | Can Read | Can Init | Can Write | Default Value | description |
|---|---|---|---|---|---|---|---|
| public | direction | Integer | | | |
Direction of the wipe (default: LEFT_TO_RIGHT). |
Inherited Variables
com.jfxia.wipe.Wipe
| access | name | type | Can Read | Can Init | Can Write | Default Value | description |
|---|---|---|---|---|---|---|---|
| public | time | Duration | | | |
Duration of the wipe effect. |
Inherited Functions
com.jfxia.wipe.Wipe
- public abstract postWipe(wp: WipePanel, frm: Node, to: Node) : Void
-
Called after the wipe ends.
Called after the wipe ends. Any clean up should be done here, and the 'to' node should be hooked into the WipePanel as its only child. Important: this function is called even if the wipe was abandoned mid-way through, so do not assume the 'to' node is in its final state.
-
Parameters
- wp
- The containing panel
- frm
- The node showing at the start of the wipe
- to
- The node showing at the end of the wipe
- public abstract preWipe(wp: WipePanel, frm: Node, to: Node) : Void
-
Called before the wipe begins.
Called before the wipe begins. If the wipe needs to perform any prep before running, or clean up from a previous run, this is where it should be done.
-
Parameters
- wp
- The containing panel
- frm
- The node showing at the start of the wipe
- to
- The node showing at the end of the wipe
- public abstract wipe(wp: WipePanel, frm: Node, to: Node) : javafx.animation.Timeline
-
Creates a timeline object that performs the wipe.
Creates a timeline object that performs the wipe.
-
Parameters
- wp
- The containing panel
- frm
- The node showing at the start of the wipe
- to
- The node showing at the end of the wipe
-
Returns
- Timeline