LuciadCPillar 2024.0.04
luciad::CircularArcByBulge Class Referencefinal

A circular arc defined by a start point, end point and a bulge factor. More...

#include <luciad/geometries/CircularArcByBulge.h>

Inheritance diagram for luciad::CircularArcByBulge:
luciad::Curve luciad::Geometry

Public Member Functions

 ~CircularArcByBulge () 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...
 
double getBulge () const
 Returns the bulge factor of this arc. More...
 
luciad::Coordinate getEndPoint () const
 Returns the end point of this arc. 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...
 
luciad::Coordinate getStartPoint () const
 Returns the start point of this arc. 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 circular arc defined by a start point, end point and a bulge factor.

See also
GeometryFactory::createCircularArcByBulge

Constructor & Destructor Documentation

◆ ~CircularArcByBulge()

luciad::CircularArcByBulge::~CircularArcByBulge ( )
override

Member Function Documentation

◆ computePoint()

luciad::Coordinate luciad::CircularArcByBulge::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::CircularArcByBulge::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.

◆ getBulge()

double luciad::CircularArcByBulge::getBulge ( ) const

Returns the bulge factor of this arc.

The bulge factor is the ratio of (1) the distance between the arc midpoint and the center of the arc's chord, and (2) half the length of the arc's chord. The sign of the bulge indicates whether the midpoint is on the left side (positive) or right side (negative) of the vector from start to end point. So a bulge factor with an absolute value of 1 means a half-circle, smaller than 1 means a less bulging arc and larger than 1 means an arc that bulges out in the start and end point.

Returns
the bulge factor of this arc.

◆ getEndPoint()

luciad::Coordinate luciad::CircularArcByBulge::getEndPoint ( ) const

Returns the end point of this arc.

Returns
the end point of this arc.

◆ getHash()

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

Returns the hash value for this geometry.

Returns
the hash value for this geometry.

Implements luciad::Geometry.

◆ getLength2D()

double luciad::CircularArcByBulge::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::CircularArcByBulge::getReference ( ) const
overridevirtual

Returns the coordinate reference of the geometry.

Returns
the coordinate reference of the geometry.

Implements luciad::Geometry.

◆ getStartPoint()

luciad::Coordinate luciad::CircularArcByBulge::getStartPoint ( ) const

Returns the start point of this arc.

Returns
the start point of this arc.