blob: aa78dccd7e4e21462707c96359a84c5f77a3b57a [file] [log] [blame]
/*
* Copyright 2009, Google Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
namespace o3d {
%[
This param operation applies a rotation to its input matrix. The
rotation is specified in terms of an angle and an axis of rotation.
It can be used, for example, to supply the local matrix of a transform.
@o3dparameter inputMatrix ParamMatrix4 The input matrix.
@o3dparameter axis ParamFloat3 The axis of rotation.
@o3dparameter angle ParamFloat The amount of rotation.
@o3dparameter outputMatrix ParamMatrix4 The result of rotating the input
matrix by the specified rotation.
%]
[nocpp, include="core/cross/matrix4_axis_rotation.h"]
class Matrix4AxisRotation : ParamObject {
%[
The local rotation axis. This must be a unit vector.
Default = [0, 0, 0].
%]
[getter, setter] Float3 axis;
%[
The angle of rotation in radians.
Default = 0.
%]
[getter, setter] float angle;
%[
The input matrix.
Default = Identity.
%]
[getter, setter] Vectormath::Aos::Matrix4 input_matrix;
%[
The output is equal to the rotation of the input matrix.
%]
[getter] Vectormath::Aos::Matrix4 output_matrix;
}; // Matrix4AxisRotation
} // namespace o3d