octave_packages/geometry-1.5.0/geom2d/transformVector.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2007-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{v2} = } transformVector (@var{v}, @var{T})
  36 %% @deftypefnx {Function File} {[@var{x2} @var{y2}] = } transformVector (@var{x},@var{y}, @var{T})
  37 %% Transform a vector with an affine transform
  38 %%
  39 %%   @var{v} has the form [xv yv], and @var{T} is a [2x2], [2x3] or [3x3]
  40 %%   matrix, returns the vector transformed with affine transform @var{T}.
  41 %%
  42 %%   Format of @var{T} can be one of :
  43 %% @group
  44 %%   [a b]   ,   [a b c] , or [a b c]
  45 %%   [d e]       [d e f]      [d e f]
  46 %%                            [0 0 1]
  47 %% @end group
  48 %%
  49 %%   Also works when @var{v} is a [Nx2] array of double. In this case, @var{v2} has
  50 %%   the same size as @var{v}.
  51 %%
  52 %%   Also works when @var{x} and @var{y} are arrays the same size. The function
  53 %%   transform each couple of (@var{x}, @var{y}), and return the result in
  54 %%   (@var{x2}, @var{y2}), which is the same size as (@var{x}, @var{y}).
  55 %%
  56 %%   @seealso{vectors2d, transforms2d, rotateVector, transformPoint}
  57 %% @end deftypefn
  58
  59 function varargout = transformVector(varargin)
  60
  61   if length(varargin)==2
  62       var = varargin{1};
  63       vx = var(:,1);
  64       vy = var(:,2);
  65       trans = varargin{2};
  66   elseif length(varargin)==3
  67       vx = varargin{1};
  68       vy = varargin{2};
  69       trans = varargin{3};
  70   else
  71       error('wrong number of arguments in "transformVector"');
  72   end
  73
  74
  75   % compute new position of vector
  76   vx2 = vx*trans(1,1) + vy*trans(1,2);
  77   vy2 = vx*trans(2,1) + vy*trans(2,2);
  78
  79   if size(trans, 2) == 3
  80     vx2 = vx2 + trans(1,3);
  81     vy2 = vy2 + trans(2,3);
  82   end
  83
  84   % format output
  85   if nargout==0 || nargout==1
  86       varargout{1} = [vx2 vy2];
  87   elseif nargout==2
  88       varargout{1} = vx2;
  89       varargout{2} = vy2;
  90   end
  91
  92 endfunction
  93
  94 %!demo
  95 %! t1 = [2 0 0; 0 2 0];
  96 %! t2 = [1 0 1; 0 1 1];
  97 %! t3 = [0.5 0 1; 0 0.5 1; 0 0 1];
  98 %!
  99 %! triangle = [-0.5 -1/3; 0.5 -1/3; 0 2/3; -0.5 -1/3];
 100 %! tr1 = transformVector(triangle,t1);
 101 %! tr2 = transformVector(triangle,t2);
 102 %! tr3 = transformVector(triangle,t3);
 103 %!
 104 %! plot(triangle(:,1),triangle(:,2),'k-', ...
 105 %!      tr1(:,1),tr1(:,2),'g-;scaled up;', ...
 106 %!      tr2(:,1),tr2(:,2),'m-;translated;', ...
 107 %!      tr3(:,1),tr3(:,2),'b-;scaled down and translated;')
 108