CartoType C++ API 7.8.2, 2022-03-25
for Windows, Linux, Qt and other platforms supporting C++ development
Public Member Functions | Static Public Member Functions | List of all members
CartoType::CContour Class Reference

#include <cartotype_path.h>

Inheritance diagram for CartoType::CContour:
CartoType::CContourBase< TOutlinePoint > CartoType::MWritableContour CartoType::MContour CartoType::MPath

Public Member Functions

 CContour (const MContour &aContour)
 
CContouroperator= (const MContour &aContour)
 
bool MayHaveCurves () const override
 
TPointPointData () override
 
TOutlinePointOutlinePointData () override
 
const TOutlinePointOutlinePointData () const
 
void AppendPoint (const TOutlinePoint &aPoint) override
 
void AppendPoint (double aX, double aY, TPointType aPointType=TPointType::OnCurve)
 
void AppendTransformedPoint64ths (const TTransform &aTransform, const TPointFP &aPoint, TPointType aPointType)
 
void AppendPoint64ths (const TPointFP &aPoint, TPointType aPointType)
 
void MakeCircle (double aX, double aY, double aRadius)
 
void MakePolygon (double aX, double aY, double aRadius, int32_t aSides)
 
void MakeRoundedRectangle (double aX1, double aY1, double aX2, double aY2, double aWidth, double aRadius)
 
- Public Member Functions inherited from CartoType::CContourBase< TOutlinePoint >
size_t Contours () const override
 
TContour Contour (size_t) const override
 
size_t Points () const override
 
TOutlinePoint Point (size_t aIndex) const override
 
bool Closed () const override
 
void SetPoint (size_t aIndex, const TOutlinePoint &aPoint) override
 
void ReduceSizeTo (size_t aPoints) override
 
void SetSize (size_t aSize) override
 
void SetClosed (bool aClosed) override
 
void AppendPoint (const TOutlinePoint &aPoint) override=0
 
void AppendPoint (double aX, double aY)
 
void AppendPointEvenIfSame (const TOutlinePoint &aPoint)
 
void AppendPoints (const TOutlinePoint *aPoint, size_t aPoints)
 
void InsertPoint (const TOutlinePoint &aPoint, size_t aIndex)
 
void InsertPoints (const TOutlinePoint *aPoint, size_t aPoints, size_t aIndex)
 
void Clear ()
 
void SetSizeToZero ()
 
void RemovePoint (size_t aIndex)
 
void RemovePoints (size_t aIndex, size_t aCount)
 
void Offset (int32_t aDx, int32_t aDy)
 
void ReservePoints (size_t aCount)
 
void Reverse ()
 
vector_t::iterator begin ()
 
vector_t::const_iterator begin () const
 
vector_t::iterator end ()
 
vector_t::const_iterator end () const
 
- Public Member Functions inherited from CartoType::MWritableContour
MWritableContouroperator= (const MContour &aContour)
 
virtual void SetPoint (size_t aIndex, const TOutlinePoint &aPoint)=0
 
virtual void ReduceSizeTo (size_t aPoints)=0
 
virtual void SetSize (size_t aPoints)=0
 
virtual void SetClosed (bool aClosed)=0
 
virtual void AppendPoint (const TOutlinePoint &aPoint)=0
 
virtual TOutlinePointOutlinePointData ()=0
 
virtual TPointPointData ()=0
 
void Offset (int32_t aDx, int32_t aDy)
 
void AppendContour (const TContour &aContour)
 
void SetLastPoint (const TOutlinePoint &aPoint)
 
void Simplify (double aResolutionArea)
 
void AppendCircularArc (const TPoint &aCenter, const TPoint &aStart, const TPoint &aEnd, TEllipseAngleType aAngleType=TEllipseAngleType::Shortest, bool aAppendStart=false)
 
void AppendHalfCircle (const TPoint &aCenter, const TPoint &aStart, const TPoint &aEnd, TEllipseAngleType aAngleType=TEllipseAngleType::Shortest, bool aAppendStart=false)
 
void AppendHalfCircle (double aCx, double aCy, double aSx, double aSy, double aEx, double aEy, double aRadius, bool aAppendStart, bool aIsExactHalfCircle, bool aClockwise)
 
void AppendQuadrant (double aCx, double aCy, double aSx, double aSy, double aEx, double aEy, double aRadius, bool aAppendStart, bool aIsExactQuadrant, bool aClockwise)
 
- Public Member Functions inherited from CartoType::MContour
virtual size_t Points () const =0
 
virtual TOutlinePoint Point (size_t aIndex) const =0
 
virtual bool Closed () const =0
 
 operator TContour () const
 
size_t Contours () const
 
TOutlinePoint LastPoint () const
 
TOutlinePoint FractionalPoint (double aIndex) const
 
bool IsGridOrientedRectangle (TRect *aRect=nullptr) const
 
bool Anticlockwise () const
 
bool Contains (double aX, double aY) const
 
bool Contains (const TPoint &aPoint) const
 
COutline ClippedContour (const TRect &aClip) const
 
