1650 lines
60 KiB
HTML
1650 lines
60 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>iwmlib API Documentation</title>
|
|
|
|
<meta name="description" content="The IWM Browser: One Browser for all apps." />
|
|
|
|
|
|
|
|
<meta property="og:title" content="iwmlib API Documentation"/>
|
|
<meta property="og:type" content="website"/>
|
|
<meta property="og:image" content=""/>
|
|
|
|
<meta property="og:url" content="https://www.iwm-tuebingen.de"/>
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<script src="scripts/prettify/prettify.js"></script>
|
|
<script src="scripts/prettify/lang-css.js"></script>
|
|
<script src="scripts/jquery.min.js"></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link href="https://fonts.googleapis.com/css?family=Libre+Franklin:400,700" rel="stylesheet">
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/main.css">
|
|
|
|
|
|
<script>
|
|
var config = {"monospaceLinks":false,"cleverLinks":false,"applicationName":"iwmlib","disqus":"","googleAnalytics":"","openGraph":{"title":"iwmlib API Documentation","type":"website","image":"","site_name":"","url":"https://www.iwm-tuebingen.de"},"meta":{"title":"iwmlib API Documentation","description":"The IWM Browser: One Browser for all apps.","keyword":""},"linenums":true,"cleverlinks":true,"default":{"outputSourceFiles":true,"useLongnameInNav":false}};
|
|
</script>
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div id="wrap" class="clearfix">
|
|
|
|
<div class="navigation">
|
|
<h3 class="applicationName"><a href="index.html">iwmlib</a></h3>
|
|
<button id="menuToggle" class="btn btn-link btn-lg menu-toggle">
|
|
<span class="glyphicon glyphicon-menu-hamburger"></span>
|
|
</button>
|
|
<div class="search">
|
|
<input id="search" type="text" class="form-control input-md" placeholder="Search...">
|
|
</div>
|
|
<ul class="list">
|
|
|
|
<li class="item" data-name="global">
|
|
<span class="title namespace ">
|
|
|
|
<span class="namespaceTag">
|
|
<span class="glyphicon glyphicon-globe"></span>
|
|
</span>
|
|
|
|
<a href="global.html">Global</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
<span class="subtitle">Typedefs</span>
|
|
|
|
<li class="parent" data-name="actionActiveCallback"><a href="global.html#actionActiveCallback">actionActiveCallback</a></li>
|
|
|
|
<li class="parent" data-name="actionCallback"><a href="global.html#actionCallback">actionCallback</a></li>
|
|
|
|
<li class="parent" data-name="actionCallback"><a href="global.html#actionCallback">actionCallback</a></li>
|
|
|
|
<li class="parent" data-name="afterActionCallback"><a href="global.html#afterActionCallback">afterActionCallback</a></li>
|
|
|
|
<li class="parent" data-name="afterActionCallback"><a href="global.html#afterActionCallback">afterActionCallback</a></li>
|
|
|
|
<li class="parent" data-name="beforeActionCallback"><a href="global.html#beforeActionCallback">beforeActionCallback</a></li>
|
|
|
|
<li class="parent" data-name="beforeActionCallback"><a href="global.html#beforeActionCallback">beforeActionCallback</a></li>
|
|
|
|
<li class="parent" data-name="onCompleteCallback"><a href="global.html#onCompleteCallback">onCompleteCallback</a></li>
|
|
|
|
<li class="parent" data-name="onCompleteCallback"><a href="global.html#onCompleteCallback">onCompleteCallback</a></li>
|
|
|
|
<li class="parent" data-name="onStartCallback"><a href="global.html#onStartCallback">onStartCallback</a></li>
|
|
|
|
<li class="parent" data-name="onStartCallback"><a href="global.html#onStartCallback">onStartCallback</a></li>
|
|
|
|
<li class="parent" data-name="onUpdateCallback"><a href="global.html#onUpdateCallback">onUpdateCallback</a></li>
|
|
|
|
<li class="parent" data-name="onUpdateCallback"><a href="global.html#onUpdateCallback">onUpdateCallback</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="AbstractPopup">
|
|
<span class="title ">
|
|
|
|
<a href="AbstractPopup.html">AbstractPopup</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="AbstractPopup#content"><a href="AbstractPopup.html#content">content</a></li>
|
|
|
|
<li class="parent " data-name="AbstractPopup#header"><a href="AbstractPopup.html#header">header</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="AbstractPopup#hide"><a href="AbstractPopup.html#hide">hide</a></li>
|
|
|
|
<li class="parent " data-name="AbstractPopup#layout"><a href="AbstractPopup.html#layout">layout</a></li>
|
|
|
|
<li class="parent " data-name="AbstractPopup#show"><a href="AbstractPopup.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Badge">
|
|
<span class="title ">
|
|
|
|
<a href="Badge.html">Badge</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class=" " data-name="Badge#content"><a href="Badge.html#content">content</a></li>
|
|
|
|
<li class=" " data-name="Badge#header"><a href="Badge.html#header">header</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class=" " data-name="Badge#hide"><a href="Badge.html#hide">hide</a></li>
|
|
|
|
<li class=" " data-name="Badge#layout"><a href="Badge.html#layout">layout</a></li>
|
|
|
|
<li class=" " data-name="Badge#show"><a href="Badge.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="BlurFilter">
|
|
<span class="title ">
|
|
|
|
<a href="BlurFilter.html">BlurFilter</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="BlurFilter#blur"><a href="BlurFilter.html#blur">blur</a></li>
|
|
|
|
<li class="parent " data-name="BlurFilter#shape"><a href="BlurFilter.html#shape">shape</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Button">
|
|
<span class="title ">
|
|
|
|
<a href="Button.html">Button</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="Button#active"><a href="Button.html#active">active</a></li>
|
|
|
|
<li class="parent " data-name="Button#disabled"><a href="Button.html#disabled">disabled</a></li>
|
|
|
|
<li class="parent " data-name="Button#iconColor"><a href="Button.html#iconColor">iconColor</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Button#capture"><a href="Button.html#capture">capture</a></li>
|
|
|
|
<li class="parent " data-name="Button#hide"><a href="Button.html#hide">hide</a></li>
|
|
|
|
<li class="parent " data-name="Button#layout"><a href="Button.html#layout">layout</a></li>
|
|
|
|
<li class="parent " data-name="Button#show"><a href="Button.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="ButtonGroup">
|
|
<span class="title ">
|
|
|
|
<a href="ButtonGroup.html">ButtonGroup</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="ButtonGroup#disabled"><a href="ButtonGroup.html#disabled">disabled</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="ButtonGroup#hide"><a href="ButtonGroup.html#hide">hide</a></li>
|
|
|
|
<li class="parent " data-name="ButtonGroup#layout"><a href="ButtonGroup.html#layout">layout</a></li>
|
|
|
|
<li class="parent " data-name="ButtonGroup#show"><a href="ButtonGroup.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="DeepZoomImage">
|
|
<span class="title ">
|
|
|
|
<a href="DeepZoomImage.html">DeepZoomImage</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#baseSize"><a href="DeepZoomImage.html#baseSize">baseSize</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#foreground"><a href="DeepZoomImage.html#foreground">foreground</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#height"><a href="DeepZoomImage.html#height">height</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#maxScale"><a href="DeepZoomImage.html#maxScale">maxScale</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#pixelSize"><a href="DeepZoomImage.html#pixelSize">pixelSize</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#width"><a href="DeepZoomImage.html#width">width</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#_calculateBounds"><a href="DeepZoomImage.html#_calculateBounds">_calculateBounds</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#_createTiles"><a href="DeepZoomImage.html#_createTiles">_createTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#activate"><a href="DeepZoomImage.html#activate">activate</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#addTiles"><a href="DeepZoomImage.html#addTiles">addTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#allTiles"><a href="DeepZoomImage.html#allTiles">allTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#bringTilesToFront"><a href="DeepZoomImage.html#bringTilesToFront">bringTilesToFront</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#calculateBounds"><a href="DeepZoomImage.html#calculateBounds">calculateBounds</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#changedTiles"><a href="DeepZoomImage.html#changedTiles">changedTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#deactivate"><a href="DeepZoomImage.html#deactivate">deactivate</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#destroyObsoleteTiles"><a href="DeepZoomImage.html#destroyObsoleteTiles">destroyObsoleteTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#destroyTiles"><a href="DeepZoomImage.html#destroyTiles">destroyTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#destroyTilesAboveLevel"><a href="DeepZoomImage.html#destroyTilesAboveLevel">destroyTilesAboveLevel</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#destroyUnneededTiles"><a href="DeepZoomImage.html#destroyUnneededTiles">destroyUnneededTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#ensureAllTiles"><a href="DeepZoomImage.html#ensureAllTiles">ensureAllTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#ensureTiles"><a href="DeepZoomImage.html#ensureTiles">ensureTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#levelAndAlphaForScale"><a href="DeepZoomImage.html#levelAndAlphaForScale">levelAndAlphaForScale</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#levelForScale"><a href="DeepZoomImage.html#levelForScale">levelForScale</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#neededTiles"><a href="DeepZoomImage.html#neededTiles">neededTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#populateAllTiles"><a href="DeepZoomImage.html#populateAllTiles">populateAllTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#populateTiles"><a href="DeepZoomImage.html#populateTiles">populateTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#setup"><a href="DeepZoomImage.html#setup">setup</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#setupTiles"><a href="DeepZoomImage.html#setupTiles">setupTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#thumbnail"><a href="DeepZoomImage.html#thumbnail">thumbnail</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#tintObsoleteTiles"><a href="DeepZoomImage.html#tintObsoleteTiles">tintObsoleteTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomImage#transformed"><a href="DeepZoomImage.html#transformed">transformed</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="DeepZoomInfo">
|
|
<span class="title ">
|
|
|
|
<a href="DeepZoomInfo.html">DeepZoomInfo</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="DeepZoomInfo#dimensions"><a href="DeepZoomInfo.html#dimensions">dimensions</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomInfo#getDimensions"><a href="DeepZoomInfo.html#getDimensions">getDimensions</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomInfo#getNumTiles"><a href="DeepZoomInfo.html#getNumTiles">getNumTiles</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomInfo#getScale"><a href="DeepZoomInfo.html#getScale">getScale</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomInfo#imageForURL"><a href="DeepZoomInfo.html#imageForURL">imageForURL</a></li>
|
|
|
|
<li class="parent " data-name="DeepZoomInfo#urlForTile"><a href="DeepZoomInfo.html#urlForTile">urlForTile</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Flippable">
|
|
<span class="title ">
|
|
|
|
<a href="Flippable.html">Flippable</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="Flippable#flipped"><a href="Flippable.html#flipped">flipped</a></li>
|
|
|
|
<li class="parent " data-name="Flippable#frontSideInFront"><a href="Flippable.html#frontSideInFront">frontSideInFront</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Flippable#layout"><a href="Flippable.html#layout">layout</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="FontInfo">
|
|
<span class="title ">
|
|
|
|
<a href="FontInfo.html">FontInfo</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Hypenate">
|
|
<span class="title ">
|
|
|
|
<a href="Hypenate.html">Hypenate</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Hypenate.splitLines"><a href="Hypenate.html#.splitLines">splitLines</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="InteractivePopup">
|
|
<span class="title ">
|
|
|
|
<a href="InteractivePopup.html">InteractivePopup</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class=" " data-name="InteractivePopup#content"><a href="InteractivePopup.html#content">content</a></li>
|
|
|
|
<li class=" " data-name="InteractivePopup#header"><a href="InteractivePopup.html#header">header</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class=" " data-name="InteractivePopup#hide"><a href="InteractivePopup.html#hide">hide</a></li>
|
|
|
|
<li class="parent " data-name="InteractivePopup#layout"><a href="InteractivePopup.html#layout">layout</a></li>
|
|
|
|
<li class=" " data-name="InteractivePopup#show"><a href="InteractivePopup.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="LabeledGraphics">
|
|
<span class="title ">
|
|
|
|
<a href="LabeledGraphics.html">LabeledGraphics</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="LabeledGraphics#clear"><a href="LabeledGraphics.html#clear">clear</a></li>
|
|
|
|
<li class="parent " data-name="LabeledGraphics#debugInfos"><a href="LabeledGraphics.html#debugInfos">debugInfos</a></li>
|
|
|
|
<li class="parent " data-name="LabeledGraphics#ensureLabel"><a href="LabeledGraphics.html#ensureLabel">ensureLabel</a></li>
|
|
|
|
<li class="parent " data-name="LabeledGraphics#getLabel"><a href="LabeledGraphics.html#getLabel">getLabel</a></li>
|
|
|
|
<li class="parent " data-name="LabeledGraphics#hideLabel"><a href="LabeledGraphics.html#hideLabel">hideLabel</a></li>
|
|
|
|
<li class="parent " data-name="LabeledGraphics#removeLabel"><a href="LabeledGraphics.html#removeLabel">removeLabel</a></li>
|
|
|
|
<li class="parent " data-name="LabeledGraphics#truncateLabel"><a href="LabeledGraphics.html#truncateLabel">truncateLabel</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="LabeledGraphics.exports.LabeledGraphics">
|
|
<span class="title ">
|
|
|
|
<a href="LabeledGraphics.exports.LabeledGraphics.html">LabeledGraphics.exports.LabeledGraphics</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="List">
|
|
<span class="title ">
|
|
|
|
<a href="List.html">List</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="List#innerHeight"><a href="List.html#innerHeight">innerHeight</a></li>
|
|
|
|
<li class="parent " data-name="List#innerWidth"><a href="List.html#innerWidth">innerWidth</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="List#capture"><a href="List.html#capture">capture</a></li>
|
|
|
|
<li class="parent " data-name="List#layout"><a href="List.html#layout">layout</a></li>
|
|
|
|
<li class="parent " data-name="List#resize"><a href="List.html#resize">resize</a></li>
|
|
|
|
<li class="parent " data-name="List#setItems"><a href="List.html#setItems">setItems</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Message">
|
|
<span class="title ">
|
|
|
|
<a href="Message.html">Message</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Message#layout"><a href="Message.html#layout">layout</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Modal">
|
|
<span class="title ">
|
|
|
|
<a href="Modal.html">Modal</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="Modal#content"><a href="Modal.html#content">content</a></li>
|
|
|
|
<li class="parent " data-name="Modal#header"><a href="Modal.html#header">header</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Modal#hide"><a href="Modal.html#hide">hide</a></li>
|
|
|
|
<li class="parent " data-name="Modal#layout"><a href="Modal.html#layout">layout</a></li>
|
|
|
|
<li class="parent " data-name="Modal#show"><a href="Modal.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="PIXIApp">
|
|
<span class="title ">
|
|
|
|
<a href="PIXIApp.html">PIXIApp</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="PIXIApp#center"><a href="PIXIApp.html#center">center</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#size"><a href="PIXIApp.html#size">size</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="PIXIApp#addFpsDisplay"><a href="PIXIApp.html#addFpsDisplay">addFpsDisplay</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#checkOrientation"><a href="PIXIApp.html#checkOrientation">checkOrientation</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#convertPointFromNodeToPage"><a href="PIXIApp.html#convertPointFromNodeToPage">convertPointFromNodeToPage</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#convertPointFromPageToNode"><a href="PIXIApp.html#convertPointFromPageToNode">convertPointFromPageToNode</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#draw"><a href="PIXIApp.html#draw">draw</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#expandRenderer"><a href="PIXIApp.html#expandRenderer">expandRenderer</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#layout"><a href="PIXIApp.html#layout">layout</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#loadSprites"><a href="PIXIApp.html#loadSprites">loadSprites</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#loadTextures"><a href="PIXIApp.html#loadTextures">loadTextures</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#message"><a href="PIXIApp.html#message">message</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#modal"><a href="PIXIApp.html#modal">modal</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#mutate"><a href="PIXIApp.html#mutate">mutate</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#orientation"><a href="PIXIApp.html#orientation">orientation</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#orientationChanged"><a href="PIXIApp.html#orientationChanged">orientationChanged</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#progress"><a href="PIXIApp.html#progress">progress</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#query"><a href="PIXIApp.html#query">query</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#resize"><a href="PIXIApp.html#resize">resize</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#setup"><a href="PIXIApp.html#setup">setup</a></li>
|
|
|
|
<li class="parent " data-name="PIXIApp#subscribe"><a href="PIXIApp.html#subscribe">subscribe</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Popup">
|
|
<span class="title ">
|
|
|
|
<a href="Popup.html">Popup</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class=" " data-name="Popup#content"><a href="Popup.html#content">content</a></li>
|
|
|
|
<li class=" " data-name="Popup#header"><a href="Popup.html#header">header</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class=" " data-name="Popup#hide"><a href="Popup.html#hide">hide</a></li>
|
|
|
|
<li class=" " data-name="Popup#layout"><a href="Popup.html#layout">layout</a></li>
|
|
|
|
<li class=" " data-name="Popup#show"><a href="Popup.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="PopupMenu">
|
|
<span class="title ">
|
|
|
|
<a href="PopupMenu.html">PopupMenu</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class=" " data-name="PopupMenu#content"><a href="PopupMenu.html#content">content</a></li>
|
|
|
|
<li class=" " data-name="PopupMenu#header"><a href="PopupMenu.html#header">header</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class=" " data-name="PopupMenu#hide"><a href="PopupMenu.html#hide">hide</a></li>
|
|
|
|
<li class=" " data-name="PopupMenu#layout"><a href="PopupMenu.html#layout">layout</a></li>
|
|
|
|
<li class=" " data-name="PopupMenu#show"><a href="PopupMenu.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Progress">
|
|
<span class="title ">
|
|
|
|
<a href="Progress.html">Progress</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="Progress#progress"><a href="Progress.html#progress">progress</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Progress#hide"><a href="Progress.html#hide">hide</a></li>
|
|
|
|
<li class="parent " data-name="Progress#layout"><a href="Progress.html#layout">layout</a></li>
|
|
|
|
<li class="parent " data-name="Progress#show"><a href="Progress.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Slider">
|
|
<span class="title ">
|
|
|
|
<a href="Slider.html">Slider</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="Slider#disabled"><a href="Slider.html#disabled">disabled</a></li>
|
|
|
|
<li class="parent " data-name="Slider#value"><a href="Slider.html#value">value</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Slider#hide"><a href="Slider.html#hide">hide</a></li>
|
|
|
|
<li class="parent " data-name="Slider#layout"><a href="Slider.html#layout">layout</a></li>
|
|
|
|
<li class="parent " data-name="Slider#show"><a href="Slider.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Switch">
|
|
<span class="title ">
|
|
|
|
<a href="Switch.html">Switch</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="Switch#active"><a href="Switch.html#active">active</a></li>
|
|
|
|
<li class="parent " data-name="Switch#disabled"><a href="Switch.html#disabled">disabled</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Switch#hide"><a href="Switch.html#hide">hide</a></li>
|
|
|
|
<li class="parent " data-name="Switch#layout"><a href="Switch.html#layout">layout</a></li>
|
|
|
|
<li class="parent " data-name="Switch#show"><a href="Switch.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="TextLabel.TextLabel">
|
|
<span class="title ">
|
|
|
|
<a href="TextLabel.TextLabel.html">TextLabel.TextLabel</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Theme">
|
|
<span class="title ">
|
|
|
|
<a href="Theme.html">Theme</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Theme.fromString"><a href="Theme.html#.fromString">fromString</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="ThemeDark">
|
|
<span class="title ">
|
|
|
|
<a href="ThemeDark.html">ThemeDark</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="ThemeLight">
|
|
<span class="title ">
|
|
|
|
<a href="ThemeLight.html">ThemeLight</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="ThemeRed">
|
|
<span class="title ">
|
|
|
|
<a href="ThemeRed.html">ThemeRed</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="TileQuadNode">
|
|
<span class="title ">
|
|
|
|
<a href="TileQuadNode.html">TileQuadNode</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="TileQuadNode#link"><a href="TileQuadNode.html#link">link</a></li>
|
|
|
|
<li class="parent " data-name="TileQuadNode#noQuads"><a href="TileQuadNode.html#noQuads">noQuads</a></li>
|
|
|
|
<li class="parent " data-name="TileQuadNode#unlink"><a href="TileQuadNode.html#unlink">unlink</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Tooltip">
|
|
<span class="title ">
|
|
|
|
<a href="Tooltip.html">Tooltip</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class=" " data-name="Tooltip#content"><a href="Tooltip.html#content">content</a></li>
|
|
|
|
<li class=" " data-name="Tooltip#header"><a href="Tooltip.html#header">header</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class=" " data-name="Tooltip#hide"><a href="Tooltip.html#hide">hide</a></li>
|
|
|
|
<li class=" " data-name="Tooltip#layout"><a href="Tooltip.html#layout">layout</a></li>
|
|
|
|
<li class=" " data-name="Tooltip#show"><a href="Tooltip.html#show">show</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="UITest">
|
|
<span class="title ">
|
|
|
|
<a href="UITest.html">UITest</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li class="parent " data-name="UITest#timeline"><a href="UITest.html#timeline">timeline</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="UITest#clear"><a href="UITest.html#clear">clear</a></li>
|
|
|
|
<li class="parent " data-name="UITest#pan"><a href="UITest.html#pan">pan</a></li>
|
|
|
|
<li class="parent " data-name="UITest#pinch"><a href="UITest.html#pinch">pinch</a></li>
|
|
|
|
<li class="parent " data-name="UITest#restart"><a href="UITest.html#restart">restart</a></li>
|
|
|
|
<li class="parent " data-name="UITest#start"><a href="UITest.html#start">start</a></li>
|
|
|
|
<li class="parent " data-name="UITest#stop"><a href="UITest.html#stop">stop</a></li>
|
|
|
|
<li class="parent " data-name="UITest#tap"><a href="UITest.html#tap">tap</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="Volatile">
|
|
<span class="title ">
|
|
|
|
<a href="Volatile.html">Volatile</a>
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li class="parent " data-name="Volatile#layout"><a href="Volatile.html#layout">layout</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
<div class="main">
|
|
<h1 class="page-title" data-filename="pixi_flippable.js.html">Source: pixi/flippable.js</h1>
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<header>
|
|
<div class="header content-size">
|
|
<h2>pixi/flippable.js</h2>
|
|
</div>
|
|
</header>
|
|
<article>
|
|
<pre id="source-code" class="prettyprint source linenums"><code>/* globals Power2, Sine */
|
|
/*eslint no-console: ["error", { allow: ["log", "info", "error"] }]*/
|
|
|
|
/**
|
|
* Callback for the flippable onStart function.
|
|
*
|
|
* @callback onStartCallback
|
|
* @param {Flippable} flippable - A reference to the flippable (also this refers to the flippable).
|
|
*/
|
|
|
|
/**
|
|
* Callback for the flippable onUpdate function.
|
|
*
|
|
* @callback onUpdateCallback
|
|
* @param {Flippable} flippable - A reference to the flippable (also this refers to the flippable).
|
|
*/
|
|
|
|
/**
|
|
* Callback for the flippable onComplete function.
|
|
*
|
|
* @callback onCompleteCallback
|
|
* @param {Flippable} flippable - A reference to the flippable (also this refers to the flippable).
|
|
*/
|
|
|
|
/**
|
|
* Class that represents a PixiJS Flippable.
|
|
*
|
|
* @example
|
|
* const front = PIXI.Sprite.fromImage('./assets/front.jpg')
|
|
* const back = PIXI.Sprite.fromImage('./assets/back.jpg')
|
|
* app.scene.addChild(front)
|
|
*
|
|
* // Create the flippable
|
|
* const flippable = new Flippable(front, back, app.renderer)
|
|
*
|
|
* front.interactive = true
|
|
* front.on('click', event => flippable.toggle())
|
|
*
|
|
* @class
|
|
* @extends PIXI.projection.Camera3d
|
|
* @see {@link https://github.com/pixijs/pixi-projection|PixiJS Projection}
|
|
* @see {@link https://www.iwm-tuebingen.de/iwmbrowser/lib/pixi/flippable.html|DocTest}
|
|
*/
|
|
export default class Flippable extends PIXI.projection.Camera3d {
|
|
|
|
/**
|
|
* Creates an instance of a Flippable.
|
|
*
|
|
* @constructor
|
|
* @param {PIXI.DisplayObject} front - The object to show initially. Should have been added to the scene.
|
|
* @param {PIXI.DisplayObject} back - The object to show on the backside. Should have not been added to the scene.
|
|
* @param {PIXI.WebGLRenderer|PIXI.CanvasRenderer} renderer - The renderer of the application.
|
|
* @param {object} [opts] - An options object which can contain the following properties.
|
|
* @param {number} [opts.duration=1] - The duration of the flip animation in seconds.
|
|
* @param {GSAP.Ease} [opts.ease=Power2.easeOut] - The ease of the flip animation.
|
|
* @param {boolean} [opts.shadow=false] - Should be a shadow been display during the animation?
|
|
* @param {numer} [opts.eulerX=0] - The shift of the x-axis during the animation.
|
|
* @param {numer} [opts.eulerY=0] - The shift of the y-axis during the animation.
|
|
* @param {GSAP.Ease} [opts.eulerEase=Sine.easeOut] - The ease of the shift.
|
|
* @param {boolean} [opts.useBackTransforms=false] - When set to true, the flip animation also animates to the transform parameters of the back-object.
|
|
* @param {GSAP.Ease} [opts.transformEase=Power2.easeOut] - The ease of the transform.
|
|
* @param {numer} [opts.focus=800] - The value of the focus of the 3D camera (see pixi-projection).
|
|
* @param {numer} [opts.near=10] - The near value of the 3D camera (see pixi-projection).
|
|
* @param {numer} [opts.far=10000] - The far value of the 3D camera (see pixi-projection).
|
|
* @param {boolean} [opts.orthographic=false] - Should the flip animation be an orthographic animation?
|
|
* @param {function} [opts.onStart=null] - A callback executed on start of the flip animation.
|
|
* @param {function} [opts.onUpdate=null] - A callback executed on each step of the flip animation.
|
|
* @param {function} [opts.onComplete=null] - A callback executed when the flip animation is finished.
|
|
*/
|
|
constructor(front, back, renderer, opts = {}) {
|
|
|
|
super()
|
|
|
|
this.opts = Object.assign({}, {
|
|
front,
|
|
back,
|
|
renderer,
|
|
duration: 1,
|
|
ease: Power2.easeOut,
|
|
shadow: false,
|
|
eulerX: 0,
|
|
eulerY: 0,
|
|
eulerEase: Sine.easeOut,
|
|
useBackTransforms: false,
|
|
transformEase: Power2.easeOut,
|
|
focus: 800,
|
|
near: 10,
|
|
far: 10000,
|
|
orthographic: false
|
|
}, opts)
|
|
|
|
// planes
|
|
//--------------------
|
|
this.setPlanes(this.opts.focus, this.opts.near, this.opts.far, this.opts.orthographic)
|
|
|
|
// flipped
|
|
//--------------------
|
|
this._flipped = false
|
|
|
|
// objects
|
|
//--------------------
|
|
this.objects = {}
|
|
|
|
// setup
|
|
//--------------------
|
|
this.setup()
|
|
}
|
|
|
|
/**
|
|
* Creates children and instantiates everything.
|
|
*
|
|
* @private
|
|
* @return {Flippable} A reference to the flippable for chaining.
|
|
*/
|
|
setup() {
|
|
|
|
const scale = .5
|
|
|
|
// filters
|
|
//--------------------
|
|
const blurFilter = new PIXI.filters.BlurFilter()
|
|
blurFilter.blur = 0.2
|
|
this.objects.blurFilter = blurFilter
|
|
|
|
// outer
|
|
//--------------------
|
|
const outer = new PIXI.projection.Container3d()
|
|
outer.scale3d.set(scale)
|
|
this.addChild(outer)
|
|
this.objects.outer = outer
|
|
|
|
// shadow
|
|
//--------------------
|
|
const shadow = new PIXI.projection.Sprite3d(PIXI.Texture.fromImage('../../assets/images/shadow.png'))
|
|
shadow.renderable = false
|
|
shadow.anchor.set(0.5)
|
|
shadow.scale3d.set(.98)
|
|
shadow.alpha = 0.7
|
|
shadow.filters = [blurFilter]
|
|
shadow.visible = this.opts.shadow
|
|
outer.addChild(shadow)
|
|
this.objects.shadow = shadow
|
|
|
|
// inner
|
|
//--------------------
|
|
const inner = new PIXI.projection.Container3d()
|
|
inner.euler.y = Math.PI
|
|
outer.addChild(inner)
|
|
this.objects.inner = inner
|
|
|
|
// front
|
|
//--------------------
|
|
const front = new PIXI.projection.Sprite3d(PIXI.Texture.EMPTY)
|
|
front.scale.set(-1 / scale, 1 / scale)
|
|
front.renderable = true
|
|
front.anchor.set(.5)
|
|
inner.addChild(front)
|
|
this.objects.front = front
|
|
|
|
// back
|
|
//--------------------
|
|
const back = new PIXI.projection.Sprite3d(PIXI.Texture.EMPTY)
|
|
back.scale.set(1 / scale, 1 / scale)
|
|
back.renderable = false
|
|
back.anchor.set(.5)
|
|
inner.addChild(back)
|
|
this.objects.back = back
|
|
|
|
return this
|
|
}
|
|
|
|
/**
|
|
* Gets or sets the flipped state.
|
|
*
|
|
* @member {boolean}
|
|
*/
|
|
get flipped() {
|
|
return this._flipped
|
|
}
|
|
set flipped(toBack) {
|
|
|
|
this._flipped = toBack
|
|
|
|
// references
|
|
//--------------------
|
|
const front = this.objects.front
|
|
const back = this.objects.back
|
|
const inner = this.objects.inner
|
|
const shadow = this.objects.shadow
|
|
const blurFilter = this.objects.blurFilter
|
|
|
|
const half = this.opts.duration / 2
|
|
const ease = this.opts.eulerEase
|
|
|
|
const fromObject = toBack ? this.opts.front : this.opts.back
|
|
const toObject = toBack ? this.opts.back : this.opts.front
|
|
|
|
// set textures for virtual front and virtual back
|
|
//--------------------
|
|
front.texture = this.generateTexture(this.opts.front)
|
|
back.texture = this.generateTexture(this.opts.back)
|
|
|
|
// switch objects and set params for virtual objects
|
|
//--------------------
|
|
const fromCenter = this.anchorToCenter(fromObject)
|
|
const toCenter = this.anchorToCenter(toObject)
|
|
|
|
// from values
|
|
//--------------------
|
|
this.x = fromCenter.x
|
|
this.y = fromCenter.y
|
|
front.width = fromObject.width * 2
|
|
front.height = fromObject.height * 2
|
|
back.width = fromObject.width * 2
|
|
back.height = fromObject.height * 2
|
|
this.rotation = fromObject.rotation
|
|
this.skew.x = fromObject.skew.x
|
|
this.skew.y = fromObject.skew.y
|
|
|
|
// calculate to values
|
|
//--------------------
|
|
const to = {
|
|
x: this.opts.useBackTransforms ? toCenter.x : fromCenter.x,
|
|
y: this.opts.useBackTransforms ? toCenter.y : fromCenter.y,
|
|
anchorX: this.opts.useBackTransforms ? toObject.x : fromObject.x,
|
|
anchorY: this.opts.useBackTransforms ? toObject.y : fromObject.y,
|
|
width: this.opts.useBackTransforms ? toObject.width * 2 : fromObject.width * 2,
|
|
height: this.opts.useBackTransforms ? toObject.height * 2 : fromObject.height * 2,
|
|
rotation: this.opts.useBackTransforms ? toObject.rotation : fromObject.rotation,
|
|
skewX: this.opts.useBackTransforms ? toObject.skew.x : fromObject.skew.x,
|
|
skewY: this.opts.useBackTransforms ? toObject.skew.y : fromObject.skew.y
|
|
}
|
|
|
|
// set toObject end values
|
|
//--------------------
|
|
toObject.x = to.anchorX
|
|
toObject.y = to.anchorY
|
|
toObject.width = to.width / 2
|
|
toObject.height = to.height / 2
|
|
toObject.rotation = to.rotation
|
|
toObject.skew.x = to.skewX
|
|
toObject.skew.y = to.skewY
|
|
|
|
// flip
|
|
//--------------------
|
|
TweenLite.to(inner.euler, this.opts.duration, {
|
|
y: toBack ? 0 : Math.PI,
|
|
ease: this.opts.ease,
|
|
onStart: () => {
|
|
this.switchDisplayObject(fromObject, this)
|
|
shadow.renderable = true
|
|
if (this.opts.onStart) {
|
|
this.opts.onStart(this, this)
|
|
}
|
|
},
|
|
onUpdate: () => {
|
|
this.layout()
|
|
if (this.opts.onUpdate) {
|
|
this.opts.onUpdate(this, this)
|
|
}
|
|
},
|
|
onComplete: () => {
|
|
this.switchDisplayObject(this, toObject)
|
|
shadow.renderable = false
|
|
if (this.opts.onComplete) {
|
|
this.opts.onComplete(this, this)
|
|
}
|
|
}
|
|
})
|
|
|
|
// x & y
|
|
//--------------------
|
|
TweenLite.to(this, this.opts.duration, {
|
|
x: to.x,
|
|
y: to.y,
|
|
ease: this.opts.transformEase
|
|
})
|
|
|
|
// width & height
|
|
//--------------------
|
|
TweenLite.to([front, back], this.opts.duration, {
|
|
width: to.width,
|
|
height: to.height,
|
|
ease: this.opts.transformEase
|
|
})
|
|
|
|
// rotation
|
|
//--------------------
|
|
TweenLite.to(this, this.opts.duration, {
|
|
directionalRotation: {
|
|
rotation: `${to.rotation}_short`,
|
|
useRadians: true
|
|
},
|
|
ease: this.opts.transformEase
|
|
})
|
|
|
|
// skewX & skewY
|
|
//--------------------
|
|
TweenLite.to(this.skew, this.opts.duration, {
|
|
x: to.skewX,
|
|
y: to.skewY,
|
|
ease: this.opts.transformEase
|
|
})
|
|
|
|
// camera
|
|
//--------------------
|
|
new TimelineMax()
|
|
.to(this.euler, half, {x: this.opts.eulerX, y: this.opts.eulerY, ease})
|
|
.to(this.euler, half, {x: 0, y: 0, ease})
|
|
|
|
// shadow
|
|
//--------------------
|
|
new TimelineMax()
|
|
.to(shadow, half, {alpha: .3, ease})
|
|
.to(shadow, half, {alpha: .7, ease})
|
|
|
|
// blurfilter
|
|
//--------------------
|
|
new TimelineMax()
|
|
.to(blurFilter, half, {blur: 6, ease})
|
|
.to(blurFilter, half, {blur: .2, ease})
|
|
}
|
|
|
|
/**
|
|
* Should be called to refresh the layout of the camera.
|
|
*
|
|
* @return {Flippable} A reference to the flippable for chaining.
|
|
*/
|
|
layout() {
|
|
|
|
const front = this.objects.front
|
|
const back = this.objects.back
|
|
const shadow = this.objects.shadow
|
|
const inner = this.objects.inner
|
|
|
|
inner.position3d.z = -Math.sin(inner.euler.y) * front.texture.baseTexture.width * 2
|
|
|
|
//this.objects.shadow.euler = this.objects.inner.euler
|
|
shadow.euler.x = -inner.euler.x
|
|
shadow.euler.y = -inner.euler.y
|
|
|
|
if (this.frontSideInFront) {
|
|
front.renderable = true
|
|
back.renderable = false
|
|
shadow.width = front.width
|
|
shadow.height = front.height
|
|
} else {
|
|
front.renderable = false
|
|
back.renderable = true
|
|
shadow.width = back.width
|
|
shadow.height = back.height
|
|
}
|
|
|
|
return this
|
|
}
|
|
|
|
/**
|
|
* Toggles the flippable. Switches the sides.
|
|
*
|
|
* @private
|
|
* @return {Flippable} A reference to the flippable for chaining.
|
|
*/
|
|
toggle() {
|
|
this.flipped = !this.flipped
|
|
|
|
return this
|
|
}
|
|
|
|
/**
|
|
* Gets the alignment state. true if the front side is in front, false otherwise.
|
|
*
|
|
* @member {boolean}
|
|
*/
|
|
get frontSideInFront() {
|
|
return !this.objects.inner.isFrontFace()
|
|
}
|
|
|
|
/**
|
|
* Calculates the center point of an PIXI.DisplayObject.
|
|
*
|
|
* @private
|
|
* @param {PIXI.DisplayObject} displayObject - The DisplayObject from which to calculate the center.
|
|
* @return {object} Return an object with x and y.
|
|
*/
|
|
anchorToCenter(displayObject) {
|
|
const bounds = displayObject.getBounds()
|
|
return {
|
|
x: bounds.x + bounds.width / 2,
|
|
y: bounds.y + bounds.height / 2
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates children and instantiates everything.
|
|
*
|
|
* @private
|
|
* @param {PIXI.DisplayObject} displayObject - The DisplayObject from which to generate the texture.
|
|
* @return {PIXI.Texture} The generated PIXI.Texture.
|
|
*/
|
|
generateTexture(displayObject) {
|
|
|
|
// renderTexture
|
|
//--------------------
|
|
const renderTexture = PIXI.RenderTexture.create(displayObject.width, displayObject.height)
|
|
|
|
// save position
|
|
const transform = [displayObject.x, displayObject.y, displayObject.scale.x, displayObject.scale.y, displayObject.rotation, displayObject.skew.x, displayObject.skew.y, displayObject.pivot.x, displayObject.pivot.y]
|
|
|
|
displayObject.position.set(0, 0)
|
|
displayObject.skew.set(0, 0)
|
|
displayObject.rotation = 0
|
|
|
|
// render
|
|
//--------------------
|
|
this.opts.renderer.render(displayObject, renderTexture)
|
|
|
|
// restore position
|
|
displayObject.setTransform(...transform)
|
|
|
|
return renderTexture
|
|
}
|
|
|
|
/**
|
|
* Removed the first DisplayObject and adds the second one at the exactly same position.
|
|
*
|
|
* @private
|
|
* @param {PIXI.DisplayObject} first - The old DisplayObject.
|
|
* @param {PIXI.DisplayObject} second - The new DisplayObject.
|
|
* @return {Flippable} A reference to the flippable for chaining.
|
|
*/
|
|
switchDisplayObject(first, second) {
|
|
if (first && second && first.parent) {
|
|
const parent = first.parent
|
|
const index = parent.getChildIndex(first)
|
|
parent.addChildAt(second, index)
|
|
parent.removeChild(first)
|
|
}
|
|
|
|
return this
|
|
}
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<footer class="content-size">
|
|
<div class="footer">
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 11:44:08 GMT+0100 (Mitteleuropäische Normalzeit)
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
<script>prettyPrint();</script>
|
|
<script src="scripts/main.js"></script>
|
|
</body>
|
|
</html>
|