Overview
A shaped wipe in which one node is gradually revealed from/to the center of the WipePanel over another. Effectively the wipe is an expanding/contracting shaped viewport, not unlike RevealWipe.
Script Variable Summary
| access | name | type | Can Read | Can Init | Can Write | Default Value | description |
|---|---|---|---|---|---|---|---|
| public | IN | Integer |  |
Wipe from the edge of the display, inwards. |
|||
| public | OUT | Integer | |
Wipe from the center of the display, outwards. |
Variable Summary
| access | name | type | Can Read | Can Init | Can Write | Default Value | description |
|---|---|---|---|---|---|---|---|
| public | direction | Integer | | | |
Direction of the wipe (default: IN). |
|
| public | shape | Node | | | |
The shape to use for the reveal area. |
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