void AppendClippedContour (COutline &aDest, const TRect &aClip) const
 
size_t AppendSplitContour (COutline &aDest, const TPointFP &aLineStart, const TPointFP &aLineVector)
 
CContour TruncatedContour (double aStart, double aEnd) const
 
CContour SubContourBetweenFractionalPoints (double aStartIndex, double aEndIndex) const
 
CContour SubContourBetweenNearestPoints (const TPointFP *aStartPoint, const TPointFP *aEndPoint) const
 
CContour CentralPath (std::shared_ptr< CEngine > aEngine, const TRect &aClip, bool aFractionalPixels, TLine &aFallbackLine, bool aFallbackMustBeHorizontal) const
 
CContour Smooth (double aRadius) const
 
bool MayIntersect (const TRect &aRect) const
 
bool Intersects (const TRect &aRect) const
 
TPathIntersectionType IntersectionType (const MContour &aOther, double *aDistance=nullptr, TPointFP *aNearest1=nullptr, TPointFP *aNearest2=nullptr) const
 
TPathIntersectionInfo IntersectionInfo (const MContour &aOther) const
 
double DistanceFrom (const MContour &aOther, TPointFP *aNearest1=nullptr, TPointFP *aNearest2=nullptr, TPathIntersectionType *aType=nullptr) const
 
double DistanceFromPoint (const TPointFP &aPoint, TPointFP *aNearest=nullptr, double *aNearestLength=nullptr, bool *aLeft=nullptr, size_t *aLineIndex=nullptr, double *aFractionalLineIndex=nullptr, bool aTreatAsOpen=false) const
 
TPointFP PointAtLength (double aLength, double aOffset=0, int32_t *aLineIndex=nullptr) const
 
void GetOrientation (const TPoint &aCenter, TPoint &aOrientation) const
 
void GetPrincipalAxis (TPointFP &aCenter, TPointFP &aVector) const
 
void Write (TDataOutputStream &aOutput) const
 
void GetAngles (double aDistance, double &aStartAngle, double &aEndAngle)
 
- Public Member Functions inherited from CartoType::MPath
virtual ~MPath ()
 
virtual size_t Contours () const =0
 
virtual TContour Contour (size_t aIndex) const =0
 
virtual bool MayHaveCurves () const =0
 
template<class MPathTraverser >
void Traverse (MPathTraverser &aTraverser, const TRect &aClip) const
 
template<class MPathTraverser >
void Traverse (MPathTraverser &aTraverser, const TRect *aClip=nullptr) const
 
bool operator== (const MPath &aOther) const
 
TRect CBox () const
 
bool CBoxBiggerThan (int32_t aSize) const
 
bool IsContainedIn (const TRect &aRect) const
 
bool Contains (double aX, double aY) const
 
bool Contains (const TPoint &aPoint) const
 
bool Contains (const TPointFP &aPoint) const
 
bool MayIntersect (const TRect &aRect) const
 
bool MayIntersect (const TRect &aRect, int32_t aBorder) const
 
bool Intersects (const TRect &aRect) const
 
bool Intersects (const MPath &aPath, const TRect *aBounds=nullptr) const
 
int32_t MaxDistanceFromOrigin () const
 
TPathIntersectionType IntersectionType (const MPath &aOther, double *aDistance=nullptr, TPointFP *aNearest1=nullptr, TPointFP *aNearest2=nullptr) const
 
TPathIntersectionInfo IntersectionInfo (const MPath &aOther) const
 
double DistanceFrom (const MPath &aOther, TPointFP *aNearest1=nullptr, TPointFP *aNearest2=nullptr, TPathIntersectionType *aType=nullptr) const
 
double DistanceFromPoint (const TPointFP &aPoint, TPointFP *aNearest=nullptr, size_t *aContourIndex=nullptr, size_t *aLineIndex=nullptr, double *aFractionaLineIndex=nullptr, bool aTreatAsOpen=false) const
 
bool IsClippingNeeded (const TRect &aClip) const
 
COutline Copy () const
 
COutline ClippedPath (const TRect &aClip) const
 
COutline ClippedPath (const MPath &aClip) const
 
COutline ClippedPath (const TClipRegion &aClip) const
 
COutline Clip (TClipOperation aClipOperation, const MPath &aClip) const
 
COutline Envelope (double aOffset) const
 
bool IsSmoothingNeeded () const
 
COutline SmoothPath () const
 
COutline FlatPath (double aMaxDistance) const
 
COutline TruncatedPath (double aStart, double aEnd) const
 
COutline OffsetPath (double aOffset) const
 
COutline TransformedPath (const TTransform &aTransform) const
 
COutline TransformedPath (TDrawResult &aError, MPointTransformer &aTransformer, int32_t aFractionalBits) const
 
std::array< TLine, 3 > GetHorizontalPaths (int32_t aPathLength, int32_t aLabelHeight, const TPointFP &aUpVector, const TRect *aBounds, const TRect *aClip) const
 
TPointFP CenterOfGravity () const
 
void GetCenterOfGravity (TPoint &aCenter) const
 
double Length () const
 
double Area () const
 
