提交 4fe0fb32 编写于 作者: L looeee

Minor improvements to EllipseCurve doc

上级 7156d11c
......@@ -12,7 +12,10 @@
<h1>[name]</h1>
<div class="desc">Creates a 2d curve in the shape of an ellipse.</div>
<div class="desc">
Creates a 2d curve in the shape of an ellipse. Setting the
[page:Number xRadius] equal to the [page:Number yRadius] will result in a circle.
</div>
<h2>Example</h2>
......@@ -22,14 +25,14 @@ var curve = new THREE.EllipseCurve(
10, 10, // xRadius, yRadius
0, 2 * Math.PI, // aStartAngle, aEndAngle
false, // aClockwise
0 // aRotation
0 // aRotation
);
var path = new THREE.Path( curve.getPoints( 50 ) );
var geometry = path.createPointsGeometry( 50 );
var material = new THREE.LineBasicMaterial( { color : 0xff0000 } );
// Create the final Object3d to add to the scene
// Create the final object to add to the scene
var ellipse = new THREE.Line( geometry, material );
</code>
......@@ -38,33 +41,54 @@ var ellipse = new THREE.Line( geometry, material );
<h3>[name]( [page:Float aX], [page:Float aY], [page:Float xRadius], [page:Float yRadius], [page:Radians aStartAngle], [page:Radians aEndAngle], [page:Boolean aClockwise], [page:Radians aRotation] )</h3>
<div>
aX – The X center of the ellipse<br/>
aY – The Y center of the ellipse<br/>
xRadius – The radius of the ellipse in the x direction<br/>
yRadius – The radius of the ellipse in the y direction<br/>
aStartAngle – The start angle of the curve in radians starting from the middle right side<br/>
aEndAngle – The end angle of the curve in radians starting from the middle right side<br/>
aClockwise – Whether the ellipse is clockwise<br/>
aRotation – The rotation angle of the ellipse in radians, counterclockwise from the positive X axis (optional)<br/><br/>
<strong>Note:</strong> When going clockwise it's best to set the start angle to (Math.PI * 2) and then work towards lower numbers.
[page:Float aX] – The X center of the ellipse.<br/>
[page:Float aY] – The Y center of the ellipse.<br/>
[page:Float xRadius] – The radius of the ellipse in the x direction.<br/>
[page:Float yRadius] – The radius of the ellipse in the y direction.<br/>
[page:Radians aStartAngle] – The start angle of the curve in radians starting from the middle right side.<br/>
[page:Radians aEndAngle] – The end angle of the curve in radians starting from the middle right side.<br/>
[page:Boolean aClockwise] – Whether the ellipse is drawn clockwise.<br/>
[page:Radians aRotation] – The rotation angle of the ellipse in radians, counterclockwise from the positive X axis (optional). Default is *0*.<br/><br/>
<em>Note:</em> When going clockwise it's best to set the start angle to (Math.PI * 2) and then work towards lower numbers.
</div>
<h2>Properties</h2>
<div>See the base [page:Curve] class for common properties.</div>
<h3>[property:Float aX]</h3>
<div>The X center of the ellipse.</div>
<h3>[property:Float aY]</h3>
<div>The Y center of the ellipse.</div>
<h3>[property:Radians xRadius]</h3>
<div>The radius of the ellipse in the x direction.</div>
<h3>[property:Radians yRadius]</h3>
<div>The radius of the ellipse in the y direction.</div>
<h3>[property:Float aStartAngle]</h3>
<div>The start angle of the curve in radians starting from the middle right side.</div>
<h3>[property:Float aEndAngle]</h3>
<div>The end angle of the curve in radians starting from the middle right side.</div>
<h3>[property:Boolean aClockwise]</h3>
<div>Whether the ellipse is drawn clockwise.</div>
<h3>[property:Float aRotation]</h3>
<div>The rotation angle of the ellipse in radians, counterclockwise from the positive X axis (optional). Default is *0*.</div>
<h2>Methods</h2>
<h3>[property:Boolean isEllipseCurve]</h3>
<div>
Used to check whether this or derived classes are ellipses. Default is *true*.<br /><br />
<h3>See [page:Curve] for inherited methods</h3>
You should not change this, as it used internally for optimisation.
</div>
<h2>Methods</h2>
<div>See the base [page:Curve] class for common methods.</div>
<h2>Source</h2>
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册