Last updated

API / geotoolkit3d / util / well / logarray / LogArrayUtil / ReferenceMode

Enumeration: ReferenceMode

logarray.LogArrayUtil.ReferenceMode

Enum to configure the LogArray sector 0 location.

This enum provides several reference mechanism to determine where the sector 0 should be.
For example it could be the sector pointing upward, or the sector pointing toward the North.

Table of contents

Enumeration Members

Contents

Enumeration Members

North

North = 1

Use North as reference for sector 0.
This is not suitable for horizontal trajectories pointing north.


Up

Up = 2

Use Up as reference for sector 0.
This is not suitable for vertical trajectories.


UpNorth

UpNorth = 0

This reference mode switches between Up or North depending on the inclination of the path.
If the current section of the path has an inclination greater than the given angle, then Up will be used.

As this check is done per 'section' of the LogArray, a 'twist' may appear on the resulting cylinder when the switch between Up/North reference occurs.

This mode accepts a parameter to define the inclination angle threshold (in radians), the default value is 0.1745 (10 degrees).
The angle is 0 for a vertical section and PI/2 for an horizontal section.

To use a custom angle of 60 degrees for example, do geotoolkit3d.util.well.logarray.LogArrayUtil.ReferenceMode.UpNorth(1.0472)