Getting started

Class TBGRAPathCursor

Description
Hierarchy
Fields
Methods
Properties

Unit

BGRAPath

Declaration

type TBGRAPathCursor = class(TBGRACustomPathCursor)

Description

Cursor to determine position along a path

Hierarchy

Overview

Fields

Protected FAcceptedDeviation: single;
Protected FArcPos: Single;
Protected FBounds: TRectF;
Protected FBoundsComputed: boolean;
Protected FCurrentElement: Pointer;
Protected FCurrentElementArcPos: single;
Protected FCurrentElementArcPosScale: single;
Protected FCurrentElementEndCoord: TPointF;
Protected FCurrentElementLength: single;
Protected FCurrentElementPoints: array of TPointF;
Protected FCurrentElementStartCoord: TPointF;
Protected FCurrentElementType: TBGRAPathElementType;
Protected FCurrentSegment: Int32or64;
Protected FCurrentSegmentPos: single;
Protected FDataPos: IntPtr;
Protected FEndCoordinate: TPointF;
Protected FLoopClosedShapes: boolean;
Protected FLoopPath: boolean;
Protected FPath: TBGRAPath;
Protected FPathLength: single;
Protected FPathLengthComputed: boolean;
Protected FStartCoordinate: TPointF;

Methods

Public constructor Create(APath: TBGRAPath; AAcceptedDeviation: single = DefaultDeviation);
Public destructor Destroy; override;
Public function MoveBackward(ADistance: single; ACanJump: boolean = true): single; override;
Public function MoveForward(ADistance: single; ACanJump: boolean = true): single; override;
Protected function GetArcPos: single; override;
Protected function GetBounds: TRectF; override;
Protected function GetCurrentCoord: TPointF; override;
Protected function GetCurrentTangent: TPointF; override;
Protected function GetLoopClosedShapes: boolean; override;
Protected function GetLoopPath: boolean; override;
Protected function GetPath: TBGRAPath; virtual;
Protected function GetPathLength: single; override;
Protected function GetStartCoordinate: TPointF; override;
Protected function GoToNextElement(ACanJump: boolean): boolean;
Protected function GoToPreviousElement(ACanJump: boolean): boolean;
Protected function NeedPolygonalApprox: boolean;
Protected procedure MoveBackwardInElement(ADistance: single);
Protected procedure MoveForwardInElement(ADistance: single);
Protected procedure MoveToEndOfElement;
Protected procedure OnPathFree; virtual;
Protected procedure PrepareCurrentElement; virtual;
Protected procedure SetArcPos(AValue: single); override;
Protected procedure SetLoopClosedShapes(AValue: boolean); override;
Protected procedure SetLoopPath(AValue: boolean); override;

Properties

Public property AcceptedDeviation: single read FAcceptedDeviation;
Public property Bounds: TRectF read GetBounds;
Public property CurrentCoordinate: TPointF read GetCurrentCoord;
Public property CurrentTangent: TPointF read GetCurrentTangent;
Public property LoopClosedShapes: boolean read GetLoopClosedShapes write SetLoopClosedShapes;
Public property LoopPath: boolean read GetLoopPath write SetLoopPath;
Public property Path: TBGRAPath read GetPath;
Public property PathLength: single read GetPathLength;
Public property Position: single read GetArcPos write SetArcPos;
Public property StartCoordinate: TPointF read GetStartCoordinate;

Description

Fields

Protected FAcceptedDeviation: single;

This item has no description.

Protected FArcPos: Single;

This item has no description.

Protected FBounds: TRectF;

This item has no description.

Protected FBoundsComputed: boolean;

This item has no description.

Protected FCurrentElement: Pointer;

This item has no description.

Protected FCurrentElementArcPos: single;

This item has no description.

Protected FCurrentElementArcPosScale: single;

This item has no description.

Protected FCurrentElementEndCoord: TPointF;

This item has no description.

Protected FCurrentElementLength: single;

This item has no description.

Protected FCurrentElementPoints: array of TPointF;

This item has no description.

Protected FCurrentElementStartCoord: TPointF;

This item has no description.

Protected FCurrentElementType: TBGRAPathElementType;

This item has no description.

Protected FCurrentSegment: Int32or64;

This item has no description.

Protected FCurrentSegmentPos: single;

This item has no description.

