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.core.partitioning.bsp;
    18
    19  /** Enum describing the possible behaviors when cutting a region BSP tree node
    20   * with a hyperplane to produce two new child nodes.
    21   */
    22  public enum RegionCutRule {
    23
    24      /** Set the minus side of the cutting hyperplane as the inside of the region
    25       * and the plus side as the outside. This is the default convention for hyperplanes.
    26       */
    27      MINUS_INSIDE,
    28
    29      /** Set the plus side of the cutting hyperplane as the inside of the region and
    30       * the minus side as the outside.
    31       */
    32      PLUS_INSIDE,
    33
    34      /** Set both child nodes to the same location as the parent node. For example, if the
    35       * parent node is marked as inside, both child nodes will be marked as inside. Similarly
    36       * if the parent node is marked as outside, both child nodes will be marked as outside.
    37       * This rule can be used to modify the tree structure (to perhaps produce a more efficient,
    38       * balanced tree) without changing the represented region.
    39       */
    40      INHERIT
    41  }