An hyperplane on the 1-sphere is an angle with an orientation.
Instances of this class are guaranteed to be immutable.
| Modifier and Type | Field and Description |
|---|---|
| private boolean | direct
Orientation. |
| private S1Point | location
Angle location. |
| private final double | tolerance
Tolerance below which angles are considered identical. |
| Access | Constructor and Description |
|---|---|
| public | LimitAngle(final S1Point
location of the hyperplane location, final boolean if true, the plus side of the hyperplane is towards
angles greater than direct, final double locationtolerance below which angles are considered identical tolerance)Simple constructor. |
| Modifier and Type | Method and Description |
|---|---|
| public LimitAngle | Returns: the instance itselfImplements org. Copy the instance. |
| public S1Point | |
| public double | getOffset(final Point<Sphere1D>
point to check point)Implements org. Get the offset (oriented distance) of a point. |
| public LimitAngle | Returns: a new limit angle, with orientation opposite to the instance orientationGet the reverse of the instance. |
| public double | getTolerance()
Implements org. Get the tolerance below which points are considered to belong to the hyperplane. |
| public boolean | Returns: true if the plus side of the hyperplane is towards angles greater than hyperplane locationCheck if the hyperplane orientation is direct. |
| public Point | project(Point<Sphere1D>
point to project point)Implements org. Project a point to the hyperplane. |
| public boolean | sameOrientationAs(final Hyperplane<Sphere1D>
other hyperplane to check against the instance other)Implements org. Check if the instance has the same orientation as another hyperplane. |
| public SubLimitAngle | Returns: a dummy sub hyperplaneImplements org. Build a region covering the whole hyperplane. |
| public ArcsSet | Returns: a region containing the instance (really anIntervalsSet instance)Implements org. Build a region covering the whole space. |
| direct | back to summary |
|---|---|
| private boolean direct Orientation. | |
| location | back to summary |
|---|---|
| private S1Point location Angle location. | |
| tolerance | back to summary |
|---|---|
| private final double tolerance Tolerance below which angles are considered identical. | |
| LimitAngle | back to summary |
|---|---|
| public LimitAngle(final S1Point location, final boolean direct, final double tolerance) Simple constructor.
| |
| copySelf | back to summary |
|---|---|
| public LimitAngle copySelf() Implements org. Copy the instance. Since instances are immutable, this method directly returns the instance.
| |
| getLocation | back to summary |
|---|---|
| public S1Point getLocation() Get the hyperplane location on the circle.
| |
| getOffset | back to summary |
|---|---|
| public double getOffset(final Point<Sphere1D> point) Implements org. Doc from org. Get the offset (oriented distance) of a point. The offset is 0 if the point is on the underlying hyperplane, it is positive if the point is on one particular side of the hyperplane, and it is negative if the point is on the other side, according to the hyperplane natural orientation. | |
| getReverse | back to summary |
|---|---|
| public LimitAngle getReverse() Get the reverse of the instance. Get a limit angle with reversed orientation with respect to the instance. A new object is built, the instance is untouched.
| |
| getTolerance | back to summary |
|---|---|
| public double getTolerance() Implements org. Doc from org. Get the tolerance below which points are considered to belong to the hyperplane.
| |
| isDirect | back to summary |
|---|---|
| public boolean isDirect() Check if the hyperplane orientation is direct.
| |
| project | back to summary |
|---|---|
| public Point Implements org. Doc from org. Project a point to the hyperplane. | |
| sameOrientationAs | back to summary |
|---|---|
| public boolean sameOrientationAs(final Hyperplane<Sphere1D> other) Implements org. Doc from org. Check if the instance has the same orientation as another hyperplane. This method is expected to be called on parallel hyperplanes. The method should not re-check for parallelism, only for orientation, typically by testing something like the sign of the dot-products of normals.
| |
| wholeHyperplane | back to summary |
|---|---|
| public SubLimitAngle wholeHyperplane() Implements org. Build a region covering the whole hyperplane. Since this class represent zero dimension spaces which does
not have lower dimension sub-spaces, this method returns a dummy
implementation of a
| |
| wholeSpace | back to summary |
|---|---|
| public ArcsSet wholeSpace() Implements org. Build a region covering the whole space.
| |