Class Flip

Class representing the flipping process

Hierarchy

Flip

Index

Constructors

constructor

Methods

Constructors

constructor

new Flip(render: Render, app: PageFlip): Flip

- Defined in Flip/Flip.ts:53
Parameters
- render: Render
- app: PageFlip
Returns Flip

Methods

flip

flip(globalPos: Point): void

- Defined in Flip/Flip.ts:79
Page turning with animation

Parameters
- globalPos: Point
  
  Touch Point Coordinates (relative window)
Returns void

flipNext

flipNext(corner: FlipCorner): void

- Defined in Flip/Flip.ts:240
Turn to the next page (with animation)

Parameters
- corner: FlipCorner
  
  Active page corner when turning
Returns void

flipPrev

flipPrev(corner: FlipCorner): void

- Defined in Flip/Flip.ts:252
Turn to the prev page (with animation)

Parameters
- corner: FlipCorner
  
  Active page corner when turning
Returns void

flipToPage

flipToPage(page: number, corner: FlipCorner): void

- Defined in Flip/Flip.ts:217
Turn to the specified page number (with animation)

Parameters
- page: number
  
  New page number
- corner: FlipCorner
  
  Active page corner when turning
Returns void

fold

fold(globalPos: Point): void

- Defined in Flip/Flip.ts:65
Called when the page folding (User drags page corner)

Parameters
- globalPos: Point
  
  Touch Point Coordinates (relative window)
Returns void

getCalculation

getCalculation(): FlipCalculation

- Defined in Flip/Flip.ts:376
Get the current calculations object

Returns FlipCalculation

getState

getState(): FlippingState

- Defined in Flip/Flip.ts:383
Get current flipping state

Returns FlippingState

showCorner

showCorner(globalPos: Point): void

- Defined in Flip/Flip.ts:280
Fold the corners of the book when the mouse pointer is over them. Called when the mouse pointer is over the book without clicking

Parameters
- globalPos: Point
Returns void

start

start(globalPos: Point): boolean

- Defined in Flip/Flip.ts:116
Start the flipping process. Find direction and corner of flipping. Creating an object for calculation.

Parameters
- globalPos: Point
  
  Touch Point Coordinates (relative window)
Returns boolean

True if flipping is possible, false otherwise

stopMove

stopMove(): void

- Defined in Flip/Flip.ts:262
Called when the user has stopped flipping

Returns void

Generated using TypeDoc