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.euclidean.threed.rotation;
18  
19  /** Defines different types of rotation axis sequences.
20   */
21  public enum AxisSequenceType {
22  
23      /** Represents Euler angles, which consist of axis sequences
24       * in the pattern <em>ABA</em>. For example, the sequences {@code ZXZ}, {@code XYX}, etc.
25       * fit this definition. Other types of sequences that do not match this
26       * pattern are often called "Euler angles" in common usage. However, this enum
27       * value is intended to represent only those sequences that match exactly, ie "proper" Euler angles.
28       * @see <a href="https://en.wikipedia.org/wiki/Euler_angles#Proper_Euler_angles">Proper Euler angles</a>
29       */
30      EULER,
31  
32      /** Represents Tait-Bryan angles, which consist of axis sequences
33       * in the pattern <em>ABC</em>. For example, the sequences {@code XYZ}, {@code ZXY},
34       * etc. fit this definition. Tait-Bryan angles are also called Cardan angles.
35       * @see <a href="https://en.wikipedia.org/wiki/Euler_angles#Tait%E2%80%93Bryan_angles">Tait-Bryan angles</a>
36       */
37      TAIT_BRYAN
38  }