Circle2D (Math.Geometry)

Circle2D Module

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

Functions and values

Function or value	Description
`area circle` Full Usage: `area circle` Parameters: circle : `Circle2D<'Units, 'Coordinates>` Returns: `Quantity<Squared<'Units>>`	circle : `Circle2D<'Units, 'Coordinates>` Returns: `Quantity<Squared<'Units>>`
`atOrigin radius` Full Usage: `atOrigin radius` Parameters: radius : `Quantity<'a>` Returns: `Circle2D<'a, 'b>`	radius : `Quantity<'a>` Returns: `Circle2D<'a, 'b>`
`atPoint center radius` Full Usage: `atPoint center radius` Parameters: center : `Point2D<'Units, 'Coordinates>` radius : `Quantity<'Units>` Returns: `Circle2D<'Units, 'Coordinates>`	center : `Point2D<'Units, 'Coordinates>` radius : `Quantity<'Units>` Returns: `Circle2D<'Units, 'Coordinates>`
`boundingBox circle` Full Usage: `boundingBox circle` Parameters: circle : `Circle2D<'Units, 'Coordinates>` Returns: `BoundingBox2D<'Units, 'Coordinates>`	circle : `Circle2D<'Units, 'Coordinates>` Returns: `BoundingBox2D<'Units, 'Coordinates>`
`centerPoint circle` Full Usage: `centerPoint circle` Parameters: circle : `Circle2D<'Units, 'Coordinates>` Returns: `Point2D<'Units, 'Coordinates>`	circle : `Circle2D<'Units, 'Coordinates>` Returns: `Point2D<'Units, 'Coordinates>`
`circumference circle` Full Usage: `circumference circle` Parameters: circle : `Circle2D<'Units, 'Coordinates>` Returns: `Quantity<'Units>`	circle : `Circle2D<'Units, 'Coordinates>` Returns: `Quantity<'Units>`
`containsPoint point circle` Full Usage: `containsPoint point circle` Parameters: point : `Point2D<'Units, 'Coordinates>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `bool`	Test if a circle point is contained within a circle. A point is considered to be contained if the point lies on the edge of the circle. point : `Point2D<'Units, 'Coordinates>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `bool`
`diameter circle` Full Usage: `diameter circle` Parameters: circle : `Circle2D<'Units, 'Coordinates>` Returns: `Quantity<'Units>`	circle : `Circle2D<'Units, 'Coordinates>` Returns: `Quantity<'Units>`
`intersectsBoundingBox box circle` Full Usage: `intersectsBoundingBox box circle` Parameters: box : `BoundingBox2D<'Units, 'Coordinates>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `bool`	Check if a circle intersects with a given bounding box. This function will return true if the circle intersects the edges of the bounding box _or_ is fully contained within the bounding box. box : `BoundingBox2D<'Units, 'Coordinates>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `bool`
`mirrorAcross axis circle` Full Usage: `mirrorAcross axis circle` Parameters: axis : `Axis2D<'Units, 'Coordinates>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`	Mirror a circle across a given axis. axis : `Axis2D<'Units, 'Coordinates>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`
`placeIn frame circle` Full Usage: `placeIn frame circle` Parameters: frame : `Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>` circle : `Circle2D<'Units, 'LocalCoordinates>` Returns: `Circle2D<'Units, 'GlobalCoordinates>`	Take a circle considered to be defined in local coordinates relative to a given reference frame, and return that circle expressed in global coordinates. frame : `Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>` circle : `Circle2D<'Units, 'LocalCoordinates>` Returns: `Circle2D<'Units, 'GlobalCoordinates>`
`radius circle` Full Usage: `radius circle` Parameters: circle : `Circle2D<'Units, 'Coordinates>` Returns: `Quantity<'Units>`	circle : `Circle2D<'Units, 'Coordinates>` Returns: `Quantity<'Units>`
`relativeTo frame circle` Full Usage: `relativeTo frame circle` Parameters: frame : `Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>` circle : `Circle2D<'Units, 'GlobalCoordinates>` Returns: `Circle2D<'Units, 'LocalCoordinates>`	Take a circle defined in global coordinates, and return it expressed in local coordinates relative to a given reference frame. frame : `Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>` circle : `Circle2D<'Units, 'GlobalCoordinates>` Returns: `Circle2D<'Units, 'LocalCoordinates>`
`scaleAbout point scale circle` Full Usage: `scaleAbout point scale circle` Parameters: point : `Point2D<'Units, 'Coordinates>` scale : `float` circle : `Circle2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`	point : `Point2D<'Units, 'Coordinates>` scale : `float` circle : `Circle2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`
`sweptAround centerPoint point` Full Usage: `sweptAround centerPoint point` Parameters: centerPoint : `Point2D<'Units, 'Coordinates>` point : `Point2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`	centerPoint : `Point2D<'Units, 'Coordinates>` point : `Point2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`
`throughPoints p1 p2 p3` Full Usage: `throughPoints p1 p2 p3` Parameters: p1 : `Point2D<'Units, 'Coordinates>` p2 : `Point2D<'Units, 'Coordinates>` p3 : `Point2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates> option`	p1 : `Point2D<'Units, 'Coordinates>` p2 : `Point2D<'Units, 'Coordinates>` p3 : `Point2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates> option`
`toArc circle` Full Usage: `toArc circle` Parameters: circle : `Circle2D<'Units, 'Coordinates>` Returns: `Arc2D<'Units, 'Coordinates>`	circle : `Circle2D<'Units, 'Coordinates>` Returns: `Arc2D<'Units, 'Coordinates>`
`translateBy displacement circle` Full Usage: `translateBy displacement circle` Parameters: displacement : `Vector2D<'Units, 'Coordinates>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`	Translate a circle by a given displacement. displacement : `Vector2D<'Units, 'Coordinates>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`
`translateIn direction distance circle` Full Usage: `translateIn direction distance circle` Parameters: direction : `Direction2D<'Coordinates>` distance : `Quantity<'Units>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`	Translate a circle in a given direction by a given distance. direction : `Direction2D<'Coordinates>` distance : `Quantity<'Units>` circle : `Circle2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`
`withRadius radius center` Full Usage: `withRadius radius center` Parameters: radius : `Quantity<'Units>` center : `Point2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`	radius : `Quantity<'Units>` center : `Point2D<'Units, 'Coordinates>` Returns: `Circle2D<'Units, 'Coordinates>`