LuciadCPillar 2024.0.08
luciad::CircleBy3Points Class Referencefinal

A circle that is defined by a start point, a first intermediate point, and a second intermediate point on the circle. More...

#include <luciad/geometries/CircleBy3Points.h>

Inheritance diagram for luciad::CircleBy3Points:
luciad::Ring luciad::Curve luciad::Geometry

Public Member Functions

 ~CircleBy3Points () override
 
luciad::Coordinate computePoint (double parameter) const override
 Computes a point of the curve, defined by the given parameter. More...
 
Bounds getBounds () const override
 Returns the bounds for the geometry object. More...
 
Coordinate getFirstIntermediatePoint () const
 Returns the first intermediate point of this circle-by-3-points. More...
 
double getLength2D () const override
 Returns the length of the curve. More...
 
std::shared_ptr< luciad::CoordinateReferencegetReference () const override
 Returns the coordinate reference of the geometry. More...
 
Coordinate getSecondIntermediatePoint () const
 Returns the second intermediate point of this circle-by-3-points. More...
 
Coordinate getStartPoint () const
 Returns the start point of this circle-by-3-points. More...
 
virtual Coordinate computePoint (double parameter) const =0
 Computes a point of the curve, defined by the given parameter. More...
 
virtual double getLength2D () const =0
 Returns the length of the curve. More...
 
- Public Member Functions inherited from luciad::Geometry
virtual ~Geometry ()=default
 
virtual Bounds getBounds () const =0
 Returns the bounds for the geometry object. More...
 
virtual std::shared_ptr< CoordinateReferencegetReference () const =0
 Returns the coordinate reference of the geometry. More...
 

Protected Member Functions

size_t getHash () const override
 Returns the hash value for this geometry. More...
 
virtual size_t getHash () const =0
 Returns the hash value for this geometry. More...
 

Detailed Description

A circle that is defined by a start point, a first intermediate point, and a second intermediate point on the circle.

A circle by-3-points where the three points coincide represents a circle with these points as its center and a radius of 0.

A circle by-3-points where 2 out of 3 points coincide represents a circle with its center located in the middle between the 2 coinciding points and the other point.

See also
GeometryFactory::createCircleBy3Points

Constructor & Destructor Documentation

◆ ~CircleBy3Points()

luciad::CircleBy3Points::~CircleBy3Points ( )
override

Member Function Documentation

◆ computePoint()

luciad::Coordinate luciad::CircleBy3Points::computePoint ( double  parameter) const
overridevirtual

Computes a point of the curve, defined by the given parameter.

  1. At parameter 0, the point is the start point of the curve.
  2. At parameter 1, the point is the end point of the curve.
Parameters
parameterthe parameter value, within [0,1], to compute the point location for.
Returns
the computed point location.
Exceptions
luciad::InvalidArgumentExceptionif parameter is not within [0,1], or if the point could not be computed. For example, when the curve is defined by invalid points.

Implements luciad::Curve.

◆ getBounds()

Bounds luciad::CircleBy3Points::getBounds ( ) const
overridevirtual

Returns the bounds for the geometry object.

Returns
the bounds for the geometry object.
Exceptions
luciad::InvalidArgumentExceptionif the bounds could not be computed. For example, when the geometry is defined by invalid points.

Implements luciad::Geometry.

◆ getFirstIntermediatePoint()

Coordinate luciad::CircleBy3Points::getFirstIntermediatePoint ( ) const

Returns the first intermediate point of this circle-by-3-points.

Returns
the first intermediate point of this circle-by-3-points.

◆ getHash()

size_t luciad::CircleBy3Points::getHash ( ) const
overrideprotectedvirtual

Returns the hash value for this geometry.

Returns
the hash value for this geometry.

Implements luciad::Geometry.

◆ getLength2D()

double luciad::CircleBy3Points::getLength2D ( ) const
overridevirtual

Returns the length of the curve.

Returns
the length of the curve.
Exceptions
luciad::InvalidArgumentExceptionif the length could not be computed. For example, when the curve is defined by invalid points.

Implements luciad::Curve.

◆ getReference()

std::shared_ptr< luciad::CoordinateReference > luciad::CircleBy3Points::getReference ( ) const
overridevirtual

Returns the coordinate reference of the geometry.

Returns
the coordinate reference of the geometry.

Implements luciad::Geometry.

◆ getSecondIntermediatePoint()

Coordinate luciad::CircleBy3Points::getSecondIntermediatePoint ( ) const

Returns the second intermediate point of this circle-by-3-points.

Returns
the second intermediate point of this circle-by-3-points.

◆ getStartPoint()

Coordinate luciad::CircleBy3Points::getStartPoint ( ) const

Returns the start point of this circle-by-3-points.

Returns
the start point of this circle-by-3-points.