kIndicator.m

%kIndicator 'Indicator Object Menuform'
% This MatLab function was automatically generated by a converter (KhorosToMatLab) from the Khoros Indicator.pane file
%
% Parameters: 
% String: indicatorXpos.stringFormat 'X Format', default: '%g': 'Formatting string'
% String: indicatorYpos.stringFormat 'Y Format', default: '%g': 'Formatting string'
%
% Example: kIndicator( {'indicatorXpos.stringFormat','%g';'indicatorYpos.stringFormat','%g'})
%
% Khoros helpfile follows below:
% .begin tagged
% .item "The Indicator Visual Object"
% An indicator is a marker with the additional capability of displaying the 
% X and/or Y world coordinates of the location at which the marker is placed.
% If desired, the indicator may further have a vertical line (most often used
% with displaying X values) and/or a horizontal line (most often used with 
% displaying Y values).
% 
% .item "X Value"
% Specifies the x position of the indicator in world coordinates.
% 
% .item "Y Value"
% Specifies is the y position of the indicator in world coordinates.
% 
% .item "X Format"
% This is the format in which the string object is to display the X value
% of the indicator; legal values are identical to those used with "printf()" 
% and "scanf()", except for %s and %c.
% 
% .item "Y Format"
% This is the format in which the string object is to display the Y value
% of the indicator; legal values are identical to those used with "printf()" 
% and "scanf()", except for %s and %c.
% 
% .item "Show X Value"
% This logical indicates whether the indicator should display its X position.
% 
% .item "Show Y Value"
% This logical indicates whether the indicator should display its Y position.
% 
% .item "Line"
% Indicates whether a horizontal and/or vertical line should be displayed
% by the indicator.
% 
% .item "Marker Type"
% The indicator may use a variety of marker types, including Square, Triangle,
% Cross, Bow Tie, Arc, Diamond, Circle, V, Hexagon, X, Dot, Caret, Point,
% Dagger, and Box.
% 
% .item "Line Width"
% This is the width of line with which the lines of the indicator should be 
% drawn, when lines are used.  Line widths range from none (invisible) to 
% extra wide.
% 
% .item "Line Type"
% This list selection lets you set the line type used with the lines
% of the indicator, when lines are used. There are seven line types, 
% including "Solid", "Dotted", "Dot Dash", "Short Dash", "Long Dash", 
% "Odd Dash", and "Grid Dotted".
% 
% .item "Color"
% This stringlist selection lets you set the XVW_FOREGROUND_COLOR attribute
% on the indicator object, using the color name.
% 
% .end tagged


function varargout = kIndicator(varargin)
Inputs={};
if nargin ==0
  arglist={'',''};
elseif nargin ==1
  arglist=varargin{1};
else error('Usage: [out1,..] = kIndicator(arglist).');
end
if size(arglist,2)~=2
  error('arglist must be of form {''ParameterTag1'',value1;''ParameterTag2'',value2}')
 end
narglist={'indicatorXpos.stringFormat', '%g';'indicatorYpos.stringFormat', '%g'};
maxval={0,0};
minval={0,0};
istoggle=[0,0];
was_set=istoggle * 0;
paramtype={'String','String'};
% identify the input arrays and assign them to the arguments as stated by the user
if ~iscell(Inputs)
Inputs = {Inputs};
end
NumReqOutputs=0; nextinput=1; nextoutput=1;
  for ii=1:size(arglist,1)
  wasmatched=0;
  for jj=1:size(narglist,1)
   if strcmp(arglist{ii,1},narglist{jj,1})  % a given argument was matched to the possible arguments
     wasmatched = 1;
     was_set(jj) = 1;
     if strcmp(narglist{jj,2}, '__input')
      if (nextinput > length(Inputs)) 
        error(['Input ' narglist{jj,1} ' has no corresponding input!']); 
      end
      narglist{jj,2} = 'OK_in';
      nextinput = nextinput + 1;
     elseif strcmp(narglist{jj,2}, '__output')
      if (nextoutput > nargout) 
        error(['Output nr. ' narglist{jj,1} ' is not present in the assignment list of outputs !']); 
      end
      if (isempty(arglist{ii,2}))
        narglist{jj,2} = 'OK_out';
      else
        narglist{jj,2} = arglist{ii,2};
      end

      nextoutput = nextoutput + 1;
      if (minval{jj} == 0)  
         NumReqOutputs = NumReqOutputs - 1;
      end
     elseif isstr(arglist{ii,2})
      narglist{jj,2} = arglist{ii,2};
     else
        if strcmp(paramtype{jj}, 'Integer') & (round(arglist{ii,2}) ~= arglist{ii,2})
            error(['Argument ' arglist{ii,1} ' is of integer type but non-integer number ' arglist{ii,2} ' was supplied']);
        end
        if (minval{jj} ~= 0 | maxval{jj} ~= 0)
          if (minval{jj} == 1 & maxval{jj} == 1 & arglist{ii,2} < 0)
            error(['Argument ' arglist{ii,1} ' must be bigger or equal to zero!']);
          elseif (minval{jj} == -1 & maxval{jj} == -1 & arglist{ii,2} > 0)
            error(['Argument ' arglist{ii,1} ' must be smaller or equal to zero!']);
          elseif (minval{jj} == 2 & maxval{jj} == 2 & arglist{ii,2} <= 0)
            error(['Argument ' arglist{ii,1} ' must be bigger than zero!']);
          elseif (minval{jj} == -2 & maxval{jj} == -2 & arglist{ii,2} >= 0)
            error(['Argument ' arglist{ii,1} ' must be smaller than zero!']);
          elseif (minval{jj} ~= maxval{jj} & arglist{ii,2} < minval{jj})
            error(['Argument ' arglist{ii,1} ' must be bigger than ' num2str(minval{jj})]);
          elseif (minval{jj} ~= maxval{jj} & arglist{ii,2} > maxval{jj})
            error(['Argument ' arglist{ii,1} ' must be smaller than ' num2str(maxval{jj})]);
          end
        end
     end
     if ~strcmp(narglist{jj,2},'OK_out') &  ~strcmp(narglist{jj,2},'OK_in') 
       narglist{jj,2} = arglist{ii,2};
     end
   end
   end
   if (wasmatched == 0 & ~strcmp(arglist{ii,1},''))
        error(['Argument ' arglist{ii,1} ' is not a valid argument for this function']);
   end
end
% match the remaining inputs/outputs to the unused arguments and test for missing required inputs
 for jj=1:size(narglist,1)
     if  strcmp(paramtype{jj}, 'Toggle')
        if (narglist{jj,2} ==0)
          narglist{jj,1} = ''; 
        end;
        narglist{jj,2} = ''; 
     end;
     if  ~strcmp(narglist{jj,2},'__input') && ~strcmp(narglist{jj,2},'__output') && istoggle(jj) && ~ was_set(jj)
          narglist{jj,1} = ''; 
          narglist{jj,2} = ''; 
     end;
     if strcmp(narglist{jj,2}, '__input')
      if (minval{jj} == 0)  % meaning this input is required
        if (nextinput > size(Inputs)) 
           error(['Required input ' narglist{jj,1} ' has no corresponding input in the list!']); 
        else
          narglist{jj,2} = 'OK_in';
          nextinput = nextinput + 1;
        end
      else  % this is an optional input
        if (nextinput <= length(Inputs)) 
          narglist{jj,2} = 'OK_in';
          nextinput = nextinput + 1;
        else 
          narglist{jj,1} = '';
          narglist{jj,2} = '';
        end;
      end;
     else 
     if strcmp(narglist{jj,2}, '__output')
      if (minval{jj} == 0) % this is a required output
        if (nextoutput > nargout & nargout > 1) 
           error(['Required output ' narglist{jj,1} ' is not stated in the assignment list!']); 
        else
          narglist{jj,2} = 'OK_out';
          nextoutput = nextoutput + 1;
          NumReqOutputs = NumReqOutputs-1;
        end
      else % this is an optional output
        if (nargout - nextoutput >= NumReqOutputs) 
          narglist{jj,2} = 'OK_out';
          nextoutput = nextoutput + 1;
        else 
          narglist{jj,1} = '';
          narglist{jj,2} = '';
        end;
      end
     end
  end
end
if nargout
   varargout = cell(1,nargout);
else
  varargout = cell(0);
end
if ispc
  w='"C:\Program Files\dip\khorosBin\';
else
[s,w] = system('which cantata');
w=['"' w(1:end-8)];
end
global KhorosRoot
if exist('KhorosRoot')
if ~isempty(KhorosRoot)
w=['"' KhorosRoot];
end
end
callKhoros([w 'Indicator" '],Inputs,narglist);