octave_packages/geometry-1.5.0/geom2d/createTranslation.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} = } createTranslation (@var{vector})
  36 %% @deftypefnx {Function File} {@var{T} = } createTranslation (@var{dx},@var{dy})
  37 %% Create the 3*3 matrix of a translation.
  38 %%
  39 %%   Returns the matrix corresponding to a translation by the vector [@var{dx} @var{dy}].
  40 %%   The components can be given as two arguments.
  41 %%   The returned matrix has the form :
  42 %%   [1 0 TX]
  43 %%   [0 1 TY]
  44 %%   [0 0  1]
  45 %%
  46 %%   @seealso{transforms2d, transformPoint, createRotation, createScaling}
  47 %% @end deftypefn
  48
  49 function trans = createTranslation(varargin)
  50
  51   % process input arguments
  52   if isempty(varargin)
  53       tx = 0;
  54       ty = 0;
  55   elseif length(varargin)==1
  56       var = varargin{1};
  57       tx = var(1);
  58       ty = var(2);
  59   else
  60       tx = varargin{1};
  61       ty = varargin{2};
  62   end
  63
  64   % create the matrix representing the translation
  65   trans = [1 0 tx ; 0 1 ty ; 0 0 1];
  66
  67 endfunction
  68
  69 %!test
  70 %!  trans = createTranslation(2, 3);
  71 %!  assert (trans, [1 0 2;0 1 3;0 0 1], 1e-6);