Protected FDataPos: IntPtr;

This item has no description.

Protected FEndCoordinate: TPointF;

This item has no description.

Protected FLoopClosedShapes: boolean;

This item has no description.

Protected FLoopPath: boolean;

This item has no description.

Protected FPath: TBGRAPath;

This item has no description.

Protected FPathLength: single;

This item has no description.

Protected FPathLengthComputed: boolean;

This item has no description.

Protected FStartCoordinate: TPointF;

This item has no description.

Methods

Public constructor Create(APath: TBGRAPath; AAcceptedDeviation: single = DefaultDeviation);

This item has no description.

Public destructor Destroy; override;

This item has no description.

Public function MoveBackward(ADistance: single; ACanJump: boolean = true): single; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.MoveBackward.

Go backward, decreasing the value of Position. If ADistance is negative, then it goes forward instead. ACanJump specifies if the cursor can jump from one shape to another without a line or an arc. Otherwise, the cursor is stuck, and the return value is less than the value ADistance provided. If all the way has been travelled, the return value is equal to ADistance

Public function MoveForward(ADistance: single; ACanJump: boolean = true): single; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.MoveForward.

Go forward in the path, increasing the value of Position. If ADistance is negative, then it goes backward instead. ACanJump specifies if the cursor can jump from one shape to another without a line or an arc. Otherwise, the cursor is stuck, and the return value is less than the value ADistance provided. If all the way has been travelled, the return value is equal to ADistance

Protected function GetArcPos: single; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.GetArcPos.

Retrieves the current position from the start

Protected function GetBounds: TRectF; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.GetBounds.

Compute the bounds of the path

Protected function GetCurrentCoord: TPointF; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.GetCurrentCoord.

Returns the current coordinate in the path

Protected function GetCurrentTangent: TPointF; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.GetCurrentTangent.

Returns the tangent vector to the current position

Protected function GetLoopClosedShapes: boolean; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.GetLoopClosedShapes.

Retrieves if the cursor loops when there is a closed shape

Protected function GetLoopPath: boolean; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.GetLoopPath.

Retrieves if the cursor loops at the end of the whole path

Protected function GetPath: TBGRAPath; virtual;

This item has no description.

Protected function GetPathLength: single; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.GetPathLength.

Retreive the full arc length of the path

Protected function GetStartCoordinate: TPointF; override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.GetStartCoordinate.

Starting coordinate of the path

Protected function GoToNextElement(ACanJump: boolean): boolean;

This item has no description.

Protected function GoToPreviousElement(ACanJump: boolean): boolean;

This item has no description.

Protected function NeedPolygonalApprox: boolean;

This item has no description.

Protected procedure MoveBackwardInElement(ADistance: single);

This item has no description.

Protected procedure MoveForwardInElement(ADistance: single);

This item has no description.

Protected procedure MoveToEndOfElement;

This item has no description.

Protected procedure OnPathFree; virtual;

This item has no description.

Protected procedure PrepareCurrentElement; virtual;

This item has no description.

Protected procedure SetArcPos(AValue: single); override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.SetArcPos.

Sets the current position from the start

Protected procedure SetLoopClosedShapes(AValue: boolean); override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.SetLoopClosedShapes.

Sets if the cursor loops when there is a closed shape

Protected procedure SetLoopPath(AValue: boolean); override;

This item has no description. Showing description inherited from TBGRACustomPathCursor.SetLoopPath.

Sets if the cursor loops at the end of the whole path

Properties

Public property AcceptedDeviation: single read FAcceptedDeviation;

This item has no description.

Public property Bounds: TRectF read GetBounds;

This item has no description.

Public property CurrentCoordinate: TPointF read GetCurrentCoord;

This item has no description.

Public property CurrentTangent: TPointF read GetCurrentTangent;

This item has no description.

Public property LoopClosedShapes: boolean read GetLoopClosedShapes write SetLoopClosedShapes;

This item has no description.

Public property LoopPath: boolean read GetLoopPath write SetLoopPath;

This item has no description.

Public property Path: TBGRAPath read GetPath;

This item has no description.

Public property PathLength: single read GetPathLength;

This item has no description.

Public property Position: single read GetArcPos write SetArcPos;

This item has no description.

Public property StartCoordinate: TPointF read GetStartCoordinate;

This item has no description.