blob: f1ad025d37b9cb48165b80f7d465f672904ddc52 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
*
* <p>
* This package provides components related to rotations in 3 dimensional
* Euclidean space.
* </p>
*
* <h2>Conventions</h2>
* <p>
* There are numerous conventions that must be decided when attempting to
* define 3-dimensional rotations. The following list contains some of the
* primary rotation conventions for this package. All method parameters, return
* values, and operations follow these conventions unless explicitly stated otherwise.
*
* <ul>
* <li><strong>Active</strong> -- All rotations are "active", meaning that
* they transform the vector or point they are applied to instead of transforming the
* coordinate system. An active rotation can be converted to a passive one and vice
* versa simply by taking the inverse. See
* <a href="https://en.wikipedia.org/wiki/Active_and_passive_transformation">here</a> for more details.
* </li>
* <li><strong>Right-handed</strong> -- All rotation directions follow the
* <a href="https://en.wikipedia.org/wiki/Right-hand_rule">right hand rule</a>.
* This means that the direction of rotation for a given axis and angle is the same
* direction that one's fingers curl if the thumb is pointed along the axis of rotation.
* </li>
* <li><strong>Radians</strong> -- All angles are in radians.
* </li>
* </ul>
*/
package org.apache.commons.geometry.euclidean.threed.rotation;