PlaneCrossingFunction (OREKIT 14.0-SNAPSHOT API)

java.lang.Object
- org.orekit.propagation.events.functions.PlaneCrossingFunction

All Implemented Interfaces:

EventFunction
```
public class PlaneCrossingFunction
extends Object
implements EventFunction
```
Event function for crossing a 2D plane in 3D space, as defined by a normal vector. The plane is assumed to contain the origin of the frame where the normal's coordinates are given. The event function is negative under the plane according to the normal's orientation.

Since:

14.0

Author:

Romain Serra

Constructor Summary

Constructors
Constructor Description

PlaneCrossingFunction(Vector3D normal, Frame frame)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Frame`	`getPlaneFrame()`	Getter for the plane frame.
`Vector3D`	`getPlaneNormal()`	Getter for the plane normal vector.
`<T extends CalculusFieldElement<T>> T`	`value(FieldSpacecraftState<T> fieldState)`	Evaluate Field function.
`double`	`value(SpacecraftState state)`	Evaluate function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orekit.propagation.events.functions.EventFunction
dependsOnMainVariablesOnly, dependsOnTimeOnly

- Constructor Detail
  - PlaneCrossingFunction
```
public PlaneCrossingFunction(Vector3D normal,
                             Frame frame)
```
    Constructor.
    
    Parameters:
    
    normal - plane normal
    
    frame - plane frame
- Method Detail
  - getPlaneFrame
```
public Frame getPlaneFrame()
```
    Getter for the plane frame.
    
    Returns:
    
    frame
  - getPlaneNormal
```
public Vector3D getPlaneNormal()
```
    Getter for the plane normal vector.
    
    Returns:
    
    normal
  - value
```
public double value(SpacecraftState state)
```
    Description copied from interface: EventFunction
    
    Evaluate function.
    
    Specified by:
    
    value in interface EventFunction
    
    Parameters:
    
    state - spacecraft state
    
    Returns:
    
    value
  - value
```
public <T extends CalculusFieldElement<T>> T value(FieldSpacecraftState<T> fieldState)
```
    Description copied from interface: EventFunction
    
    Evaluate Field function. By default, calls the non-Field version. This is suitable for detection but not be for applications like automatic differentiation, where a proper implementation should be used instead.
    
    Specified by:
    
    value in interface EventFunction
    
    Type Parameters:
    
    T - field type
    
    Parameters:
    
    fieldState - spacecraft state
    
    Returns:
    
    value