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

A constraint on Point editing. More...

Public Member Functions

Luciad.Geometries.Point Apply (Luciad.Geometries.Point oldPoint, Luciad.Geometries.Point newPoint, Luciad.Geometries.Constraints.PointChange change)
 Applies this constraint on a pending change. More...
 
Luciad.Geometries.Point Apply (Luciad.Geometries.Point point)
 Applies this constraint on a point without a (known) change. More...
 

Detailed Description

A constraint on Point editing.

This can for example be configured on a PointHandlesProvider.

Since
2020.1

Member Function Documentation

◆ Apply() [1/2]

Luciad.Geometries.Point Luciad.Geometries.Constraints.IPointConstraint.Apply ( Luciad.Geometries.Point  oldPoint,
Luciad.Geometries.Point  newPoint,
Luciad.Geometries.Constraints.PointChange  change 
)

Applies this constraint on a pending change.

Parameters
oldPointthe base Point on which the change is performed, cannot be null.
newPointthe result of the change, without any constraints applied, cannot be null.
changethe change that was applied.
Returns
the resulting Point, after applying this constraint on the pending change. If the constraint does not apply, simply return the newPoint. Cannot be null.

◆ Apply() [2/2]

Luciad.Geometries.Point Luciad.Geometries.Constraints.IPointConstraint.Apply ( Luciad.Geometries.Point  point)

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

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