-
Notifications
You must be signed in to change notification settings - Fork 21
/
jquery.jparallax.js
406 lines (326 loc) · 12.8 KB
/
jquery.jparallax.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
// jquery.jparallax.js
// 0.9.1
// Stephen Band
//
// Dependencies:
// jQuery 1.2.6 (jquery.com)
//
// Project and documentation site:
// http://webdev.stephband.info/parallax.html
// CLOSURE
(function(jQuery) {
// PRIVATE FUNCTIONS
function stripFiletype(ref) {
var x=ref.replace('.html', '');
return x.replace('#', '');
}
function initOrigin(l) {
if (l.xorigin=='left') {l.xorigin=0;} else if (l.xorigin=='middle' || l.xorigin=='centre' || l.xorigin=='center') {l.xorigin=0.5;} else if (l.xorigin=='right') {l.xorigin=1;}
if (l.yorigin=='top') {l.yorigin=0;} else if (l.yorigin=='middle' || l.yorigin=='centre' || l.yorigin=='center') {l.yorigin=0.5;} else if (l.yorigin=='bottom') {l.yorigin=1;}
}
function positionMouse(mouseport, localmouse, virtualmouse) {
var difference = {x: 0, y: 0, sum: 0};
// Set where the virtual mouse is, if not on target
if (!mouseport.ontarget) {
// Calculate difference
difference.x = virtualmouse.x - localmouse.x;
difference.y = virtualmouse.y - localmouse.y;
difference.sum = Math.sqrt(difference.x*difference.x + difference.y*difference.y);
// Reset virtualmouse
virtualmouse.x = localmouse.x + difference.x * mouseport.takeoverFactor;
virtualmouse.y = localmouse.y + difference.y * mouseport.takeoverFactor;
// If mouse is inside the takeoverThresh set ontarget to true
if (difference.sum < mouseport.takeoverThresh && difference.sum > mouseport.takeoverThresh*-1) {
mouseport.ontarget=true;
}
}
// Set where the layer is if on target
else {
virtualmouse.x = localmouse.x;
virtualmouse.y = localmouse.y;
}
}
function setupPorts(viewport, mouseport) {
var offset = mouseport.element.offset();
jQuery.extend(viewport, {
width: viewport.element.width(),
height: viewport.element.height()
});
jQuery.extend(mouseport, {
width: mouseport.element.width(),
height: mouseport.element.height(),
top: offset.top,
left: offset.left
});
}
function parseTravel(travel, origin, dimension) {
var offset;
var cssPos;
if (typeof(travel) === 'string') {
if (travel.search(/^\d+\s?px$/) != -1) {
travel = travel.replace('px', '');
travel = parseInt(travel, 10);
// Set offset constant used in moveLayers()
offset = origin * (dimension-travel);
// Set origin now because it won't get altered in moveLayers()
cssPos = origin * 100 + '%';
return {travel: travel, travelpx: true, offset: offset, cssPos: cssPos};
}
else if (travel.search(/^\d+\s?%$/) != -1) {
travel.replace('%', '');
travel = parseInt(travel, 10) / 100;
}
else {
travel=1;
}
}
// Set offset constant used in moveLayers()
offset = origin * (1 - travel);
return {travel: travel, travelpx: false, offset: offset}
}
function setupLayer(layer, i, mouseport) {
var xStuff;
var yStuff;
var cssObject = {};
layer[i]=jQuery.extend({}, {
width: layer[i].element.width(),
height: layer[i].element.height()
}, layer[i]);
xStuff = parseTravel(layer[i].xtravel, layer[i].xorigin, layer[i].width);
yStuff = parseTravel(layer[i].ytravel, layer[i].yorigin, layer[i].height);
jQuery.extend(layer[i], {
// Used in triggerResponse
diffxrat: mouseport.width / (layer[i].width - mouseport.width),
diffyrat: mouseport.height / (layer[i].height - mouseport.height),
// Used in moveLayers
xtravel: xStuff.travel,
ytravel: yStuff.travel,
xtravelpx: xStuff.travelpx,
ytravelpx: yStuff.travelpx,
xoffset: xStuff.offset,
yoffset: yStuff.offset
});
// Set origin now if it won't be altered in moveLayers()
if (xStuff.travelpx) {cssObject.left = xStuff.cssPos;}
if (yStuff.travelpx) {cssObject.top = yStuff.cssPos;}
if (xStuff.travelpx || yStuff.travelpx) {layer[i].element.css(cssObject);}
}
function setupLayerContents(layer, i, viewportOffset) {
var contentOffset;
// Give layer a content object
jQuery.extend(layer[i], {content: []});
// Layer content: get positions, dimensions and calculate element offsets for centering children of layers
for (var n=0; n<layer[i].element.children().length; n++) {
if (!layer[i].content[n]) layer[i].content[n] = {};
if (!layer[i].content[n].element) layer[i].content[n]['element'] = layer[i].element.children().eq(n);
// Store the anchor name if one has not already been specified. You can specify anchors in Layer Options rather than html if you want.
if(!layer[i].content[n].anchor && layer[i].content[n].element.children('a').attr('name')) {
layer[i].content[n]['anchor'] = layer[i].content[n].element.children('a').attr('name');
}
// Only bother to store child's dimensions if child has an anchor. What's the point otherwise?
if(layer[i].content[n].anchor) {
contentOffset = layer[i].content[n].element.offset();
jQuery.extend(layer[i].content[n], {
width: layer[i].content[n].element.width(),
height: layer[i].content[n].element.height(),
x: contentOffset.left - viewportOffset.left,
y: contentOffset.top - viewportOffset.top
});
jQuery.extend(layer[i].content[n], {
posxrat: (layer[i].content[n].x + layer[i].content[n].width/2) / layer[i].width,
posyrat: (layer[i].content[n].y + layer[i].content[n].height/2) / layer[i].height
});
}
}
}
function moveLayers(layer, xratio, yratio) {
var xpos;
var ypos;
var cssObject;
for (var i=0; i<layer.length; i++) {
// Calculate the moving factor
xpos = layer[i].xtravel * xratio + layer[i].xoffset;
ypos = layer[i].ytravel * yratio + layer[i].yoffset;
cssObject = {};
// Do the moving by pixels or by ratio depending on travelpx
if (layer[i].xparallax) {
if (layer[i].xtravelpx) {
cssObject.marginLeft = xpos * -1 + 'px';
}
else {
cssObject.left = xpos * 100 + '%';
cssObject.marginLeft = xpos * layer[i].width *-1 + 'px';
}
}
if (layer[i].yparallax) {
if (layer[i].ytravelpx) {
cssObject.marginTop = ypos * -1 + 'px';
}
else {
cssObject.top = ypos * 100 + '%';
cssObject.marginTop = ypos * layer[i].height * -1 + 'px';
}
}
layer[i].element.css(cssObject);
}
}
// PLUGIN DEFINITION **********************************************************************
jQuery.fn.jparallax = function(options) {
// Organise settings into objects (Is this a bit of a mess, or is it efficient?)
var settings = jQuery().extend({}, jQuery.fn.jparallax.settings, options);
var settingsLayer = {
xparallax: settings.xparallax,
yparallax: settings.yparallax,
xorigin: settings.xorigin,
yorigin: settings.yorigin,
xtravel: settings.xtravel,
ytravel: settings.ytravel
};
var settingsMouseport = {
element: settings.mouseport,
takeoverFactor: settings.takeoverFactor,
takeoverThresh: settings.takeoverThresh
};
if (settings.mouseport) settingsMouseport['element'] = settings.mouseport;
// Populate layer array with default settings
var layersettings = [];
for(var a=1; a<arguments.length; a++) {
layersettings.push( jQuery.extend( {}, settingsLayer, arguments[a]) );
}
// Iterate matched elements
return this.each(function() {
// VAR
var localmouse = {
x: 0.5,
y: 0.5
};
var virtualmouse = {
x: 0.5,
y: 0.5
};
var timer = {
running: false,
frame: settings.frameDuration,
fire: function(x, y) {
positionMouse(mouseport, localmouse, virtualmouse);
moveLayers(layer, virtualmouse.x, virtualmouse.y);
this.running = setTimeout(function() {
if ( localmouse.x!=x || localmouse.y!=y || !mouseport.ontarget ) {
timer.fire(localmouse.x, localmouse.y);
}
else if (timer.running) {
timer.running=false;
}
}, timer.frame);
}
};
var viewport = {element: jQuery(this)};
var mouseport = jQuery.extend({}, {element: viewport.element}, settingsMouseport, {
xinside: false, // is the mouse inside the mouseport's dimensions?
yinside: false,
active: false, // are the mouse coordinates still being read?
ontarget: false // is the top layer inside the takeoverThresh?
});
var layer = [];
// FUNCTIONS
function matrixSearch(layer, ref, callback) {
for (var i=0; i<layer.length; i++) {
var gotcha=false;
for (var n=0; n<layer[i].content.length; n++) {
if (layer[i].content[n].anchor==ref) {
callback(i, n);
return [i, n];
}
}
}
return false;
}
// RUN
setupPorts(viewport, mouseport);
// Cycle through and create layers
for (var i=0; i<viewport.element.children().length; i++) {
// Create layer from settings if it doesn't exist
layer[i]=jQuery.extend({}, settingsLayer, layersettings[i], {
element: viewport.element.children('*:eq('+i+')')
});
setupLayer(layer, i, mouseport);
if (settings.triggerResponse) {
setupLayerContents(layer, i, viewport.element.offset());
}
}
// Set up layers CSS and initial position
viewport.element.children().css('position', 'absolute');
moveLayers(layer, 0.5, 0.5);
// Mouse Response
if (settings.mouseResponse) {
jQuery().mousemove(function(mouse){
// Is mouse inside?
mouseport.xinside = (mouse.pageX >= mouseport.left && mouse.pageX < mouseport.width+mouseport.left) ? true : false;
mouseport.yinside = (mouse.pageY >= mouseport.top && mouse.pageY < mouseport.height+mouseport.top) ? true : false;
// Then switch active on.
if (mouseport.xinside && mouseport.yinside && !mouseport.active) {
mouseport.ontarget = false;
mouseport.active = true;
}
// If active is on give localmouse coordinates
if (mouseport.active) {
if (mouseport.xinside) { localmouse.x = (mouse.pageX - mouseport.left) / mouseport.width; }
else { localmouse.x = (mouse.pageX < mouseport.left) ? 0 : 1; }
if (mouseport.yinside) { localmouse.y = (mouse.pageY - mouseport.top) / mouseport.height; }
else { localmouse.y = (mouse.pageY < mouseport.top) ? 0 : 1; }
}
// If mouse is inside, fire timer
if (mouseport.xinside && mouseport.yinside) { if (!timer.running) timer.fire(localmouse.x, localmouse.y); }
else if (mouseport.active) { mouseport.active = false; }
});
}
// Trigger Response
if (settings.triggerResponse) {
viewport.element.bind("jparallax", function(event, ref){
ref = stripFiletype(ref);
matrixSearch(layer, ref, function(i, n) {
localmouse.x = layer[i].content[n].posxrat * (layer[i].diffxrat + 1) - (0.5 * layer[i].diffxrat);
localmouse.y = layer[i].content[n].posyrat * (layer[i].diffyrat + 1) - (0.5 * layer[i].diffyrat);
if (!settings.triggerExposesEdges) {
if (localmouse.x < 0) localmouse.x = 0;
if (localmouse.x > 1) localmouse.x = 1;
if (localmouse.y < 0) localmouse.y = 0;
if (localmouse.y > 1) localmouse.y = 1;
}
mouseport.ontarget = false;
if (!timer.running) timer.fire(localmouse.x, localmouse.y);
});
});
}
// Window Resize Response
jQuery(window).resize(function() {
setupPorts(viewport, mouseport);
for (var i=0; i<layer.length; i++) {
setupLayer(layer, i, mouseport);
}
});
});
};
// END OF PLUGIN DEFINITION **********************************************************************
// PLUGIN DEFAULTS
jQuery.fn.jparallax.settings = {
mouseResponse: true, // Sets mouse response
mouseActiveOutside: false, // Makes mouse affect layers from outside of the mouseport.
triggerResponse: true, // Sets trigger response
triggerExposesEdges: false, // Sets whether the trigger pulls layer edges into view in trying to centre layer content.
xparallax: true, // Sets directions to move in
yparallax: true, //
xorigin: 0.5, // Sets default alignment - only comes into play when travel is not 1
yorigin: 0.5, //
xtravel: 1, // Factor by which travel is amplified
ytravel: 1, //
takeoverFactor: 0.65, // Sets rate of decay curve for catching up with target mouse position
takeoverThresh: 0.002, // Sets the distance within which virtualmouse is considered to be on target, as a multiple of mouseport width.
frameDuration: 25 // In milliseconds
};
// RUN
initOrigin(jQuery.fn.jparallax.settings);
jQuery(function() {
});
// END CLOSURE
})(jQuery);