Ellipse2D (Math.Geometry)

Ellipse2D Module

Namespace: Math.Geometry
Assembly: Math.Geometry.dll

Functions and values

Function or value	Description
`area ellipse` Full Usage: `area ellipse` Parameters: ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Quantity<Squared<'Units>>`	Get the area of an ellipse. ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Quantity<Squared<'Units>>`
`axes ellipse` Full Usage: `axes ellipse` Parameters: ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Frame2D<'Units, 'Coordinates, 'Defines>`	Get the X and Y axes of an ellipse as a `Frame2D`. ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Frame2D<'Units, 'Coordinates, 'Defines>`
`centerPoint ellipse` Full Usage: `centerPoint ellipse` Parameters: ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Point2D<'Units, 'Coordinates>`	Get the center point of an ellipse. ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Point2D<'Units, 'Coordinates>`
`from centerPoint xDirection xRadius yRadius` Full Usage: `from centerPoint xDirection xRadius yRadius` Parameters: centerPoint : `Point2D<'Units, 'Coordinates>` xDirection : `Direction2D<'Coordinates>` xRadius : `Quantity<'Units>` yRadius : `Quantity<'Units>` Returns: `Ellipse2D<'Units, 'Coordinates>`	centerPoint : `Point2D<'Units, 'Coordinates>` xDirection : `Direction2D<'Coordinates>` xRadius : `Quantity<'Units>` yRadius : `Quantity<'Units>` Returns: `Ellipse2D<'Units, 'Coordinates>`
`mirrorAcross axis ellipse` Full Usage: `mirrorAcross axis ellipse` Parameters: axis : `Axis2D<'Units, 'Coordinates>` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`	Mirror an ellipse across a given axis. Note that if the axes of the original ellipse form a [right-handed](https://en.wikipedia.org/wiki/Cartesian_coordinate_system#Orientation_and_handedness) frame, then the axes of the mirrored ellipse will form a left-handed frame (and vice versa). axis : `Axis2D<'Units, 'Coordinates>` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`
`placeIn frame ellipse` Full Usage: `placeIn frame ellipse` Parameters: frame : `Frame2D<'Units, unit, unit>` ellipse : `Ellipse2D<'Units, unit>` Returns: `Ellipse2D<'Units, unit>`	Take an ellipse considered to be defined in local coordinates relative to a given reference frame, and return that circle expressed in global coordinates. frame : `Frame2D<'Units, unit, unit>` ellipse : `Ellipse2D<'Units, unit>` Returns: `Ellipse2D<'Units, unit>`
`relativeTo frame ellipse` Full Usage: `relativeTo frame ellipse` Parameters: frame : `Frame2D<'Units, unit, unit>` ellipse : `Ellipse2D<'Units, unit>` Returns: `Ellipse2D<'Units, unit>`	Take an ellipse defined in global coordinates, and return it expressed in local coordinates relative to a given reference frame. frame : `Frame2D<'Units, unit, unit>` ellipse : `Ellipse2D<'Units, unit>` Returns: `Ellipse2D<'Units, unit>`
`rotateAround point angle ellipse` Full Usage: `rotateAround point angle ellipse` Parameters: point : `Point2D<'Units, 'Coordinates>` angle : `Angle` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`	Rotate an ellipse around a given point by a given angle. point : `Point2D<'Units, 'Coordinates>` angle : `Angle` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`
`scaleAbout point scale ellipse` Full Usage: `scaleAbout point scale ellipse` Parameters: point : `Point2D<'Units, 'Coordinates>` scale : `float` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`	Scale an ellipse about a given point by a given scale. point : `Point2D<'Units, 'Coordinates>` scale : `float` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`
`transformBy axesTransformation ellipse` Full Usage: `transformBy axesTransformation ellipse` Parameters: axesTransformation : `Frame2D<'Units, 'CoordinatesA, unit> -> Frame2D<'Units, 'CoordinatesB, unit>` ellipse : `Ellipse2D<'Units, 'CoordinatesA>` Returns: `Ellipse2D<'Units, 'CoordinatesB>`	axesTransformation : `Frame2D<'Units, 'CoordinatesA, unit> -> Frame2D<'Units, 'CoordinatesB, unit>` ellipse : `Ellipse2D<'Units, 'CoordinatesA>` Returns: `Ellipse2D<'Units, 'CoordinatesB>`
`translateBy displacement ellipse` Full Usage: `translateBy displacement ellipse` Parameters: displacement : `Vector2D<'Units, 'Coordinates>` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`	Translate an ellipse by a given displacement. displacement : `Vector2D<'Units, 'Coordinates>` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`
`translateIn direction distance ellipse` Full Usage: `translateIn direction distance ellipse` Parameters: direction : `Direction2D<'Coordinates>` distance : `Quantity<'Units>` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`	Translate an ellipse in a given direction by a given distance. direction : `Direction2D<'Coordinates>` distance : `Quantity<'Units>` ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Ellipse2D<'Units, 'Coordinates>`
`xAxis ellipse` Full Usage: `xAxis ellipse` Parameters: ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Axis2D<'Units, 'Coordinates>`	Get the X axis of an ellipse. ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Axis2D<'Units, 'Coordinates>`
`xDirection ellipse` Full Usage: `xDirection ellipse` Parameters: ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Direction2D<'Coordinates>`	Get the direction of the ellipse's X axis. ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Direction2D<'Coordinates>`
`xRadius ellipse` Full Usage: `xRadius ellipse` Parameters: ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Quantity<'Units>`	Get the radius of an ellipse along its X axis. This may be either the minimum or maximum radius. ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Quantity<'Units>`
`yAxis ellipse` Full Usage: `yAxis ellipse` Parameters: ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Axis2D<'Units, 'Coordinates>`	Get the Y axis of an ellipse. ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Axis2D<'Units, 'Coordinates>`
`yDirection ellipse` Full Usage: `yDirection ellipse` Parameters: ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Direction2D<'Coordinates>`	Get the direction of an ellipse's Y axis. ellipse : `Ellipse2D<'Units, 'Coordinates>` Returns: `Direction2D<'Coordinates>`
`yRadius ellipse` Full Usage: `yRadius ellipse` Parameters: ellipse : `Ellipse2D<'Units, 'Coordiantes>` Returns: `Quantity<'Units>`	Get the radius of an ellipse along its Y axis. This may be either the minimum or maximum radius. ellipse : `Ellipse2D<'Units, 'Coordiantes>` Returns: `Quantity<'Units>`