LuciadCPillar 2024.0.04
luciad::ArcBand Class Referencefinal

Represents an arc band. More...

#include <luciad/geometries/ArcBand.h>

Inheritance diagram for luciad::ArcBand:
luciad::CompositeRing luciad::Ring luciad::Curve luciad::Geometry

Public Member Functions

 ~ArcBand () override
 
Coordinate computePoint (double parameter) const override
 Computes a point of the curve, defined by the given parameter. More...
 
Angle::Direction getAngleDirection () const
 Returns the orientation of the arc band. More...
 
Bounds getBounds () const override
 Returns the bounds for the geometry object. More...
 
Coordinate getCenter () const
 Returns the center point of the arc band. More...
 
std::shared_ptr< CurvegetCurveAt (size_t index) const override
 Returns the curve for the requested index. More...
 
size_t getCurveCount () const override
 Returns the number of curves in this composite. More...
 
Angle getEndAngle () const
 Returns the end angle of the arc. More...
 
std::shared_ptr< LinegetEndAngleLine () const
 Returns the end angle line of the arc band, going from the maximum radius to the minimum radius. More...
 
double getLength2D () const override
 Returns the length of the curve. More...
 
double getMaximumRadius () const
 Returns the maximum radius of this arc band. More...
 
std::shared_ptr< CircularArcByCenterPointgetMaximumRadiusArc () const
 Returns the maximum radius arc of the arc band, going from the start angle to the end angle, along the angle direction. More...
 
double getMinimumRadius () const
 Returns the minimum radius of this arc band. More...
 
std::shared_ptr< CircularArcByCenterPointgetMinimumRadiusArc () const
 Returns the minimum radius arc of the arc band, going from the end angle to the start angle, contrary to the angle direction. More...
 
std::shared_ptr< luciad::CoordinateReferencegetReference () const override
 Returns the coordinate reference of the geometry. More...
 
Angle getStartAngle () const
 Returns the start angle of the arc. More...
 
std::shared_ptr< LinegetStartAngleLine () const
 Returns the start angle line of the arc band, going from the minimum radius to the maximum radius. More...
 
- Public Member Functions inherited from luciad::CompositeRing
 ~CompositeRing () override
 
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...
 
virtual std::shared_ptr< CurvegetCurveAt (size_t index) const
 Returns the curve for the requested index. More...
 
virtual size_t getCurveCount () const
 Returns the number of curves in this composite. More...
 
double getLength2D () const override
 Returns the length of the curve. More...
 
std::shared_ptr< CoordinateReferencegetReference () const override
 Returns the coordinate reference of the geometry. 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...
 
- Protected Member Functions inherited from luciad::CompositeRing
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

Represents an arc band.

See also
GeometryFactory::createArcBand

Constructor & Destructor Documentation

◆ ~ArcBand()

luciad::ArcBand::~ArcBand ( )
override

Member Function Documentation

◆ computePoint()

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

◆ getAngleDirection()

Angle::Direction luciad::ArcBand::getAngleDirection ( ) const

Returns the orientation of the arc band.

This property determines in which direction the arc band extends from the start to the end angle.

Returns
orientation of the arc band.
Since
2020.1

◆ getBounds()

Bounds luciad::ArcBand::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.

◆ getCenter()

Coordinate luciad::ArcBand::getCenter ( ) const

Returns the center point of the arc band.

Returns
the center point of the arc band.

◆ getCurveAt()

std::shared_ptr< Curve > luciad::ArcBand::getCurveAt ( size_t  index) const
overridevirtual

Returns the curve for the requested index.

Parameters
indexthe curve index
Returns
the curve at index
See also
getCurveCount
Exceptions
luciad::InvalidArgumentExceptionwhen requesting an invalid index.

Reimplemented from luciad::CompositeRing.

◆ getCurveCount()

size_t luciad::ArcBand::getCurveCount ( ) const
overridevirtual

Returns the number of curves in this composite.

Returns
the number of curves in this composite.
See also
getCurveAt

Reimplemented from luciad::CompositeRing.

◆ getEndAngle()

Angle luciad::ArcBand::getEndAngle ( ) const

Returns the end angle of the arc.

Returns
the end angle of the arc.

◆ getEndAngleLine()

std::shared_ptr< Line > luciad::ArcBand::getEndAngleLine ( ) const

Returns the end angle line of the arc band, going from the maximum radius to the minimum radius.

Returns
the end angle line of the arc band, going from the maximum radius to the minimum radius
Since
2020.1

◆ getHash()

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

Returns the hash value for this geometry.

Returns
the hash value for this geometry.

Implements luciad::Geometry.

◆ getLength2D()

double luciad::ArcBand::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.

◆ getMaximumRadius()

double luciad::ArcBand::getMaximumRadius ( ) const

Returns the maximum radius of this arc band.

Returns
the maximum radius of this arc band.

◆ getMaximumRadiusArc()

std::shared_ptr< CircularArcByCenterPoint > luciad::ArcBand::getMaximumRadiusArc ( ) const

Returns the maximum radius arc of the arc band, going from the start angle to the end angle, along the angle direction.

Returns
the maximum radius arc of the arc band.
Since
2020.1

◆ getMinimumRadius()

double luciad::ArcBand::getMinimumRadius ( ) const

Returns the minimum radius of this arc band.

Returns
the minimum radius of this arc band.

◆ getMinimumRadiusArc()

std::shared_ptr< CircularArcByCenterPoint > luciad::ArcBand::getMinimumRadiusArc ( ) const

Returns the minimum radius arc of the arc band, going from the end angle to the start angle, contrary to the angle direction.

Returns
the minimum radius arc of the arc band.
Since
2020.1

◆ getReference()

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

Returns the coordinate reference of the geometry.

Returns
the coordinate reference of the geometry.

Implements luciad::Geometry.

◆ getStartAngle()

Angle luciad::ArcBand::getStartAngle ( ) const

Returns the start angle of the arc.

Returns
the start angle of the arc.

◆ getStartAngleLine()

std::shared_ptr< Line > luciad::ArcBand::getStartAngleLine ( ) const

Returns the start angle line of the arc band, going from the minimum radius to the maximum radius.

Returns
the start angle line of the arc band, going from the minimum radius to the maximum radius
Since
2020.1