gitadmin
/
three.js
mirror of https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
							<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		<h1>[name]</h1>

		<p class="desc">
			Object for keeping track of time. This uses
			[link:https://developer.mozilla.org/en-US/docs/Web/API/Performance/now performance.now] if it is available, otherwise it reverts to the less
			accurate
			[link:https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date/now Date.now].
		</p>

		<h2>Constructor</h2>

		<h3>[name]( [param:Boolean autoStart] )</h3>
		<p>
			autoStart — (optional) whether to automatically start the clock when
			[page:.getDelta]() is called for the first time. Default is `true`.
		</p>

		<h2>Properties</h2>

		<h3>[property:Boolean autoStart]</h3>
		<p>
			If set, starts the clock automatically when [page:.getDelta]() is called
			for the first time. Default is `true`.
		</p>

		<h3>[property:Float startTime]</h3>
		<p>
			Holds the time at which the clock's [page:Clock.start start] method was
			last called. Default is `0`.
		</p>

		<h3>[property:Float oldTime]</h3>
		<p>
			Holds the time at which the clock's [page:Clock.start start],
			[page:.getElapsedTime]() or [page:.getDelta]() methods were last called.
			Default is `0`.
		</p>

		<h3>[property:Float elapsedTime]</h3>
		<p>
			Keeps track of the total time that the clock has been running. Default is
			`0`.
		</p>

		<h3>[property:Boolean running]</h3>
		<p>Whether the clock is running or not. Default is `false`.</p>

		<h2>Methods</h2>

		<h3>[method:undefined start]()</h3>
		<p>
			Starts clock. Also sets the [page:.startTime] and [page:.oldTime] to the
			current time, sets [page:.elapsedTime] to `0` and [page:.running] to
			`true`.
		</p>

		<h3>[method:undefined stop]()</h3>
		<p>
			Stops clock and sets [page:Clock.oldTime oldTime] to the current time.
		</p>

		<h3>[method:Float getElapsedTime]()</h3>
		<p>
			Get the seconds passed since the clock started and sets [page:.oldTime] to
			the current time.<br />
			If [page:.autoStart] is `true` and the clock is not running, also starts
			the clock.
		</p>

		<h3>[method:Float getDelta]()</h3>
		<p>
			Get the seconds passed since the time [page:.oldTime] was set and sets
			[page:.oldTime] to the current time.<br />
			If [page:.autoStart] is `true` and the clock is not running, also starts
			the clock.
		</p>

		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>