LuciadCPillar C# 2024.0.08
Luciad.Geometries.Constraints.IPolylineConstraint Interface Reference

A constraint on Polyline editing. More...

Public Member Functions

Luciad.Geometries.Polyline Apply (Luciad.Geometries.Polyline oldPolyline, Luciad.Geometries.Polyline newPolyline, Luciad.Geometries.Constraints.PolylineChange changes)
 Applies this constraint on a pending change. More...
 
Luciad.Geometries.Polyline Apply (Luciad.Geometries.Polyline polyline)
 Applies this constraint on a polyline without a (known) change. More...
 

Detailed Description

A constraint on Polyline editing.

This can for example be configured on a PolylineHandlesProvider.

Since
2020.1

Member Function Documentation

◆ Apply() [1/2]

Luciad.Geometries.Polyline Luciad.Geometries.Constraints.IPolylineConstraint.Apply ( Luciad.Geometries.Polyline  oldPolyline,
Luciad.Geometries.Polyline  newPolyline,
Luciad.Geometries.Constraints.PolylineChange  changes 
)

Applies this constraint on a pending change.

Parameters
oldPolylinethe base polyline on which the change is performed, cannot be null.
newPolylinethe result of the change, without any constraints applied, cannot be null.
changesthe change that was applied.
Returns
the resulting polyline, after applying this constraint on the pending change. If the constraint does not apply, simply return the newPolyline. Cannot be null.

◆ Apply() [2/2]

Luciad.Geometries.Polyline Luciad.Geometries.Constraints.IPolylineConstraint.Apply ( Luciad.Geometries.Polyline  polyline)

Applies this constraint on a polyline without a (known) change.

Parameters
polylinethe polyline to constrain, cannot be null.
Returns
the resulting polyline, after applying this constraint. If the constraint does not apply, simply return the polyline. Cannot be null.