octave_packages/geometry-1.5.0/geom2d/createRotation.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2004-2011, David Legland <david.legland@grignon.inra.fr>
   3 %% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
   4 %%
   5 %% All rights reserved.
   6 %% (simplified BSD License)
   7 %%
   8 %% Redistribution and use in source and binary forms, with or without
   9 %% modification, are permitted provided that the following conditions are met:
  10 %%
  11 %% 1. Redistributions of source code must retain the above copyright notice, this
  12 %%    list of conditions and the following disclaimer.
  13 %%
  14 %% 2. Redistributions in binary form must reproduce the above copyright notice,
  15 %%    this list of conditions and the following disclaimer in the documentation
  16 %%    and/or other materials provided with the distribution.
  17 %%
  18 %% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19 %% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 %% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 %% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  22 %% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 %% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 %% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 %% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 %% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 %% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 %% POSSIBILITY OF SUCH DAMAGE.
  29 %%
  30 %% The views and conclusions contained in the software and documentation are
  31 %% those of the authors and should not be interpreted as representing official
  32 %% policies, either expressed or implied, of copyright holder.
  33
  34 %% -*- texinfo -*-
  35 %% @deftypefn {Function File} {@var{T} = } createRotation (@var{theta})
  36 %% @deftypefnx {Function File} {@var{T} = } createRotation (@var{point}, @var{theta})
  37 %% @deftypefnx {Function File} {@var{T} = } createRotation (@var{x0}, @var{y0}, @var{theta})
  38 %% Create the 3*3 matrix of a rotation.
  39 %%
  40 %%   Returns the rotation corresponding to angle @var{theta} (in radians)
  41 %%   The returned matrix has the form :
  42 %%   [cos(theta) -sin(theta)  0]
  43 %%   [sin(theta)  cos(theta)  0]
  44 %%   [0           0           1]
  45 %%
  46 %%   @var{point} or (@var{x0},@var{y0}), specifies origin of rotation. The result is similar as performing
  47 %%   translation(-@var{x0},-@var{y0}), rotation(@var{theta}), and translation(@var{x0},@var{y0}).
  48 %%
  49 %%
  50 %%   @seealso{transforms2d, transformPoint, createTranslation, createScaling}
  51 %% @end deftypefn
  52
  53 function trans = createRotation(varargin)
  54
  55   % default values
  56   cx = 0;
  57   cy = 0;
  58   theta = 0;
  59
  60   % get input values
  61   if length(varargin)==1
  62       % only angle
  63       theta = varargin{1};
  64   elseif length(varargin)==2
  65       % origin point (as array) and angle
  66       var = varargin{1};
  67       cx = var(1);
  68       cy = var(2);
  69       theta = varargin{2};
  70   elseif length(varargin)==3
  71       % origin (x and y) and angle
  72       cx = varargin{1};
  73       cy = varargin{2};
  74       theta = varargin{3};
  75   end
  76
  77   % compute coefs
  78   cot = cos(theta);
  79   sit = sin(theta);
  80   tx =  cy*sit - cx*cot + cx;
  81   ty = -cy*cot - cx*sit + cy;
  82
  83   % create transformation matrix
  84   trans = [cot -sit tx; sit cot ty; 0 0 1];
  85
  86 endfunction
  87
  88 %!test
  89 %!  trans = createRotation(0);
  90 %!  assert (trans, [1 0 0;0 1 0;0 0 1], 1e-6);
  91
  92 %!test
  93 %!  trans = createRotation(pi/2);
  94 %!  assert (trans, [0 -1 0; 1 0 0; 0 0 1], 1e-6);
  95
  96 %!test
  97 %!  trans = createRotation(pi);
  98 %!  assert (trans, [-1 0 0;0 -1 0;0 0 1], 1e-6);
  99
 100 %!test
 101 %!  trans = createRotation(3*pi/2);
 102 %!  assert (trans, [0 1 0; -1 0 0; 0 0 1], 1e-6);
 103
 104 %!test
 105 %!  p0 = [3 5];
 106 %!  theta = pi/3;
 107 %!  trans1 = createRotation(p0, theta);
 108 %!  t1 = createTranslation(-p0);
 109 %!  rot = createRotation(theta);
 110 %!  t2 = createTranslation(p0);
 111 %!  trans2 = t2*rot*t1;
 112 %!  assert (trans1, trans2, 1e-6);