LuciadCPillar C# 2023.1.05
Luciad.Geometries.Observable.ObservablePolylineUtil Class Reference

This class provides utility methods for Observable instance for Polyline. More...

Static Public Member Functions

static Luciad.Utils.Observable< Luciad.Geometries.PointDerivePointAtEnd (Luciad.Utils.Observable< Luciad.Geometries.Polyline > observablePolyline)
 Derives an Observable Point from the given observable polyline that represents the end point of the polyline (regardless of the point count). More...
 
static Luciad.Utils.Observable< Luciad.Geometries.PointDerivePointAtIndex (Luciad.Utils.Observable< Luciad.Geometries.Polyline > observablePolyline, uint index)
 Derives an Observable Point from the given observable polyline that represents the point at the given index. More...
 
static Luciad.Utils.Observable< Luciad.Geometries.PointDerivePointAtStart (Luciad.Utils.Observable< Luciad.Geometries.Polyline > observablePolyline)
 Derives an Observable Point from the given observable polyline that represents the start point. More...
 
static Luciad.Utils.Observable< Luciad.Geometries.PointDerivePointOnSegment (Luciad.Utils.Observable< Luciad.Geometries.Polyline > observablePolyline, uint segmentIndex, double parameter)
 Derives an Observable Point from the given observable polyline that represents a point on a segment of the polyline. More...
 

Detailed Description

This class provides utility methods for Observable instance for Polyline.

2020.1

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::ObservablePolylineUtil.

Member Function Documentation

◆ DerivePointAtEnd()

Luciad.Utils.Observable< Luciad.Geometries.Point > Luciad.Geometries.Observable.ObservablePolylineUtil.DerivePointAtEnd ( Luciad.Utils.Observable< Luciad.Geometries.Polyline observablePolyline)
inlinestatic

Derives an Observable Point from the given observable polyline that represents the end point of the polyline (regardless of the point count).

This observable point will be updated when the given observable polyline changes. Notes: When the observable polyline contains a nullptr value, the observable point instance will contain a nullptr value too. Observable::setValue will throw an exception for derived instances.

observablePolyline

an observable polyline from which to derive the point

a derived Observable

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::ObservablePolylineUtil::derivePointAtEnd.

◆ DerivePointAtIndex()

Luciad.Utils.Observable< Luciad.Geometries.Point > Luciad.Geometries.Observable.ObservablePolylineUtil.DerivePointAtIndex ( Luciad.Utils.Observable< Luciad.Geometries.Polyline observablePolyline,
uint  index 
)
inlinestatic

Derives an Observable Point from the given observable polyline that represents the point at the given index.

This observable point will be updated when the given observable polyline changes. Notes: When the observable polyline contains a nullptr value, the observable point instance will contain a nullptr value too. When the given index >= point count, the observable point instance will contain a nullptr value. Observable::setValue will throw an exception for derived instances.

observablePolyline

an observable polyline from which to derive the point

index

the point index

a derived Observable

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::ObservablePolylineUtil::derivePointAtIndex.

◆ DerivePointAtStart()

Luciad.Utils.Observable< Luciad.Geometries.Point > Luciad.Geometries.Observable.ObservablePolylineUtil.DerivePointAtStart ( Luciad.Utils.Observable< Luciad.Geometries.Polyline observablePolyline)
inlinestatic

Derives an Observable Point from the given observable polyline that represents the start point.

This observable point will be updated when the given observable polyline changes. Notes: When the observable polyline contains a nullptr value, the observable point instance will contain a nullptr value too. Observable::setValue will throw an exception for derived instances.

observablePolyline

an observable polyline from which to derive the point

a derived Observable

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::ObservablePolylineUtil::derivePointAtStart.

◆ DerivePointOnSegment()

Luciad.Utils.Observable< Luciad.Geometries.Point > Luciad.Geometries.Observable.ObservablePolylineUtil.DerivePointOnSegment ( Luciad.Utils.Observable< Luciad.Geometries.Polyline observablePolyline,
uint  segmentIndex,
double  parameter 
)
inlinestatic

Derives an Observable Point from the given observable polyline that represents a point on a segment of the polyline.

This observable point will be updated when the given observable polyline changes. Notes: When the observable polyline contains a nullptr value, the observable point instance will contain a nullptr value too. When the given segmentIndex >= point count - 1, the observable point instance will contain a nullptr value. Observable::setValue will throw an exception for derived instances.

observablePolyline

an observable polyline from which to derive the point

segmentIndex

a segment index: a value between [0, pointCount - 2]. For example: segment index 0 corresponds with the segment between the points with index 0 and 1.

parameter

a parameter value between [0, 1] that determines which point of the segment is chosen. This can for example be 0.5, to get the middle of the segment

a derived Observable

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::ObservablePolylineUtil::derivePointOnSegment.