View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.geometry.spherical.twod;
18  
19  import java.util.Arrays;
20  import java.util.Collection;
21  import java.util.List;
22  import java.util.stream.Collectors;
23  
24  import org.apache.commons.geometry.core.partitioning.BoundarySource;
25  
26  /** Extension of the {@link BoundarySource} interface for spherical 2D
27   * space.
28   */
29  public interface BoundarySource2S extends BoundarySource<GreatArc> {
30  
31      /** Return a {@link BoundaryList2S} containing the boundaries in this instance.
32       * @return a {@link BoundaryList2S} containing the boundaries in this instance
33       */
34      default BoundaryList2S toList() {
35          final List<GreatArc> boundaries = boundaryStream()
36                  .collect(Collectors.toList());
37  
38          return new BoundaryList2S(boundaries);
39      }
40  
41      /** Return a BSP tree constructed from the boundaries contained in this
42       * instance. The default implementation creates a new, empty tree
43       * and inserts the boundaries from this instance.
44       * @return a BSP tree constructed from the boundaries in this instance
45       */
46      default RegionBSPTree2S toTree() {
47          final RegionBSPTree2S tree = RegionBSPTree2S.empty();
48          tree.insert(this);
49  
50          return tree;
51      }
52  
53      /** Return a {@link BoundarySource2S} instance containing the given boundaries.
54       * @param boundaries boundaries to include in the boundary source
55       * @return a boundary source containing the given boundaries
56       */
57      static BoundarySource2S of(final GreatArc... boundaries) {
58          return of(Arrays.asList(boundaries));
59      }
60  
61      /** Return a {@link BoundarySource2S} instance containing the given boundaries. The given
62       * collection is used directly as the source of the line subsets; no copy is made.
63       * @param boundaries boundaries to include in the boundary source
64       * @return a boundary source containing the given boundaries
65       */
66      static BoundarySource2S of(final Collection<GreatArc> boundaries) {
67          return boundaries::stream;
68      }
69  }