Class Index | File Index

Classes


Class JXG.Circle


Extends JXG.GeometryElement.
Creates a new circle object. Do not use this constructor to create a circle. Use JXG.Board#create with type Circle instead.
Defined in: Circle.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
JXG.Circle(board, method, p1, p2, radius, id, name)
A circle consists of all points with a given distance from one point.
Field Summary
Field Attributes Field Name and Description
 
The circles center.
 
Circle defining the radius of the circle given by the radius of the other circle only set if method equals 'pointLine'.
 
Line defining the radius of the circle given by the distance from the startpoint and the endpoint of the line only set if method equals 'pointLine'.
 
Stores the given method.
 
Point on the circle only set if method equals 'twoPoints'.
 
Radius of the circle only set if method equals 'pointRadius'
Fields borrowed from class JXG.GeometryElement:
addEvent, ancestors, board, childElements, dash, descendants, draft, dump, elementClass, elType, eventHandlers, fillColor, fillOpacity, fixed, frozen, getAttribute, hasLabel, highlight, highlighted, highlightFillColor, highlightFillOpacity, highlightStrokeColor, highlightStrokeOpacity, highlightStrokeWidth, id, isDraggable, isReal, methodMap, mouseover, name, needsRegularUpdate, needsUpdate, notExistingParents, numTraces, quadraticform, removeEvent, scalable, shadow, snapToGrid, stdform, strokeColor, strokeOpacity, strokeWidth, subs, symbolic, trace, traceAttributes, traces, transformations, type, visible, visProp, withLabel
Method Summary
Method Attributes Method Name and Description
 
addTransform(transform)
Add transformations to this circle.
 
 
Radius(value)
Calculates the radius of the circle.
 
setPositionDirectly(method, coords, oldcoords)
Sets x and y coordinate and calls the circle's update() method.
 
Set a new radius, then update the board.
 
Uses the boards renderer to update the circle.
 
X(t)
Treats the circle as parametric curve and calculates its X coordinate.
 
Y(t)
Treats the circle as parametric curve and calculates its Y coordinate.
 
Z(t)
Treat the circle as parametric curve and calculates its Z coordinate.
Methods borrowed from class JXG.GeometryElement:
addChild, addRotation, animate, bounds, clearTrace, cloneToBackground, createLabel, getAttributes, getLabelAnchor, getName, getParents, getProperty, getTextAnchor, getType, hasPoint, hideElement, labelColor, noHighlight, off, on, remove, resolveShortcuts, setArrow, setAttribute, setLabelText, setProperty, showElement, triggerEventHandlers
Events borrowed from class JXG.GeometryElement:
attribute, attribute:<attribute><attribute>, down, drag, mousedown, mousedrag, mousemove, mouseout, mouseover, mouseup, move, out, over, touchdown, touchdrag, touchup, up
Class Detail
JXG.Circle(board, method, p1, p2, radius, id, name)
A circle consists of all points with a given distance from one point. This point is called center, the distance is called radius. A circle can be constructed by providing a center and a point on the circle or a center and a radius (given as a number, function, line, or circle).
Parameters:
{String|JXG.Board} board
The board the new circle is drawn on.
{String} method
Can be
  • 'twoPoints' which means the circle is defined by its center and a point on the circle.
  • 'pointRadius' which means the circle is defined by its center and its radius in user units
  • 'pointLine' which means the circle is defined by its center and its radius given by the distance from the startpoint and the endpoint of the line
  • 'pointCircle' which means the circle is defined by its center and its radius given by the radius of another circle
The parameters p1, p2 and radius must be set according to this method parameter.
{JXG.Point} p1
center of the circle.
{JXG.Point|JXG.Line|JXG.Circle} p2
Can be
  • a point on the circle if method is 'twoPoints'
  • a line if the method is 'pointLine'
  • a circle if the method is 'pointCircle'
{float} radius
Only used when method is set to 'pointRadius'. Must be a given radius in user units.
{String} id
Unique identifier for this object. If null or an empty string is given, an unique id will be generated by Board
{String} name
Not necessarily unique name. If null or an empty string is given, an unique name will be generated.
See:
JXG.Board#generateName
Field Detail
{JXG.Point} center
The circles center. Do not set this parameter directly as it will break JSXGraph's update system.

{JXG.Circle} circle
Circle defining the radius of the circle given by the radius of the other circle only set if method equals 'pointLine'. Do not set this parameter directly as it will break JSXGraph's update system.
See:
#method
Default Value:
null

{JXG.Line} line
Line defining the radius of the circle given by the distance from the startpoint and the endpoint of the line only set if method equals 'pointLine'. Do not set this parameter directly as it will break JSXGraph's update system.
See:
#method
Default Value:
null

{string} method
Stores the given method. Can be
See:
#center
#point2
#radius
#line
#circle

{JXG.Point} point2
Point on the circle only set if method equals 'twoPoints'. Do not set this parameter directly as it will break JSXGraph's update system.
See:
#method

{Number} radius
Radius of the circle only set if method equals 'pointRadius'
See:
#method
Default Value:
null
Method Detail
{JXG.Circle} addTransform(transform)
Add transformations to this circle.
Parameters:
{JXG.Transform|Array} transform
Either one JXG.Transform or an array of JXG.Transforms.
Returns:
{JXG.Circle} Reference to this circle object.

getRadius()

{Number} Radius(value)
Calculates the radius of the circle.
Parameters:
{String|Number|function} value Optional
Set new radius
Returns:
{Number} The radius of the circle

{JXG.Circle} setPositionDirectly(method, coords, oldcoords)
Sets x and y coordinate and calls the circle's update() method.
Parameters:
{number} method
The type of coordinates used here. Possible values are JXG.COORDS_BY_USER and JXG.COORDS_BY_SCREEN.
{Array} coords
coordinate in screen/user units
{Array} oldcoords
previous coordinate in screen/user units
Returns:
{JXG.Circle} Reference to this circle.

{JXG.Circle} setRadius(r)
Set a new radius, then update the board.
Parameters:
{String|Number|function} r
A string, function or number describing the new radius.
Returns:
{JXG.Circle} Reference to this circle

update()
Uses the boards renderer to update the circle.

{Number} X(t)
Treats the circle as parametric curve and calculates its X coordinate.
Parameters:
{Number} t
Number between 0 and 1.
Returns:
{Number} X(t)= radius*cos(t)+centerX.

{Number} Y(t)
Treats the circle as parametric curve and calculates its Y coordinate.
Parameters:
{Number} t
Number between 0 and 1.
Returns:
{Number} X(t)= radius*sin(t)+centerY.

{Number} Z(t)
Treat the circle as parametric curve and calculates its Z coordinate.
Parameters:
{Number} t
ignored
Returns:
{Number} 1.0

Documentation generated by JsDoc Toolkit 2.4.0 on Thu May 30 2013 23:22:16 GMT+0200 (CEST)