TPointFP PointAtLength (double aPos) const
 
std::pair< TPoint, bool > End () const
 
void Write (TDataOutputStream &aOutput) const
 
bool IsEmpty () const
 
bool IsPoint () const
 
bool IsGridOrientedRectangle (TRect *aRect=nullptr) const
 
void GetSphericalAreaAndLength (const CProjection &aProjection, double *aArea, double *aLength) const
 
TClipType ClipType (const TRect &aRect) const
 
bool HasCurves () const
 
ConstIter begin () const
 
ConstIter end () const
 

Static Public Member Functions

static CContour RoundedRectangle (const TPoint &aTopLeft, double aWidth, double aHeight, double aRX, double aRY)
 
static CContour Rectangle (const TPoint &aTopLeft, double aWidth, double aHeight)
 
static CContour Read (TDataInputStream &aInput)
 

Additional Inherited Members

- Public Types inherited from CartoType::CContourBase< TOutlinePoint >
using vector_t = std::vector< TOutlinePoint >
 
- Protected Attributes inherited from CartoType::CContourBase< TOutlinePoint >
vector_t iPoint
 
bool iClosed
 

Detailed Description

A contour consisting of owned points with integer coordinates, which may be on-curve or off-curve. Off-curve points are control points for quadratic or cubic spline curves. A contour may be open or closed.

Constructor & Destructor Documentation

◆ CContour()

CartoType::CContour::CContour ( const MContour aContour)
inlineexplicit

Creates a contour by copying another contour.

Member Function Documentation

◆ AppendPoint() [1/2]

void CartoType::CContour::AppendPoint ( const TOutlinePoint aPoint)
inlineoverridevirtual

Appends a point to the contour, but only if it differs from the previous point or is a control point.

Implements CartoType::CContourBase< TOutlinePoint >.

◆ AppendPoint() [2/2]

void CartoType::CContour::AppendPoint ( double  aX,
double  aY,
TPointType  aPointType = TPointType::OnCurve 
)
inline

Appends a point to the contour whether or not it differs from the previous point.

◆ AppendPoint64ths()

void CartoType::CContour::AppendPoint64ths ( const TPointFP aPoint,
TPointType  aPointType 
)
inline

Converts a point from floating-point to point in 64ths and appends it.

◆ AppendTransformedPoint64ths()

void CartoType::CContour::AppendTransformedPoint64ths ( const TTransform aTransform,
const TPointFP aPoint,
TPointType  aPointType 
)

Applies a transform to a point, converts it from floating-point to 64ths, and appends it.

◆ MakeCircle()

void CartoType::CContour::MakeCircle ( double  aX,
double  aY,
double  aRadius 
)

Set the contour to a circle with the center (aX,aY) and the radius aRadius.

◆ MakePolygon()

void CartoType::CContour::MakePolygon ( double  aX,
double  aY,
double  aRadius,
int32_t  aSides 
)

Set the contour to a regular polygon with a certain number of sides, which must be at least 3.

◆ MakeRoundedRectangle()

void CartoType::CContour::MakeRoundedRectangle ( double  aX1,
double  aY1,
double  aX2,
double  aY2,
double  aWidth,
double  aRadius 
)

Set the contour to a rounded rectangle based on a stroke of width aWidth from (aX1,aY1) to (aX2,aY2) with corners of radius aRadius.

A radius of less than zero is treated as zero, as is a width of less than zero. The maximum radius is the minimum of half aWidth and half the distance between the two points.

◆ MayHaveCurves()

bool CartoType::CContour::MayHaveCurves ( ) const
inlineoverridevirtual

Returns true if the path may have off-curve points.

Implements CartoType::MPath.

◆ operator=()

CContour & CartoType::CContour::operator= ( const MContour aContour)
inline

The assignment operator.

◆ OutlinePointData() [1/2]

const TOutlinePoint * CartoType::CContour::OutlinePointData ( ) const
inline

Returns a constant pointer to the start of the points.

◆ OutlinePointData() [2/2]

TOutlinePoint * CartoType::CContour::OutlinePointData ( )
inlineoverridevirtual

Returns a writable pointer to TOutlinePoint data if possible.

Implements CartoType::MWritableContour.

◆ PointData()

TPoint * CartoType::CContour::PointData ( )
inlineoverridevirtual

Returns a writable pointer to TPoint data if possible.

Implements CartoType::MWritableContour.

◆ Read()

CContour CartoType::CContour::Read ( TDataInputStream aInput)
static

Reads a serialized contour from a stream.

◆ Rectangle()

CContour CartoType::CContour::Rectangle ( const TPoint aTopLeft,
double  aWidth,
double  aHeight 
)
static

Create a contour that is a rectangle. The top left corner is specified in 64ths of pixels.

◆ RoundedRectangle()

CContour CartoType::CContour::RoundedRectangle ( const TPoint aTopLeft,
double  aWidth,
double  aHeight,
double  aRX,
double  aRY 
)
static

Create a contour that is a rounded rectangle. The top left corner is specified in 64ths of pixels.


The documentation for this class was generated from the following files: