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;
    18
    19  /** Enumeration containing the possible locations of a point with
    20   * respect to a region.
    21   * @see Region
    22   */
    23  public enum RegionLocation {
    24
    25      /** Value indicating that a point lies on the inside of
    26       * a region.
    27       */
    28      INSIDE,
    29
    30      /** Value indicating that a point lies on the outside of
    31       * a region.
    32       */
    33      OUTSIDE,
    34
    35      /** Value indicating that a point lies on the boundary of
    36       * a region.
    37       */
    38      BOUNDARY
    39  }