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

A constraint on PolylineRing. More...

Public Member Functions

Luciad.Geometries.PolylineRing Apply (Luciad.Geometries.PolylineRing oldPolylineRing, Luciad.Geometries.PolylineRing newPolylineRing, Luciad.Geometries.Constraints.PolylineChange changes)
 Applies this constraint on a pending change. More...
 
Luciad.Geometries.PolylineRing Apply (Luciad.Geometries.PolylineRing polylineRing)
 Applies this constraint on a polyline ring without a (known) change. More...
 

Detailed Description

A constraint on PolylineRing.

This can be configured on a PolylineRingHandlesProvider.

Since
2020.1

Member Function Documentation

◆ Apply() [1/2]

Luciad.Geometries.PolylineRing Luciad.Geometries.Constraints.IPolylineRingConstraint.Apply ( Luciad.Geometries.PolylineRing  oldPolylineRing,
Luciad.Geometries.PolylineRing  newPolylineRing,
Luciad.Geometries.Constraints.PolylineChange  changes 
)

Applies this constraint on a pending change.

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

◆ Apply() [2/2]

Luciad.Geometries.PolylineRing Luciad.Geometries.Constraints.IPolylineRingConstraint.Apply ( Luciad.Geometries.PolylineRing  polylineRing)

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

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