Home > functions > tool_box > mri_toolbox > mri_point_select_dir > display_element > surf_element > vb_surf_element_new.m

vb_surf_element_new

PURPOSE ^

constructor of surf_element object

SYNOPSIS ^

function [obj] = vb_surf_element_new(name, coord_type, V, F, xx)

DESCRIPTION ^

 constructor of surf_element object
 [USAGE]
    [obj] = vb_surf_element_new(<name>, <coord_type>, <V>, <F>, <xx>);
 [IN]
          name : <<char array>> name of surf_element
    coord_type : coordinate space type
             V : Vertex
             F : Face
            xx : normal vector
 [OUT]
    obj : surf_element object
 [See]
    relative function : vb_display_element_new
 Author: rhayashi
 Created: 2007-07-17

 Copyright (C) 2011, ATR All Rights Reserved.
 License : New BSD License(see VBMEG_LICENSE.txt)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [obj] = vb_surf_element_new(name, coord_type, V, F, xx)
0002 % constructor of surf_element object
0003 % [USAGE]
0004 %    [obj] = vb_surf_element_new(<name>, <coord_type>, <V>, <F>, <xx>);
0005 % [IN]
0006 %          name : <<char array>> name of surf_element
0007 %    coord_type : coordinate space type
0008 %             V : Vertex
0009 %             F : Face
0010 %            xx : normal vector
0011 % [OUT]
0012 %    obj : surf_element object
0013 % [See]
0014 %    relative function : vb_display_element_new
0015 % Author: rhayashi
0016 % Created: 2007-07-17
0017 %
0018 % Copyright (C) 2011, ATR All Rights Reserved.
0019 % License : New BSD License(see VBMEG_LICENSE.txt)
0020 
0021 %
0022 % --- Previous check
0023 %
0024 if ~exist('name', 'var'), error('name is a required parameter.'); end
0025 if ~exist('coord_type', 'var')
0026     error('coord_type is a required parameter.');
0027 end
0028 if ~exist('V', 'var'), error('V is a required parameter.'); end
0029 if ~exist('F', 'var'), error('F is a required parameter.'); end
0030 if ~exist('xx', 'var'), error('xx is a required parameter.'); end
0031 
0032 %
0033 % --- Main Procedure
0034 %
0035 
0036 % Inherit display_element class
0037 obj = vb_display_element_new(name, coord_type);
0038 
0039 % surf_element members
0040 obj.class_name = 'surf_element';
0041 obj.V = V;
0042 obj.F = F;
0043 obj.xx = xx;
0044 
0045 %
0046 % --- After check
0047 %
0048 if nargout ~= 1
0049     error('function caller should receive obj.');
0050 end

Generated on Tue 27-Aug-2013 11:46:04 by m2html © 2005