3dsMax/html/export.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" href="css/manpage.css" type="text/css" />
<title>Export Plug-In</title>
</head>
<body>
<h1>Export Plug-In</h1>
<p>This chapter describes the use and features of the Export plug-in.</p>
<p>
<a href="#function">Export Plug-in Features</a><br /> <a href="#usage">How to Use the Plug-in</a><br /> <a href="#error_warning">Errors and Warnings</a><br /> <a href="batch_export.html" target="main">Batch Export</a><br /> <a href="batch_export.html#export_batch_custum">Independent Batch Export Using Max Script</a><br />
</p>

<h2><span id="function">Export Plug-In Features</span></h2>

<p>The Export plug-in has the following features:</p>
<ul>
<li>Output intermediate files to specified folders</li>
<li>Feature for transferring data to 3DEditor (Creative Studio)</li>
<li>Output one or multiple scenes at once to intermediate files (<a href="batch_export.html">Batch Export</a>)</li>
</ul>


<h2><span id="usage">Using the Tool</span></h2>
<p>To output data for particular nodes only (including lower nodes in the hierarchy), select the nodes you want to output. When outputting the entire scene, it is not necessary to select nodes.</p>

<p>To display the Options window, run NW4C Export with Setting.</p>


<p>
To output the intermediate file, specify the appropriate options and click <strong>Export</strong> or <strong>Apply</strong>. Unlike <strong>Export</strong>, <strong>Apply</strong> does not close the Options window after output. The option settings that exist at the time of output are automatically recorded as the current options.

</p>


<h3><span id="options">Option Settings</span></h3>

<h4><span id="options_output">Output Options</span></h4>
<p>Options related to outputting intermediate files.</p>
<center><img src="images/OutputOpt1.gif" alt="OutputOpt1"/>
</center>
<ul>
<li><strong>Export Target</strong>
  <p>Sets the output target.<br /> Specify <B>All</B> to export the entire scene, or <B>Selection</B> to export only the selected nodes and any lower nodes in the hierarchy.</p>
  </li>
<li><strong>File name</strong>
  <p>
  Specify the name of intermediate file. (Omit the file extension.) <br /> Clicking the <B>Scene</B> button to the right sets the current scene name. Clicking the <B>Node</B> button sets the name of the selected node (the topmost node in the selected hierarchy). Characters that cannot be used in file names are double-byte characters, half-space kana characters, equals signs (=), and semicolons (;). <br />
  </p>
</li>
<li><strong>Output 3D Intermediate Files</strong>
  <p>Select this option when outputting an intermediate file to a particular folder. <br /> Specify the folder to which the intermediate file should be output using the option <B>File Path</B>. <br /> Characters that cannot be used in file names are double-byte characters, half-space kana characters, equals signs (=), and semicolons (;). <br /> Texture files are output to the <CODE>Textures</CODE> folder located inside the folder specified by <B>File path</B>. <br />
  </p>
</li>
<li><strong>Use Creative Studio</strong>
  <p>Select this option when transferring intermediate file data to CreativeStudio. It is not possible to select <B>Output 3D Intermediate Files</B> and <B>Use Creative Studio</B> at the same time. <br /> For details on using Creative Studio, see the <I>NintendoWare for CTR CreativeStudio </I>manual.
  </p>
</li>
<li><strong>Use 3DEditor</strong>
  <p>Select this option when transferring intermediate file data to 3DEditor. It is not possible to select <B>Output 3D Intermediate Files</B> and <B>3DEditor</B> at the same time. <br /> For details about using 3DEditor, see NintendoWare for CTR 3DEditor Manual.
  </p>
</li>
<li><strong>Merge cmdl</strong>
  <p>
  Turn this option on and specify the path of a CMDL file to merge that specified CMDL file. Characters that cannot be used in file names are double-byte characters, half-space kana characters, equals signs (=), and semicolons (;). <br />
  </p>
  <p>The following information gets merged:</p>
    <ul>
      <li>The general material information</li>
      <li>The mesh information (Visibility, Priority)</li>
      <li>The model information (Visibility, User data, Animation member settings)</li>
      <li>Dependent files (Textures, lookup tables, etc. These are copied to the Output Folder.）</li>
    </ul>
</li>

<li><strong>Copy Related Files</strong>
  <p>If turned ON, files dependent on the cmdl file specified for <B>Merge cmdl File</B> are copied during merging.
    <table class="list_table"><tbody>
	    <tr>
        <td>Copy Related Files Setting</td>
        <td>Description</td>
      </tr>
	    <tr>
        <td valign="top"><strong>ON</strong></td>
        <td valign="top">
          This setting is best used when using a programming style where each instance of model data is managed separately. <BR> <br /> All files dependent on merge source files are copied below the output folder. This also facilitates passing data back and forth with other people with ease, because all required data is included in the output folder.
        </td>
	    </tr>
      <tr>
        <td valign="top"><strong>OFF</strong></td>
        <td valign="top">
          This setting best suits a programming style where various ctex and clts files are being shared with multiple instances of model data.<BR> <br /> Files referenced by merge source files are not moved, but used as-is. You can merge output data while preserving the location of shared textures and shared lookup tables defined for each project.
        </td>
      </tr>
	  </tbody></table>
  </p>
</li>

</ul>

<h4><span id="options_general">General Options</span></h4>
<p>These are general options available for intermediate files.</p>
<center><img src="images/GeneralOpt1.gif" alt="GeneralOpt1" />
</center>
<ul>
<li><strong>Magnify</strong>
  <p>Specifies the magnification ratio by which the model's vertex coordinates and Translate value should be multiplied.</p>
  </li>
<li><strong>Use FigureMode and SkinPose</strong>
  <p>The physique and default skin pose are determined based on the biped figure mode and bone skin pose. Sometimes turning this option on will correctly output data for which skinning cannot be correctly output otherwise.
  </p>
  <p>
  When using this option, you must set bones used by the physique and skin and a skin pose for all associated parents. Even if biped and bone are combined, be absolutely sure to set a skin pose for bones.
  </p>
  </li>
<li><strong>Start / End Frame</strong>
  <p>Specifies the range of animation to output (that is, the start frame and end frame).</p>
  <p>
  Selecting <strong>All</strong> outputs the full range of animation in 3ds Max (Animation Start/End).<br /> Selecting <B>Range</B> allows the start frame and end frame to be entered as numeric values. <B>Note:</B> If the entered start frame is smaller than the Animation Start value in 3ds Max, this Animation Start value will be used as the starting frame. Similarly, if the entered end frame is larger than the Animation End value in 3ds Max, this Animation End value will be used as the ending frame.<br />
  </p>
  <p>If attributes are being animated, the start frame value will be output to the CMDL file.</p>
  <p>Be sure to specify the same mode for the end frame of a loop animation as for the start frame.</p>
  </li>
</ul>

<h4><span id="options_file_selection">Output File Selection</span></h4>
<p>This option specifies the type of intermediate file to be output.</p>
<center><img src="images/OutFileSel1.gif" alt="OutFileSel1" />
</center>
<p>The value of <CODE>HasSkinningMatrix</CODE> in the intermediate file will differ depending on whether the CMDL file and the CSKLA file are output at the same time, or only the CSKLA file is output. This is because vertex processing is omitted when the CMDL file is not output in order to shorten the processing time. Nothing is affected by the differing values for <CODE>HasSkinningMatrix</CODE>.
</p>
<br />

<br />


<h4><span id="options_optimization">Optimization Options</span></h4>
<p>You can optimize data using CreativeStudio when outputting intermediate files from 3ds Max. Options for this optimization process are set here.</p>

<center><img src="images/OptimizeOpt1.gif" alt="OptimizeOpt1" />
</center><br />

<iframe id="CommonCompressNode" src="../../common/CommonCompressNode.html" frameborder="0" scrolling="auto" width="100%" height="1500"></iframe>


<h4><span id="options_quantization">Quantization Options</span></h4>
<p>This option is for setting the degree of precision to use for vertex data when converting to binary data. <br /> If a fixed-point number is used, the amount of data is less than when a floating-point number is used, but precision is lowered.</p>
<center><img src="images/QuantizeOpt1.gif" alt="QuantizeOpt1" />
</center>

<iframe id="CommonQuantization" src="../../common/CommonQuantization.html" frameborder="0" scrolling="auto" width="100%" height="400px"></iframe>


<h4><span id="options_model">Model Options</span></h4>
<p>These are model-related options.</p>
<center><img src="images/ModelOpt1.gif" alt="ModelOpt1" />
</center>
<br />


<iframe id="CommonModelOption1" src="../../common/CommonModelOption1.html" frameborder="0" scrolling="auto" width="100%" height="800"></iframe>

	<table class="table">
		<tbody>
		<tr>
			<td colspan="2"><strong>Example of valid data: Node configuration on Max3ds</strong></td>
		</tr>
		<tr>
			<td> <img src="images/rigidskin_preview.gif" border="0" alt="rigidskin_preview" height="200" /> </td>

			<td> <img src="images/rigidskin_structure.gif" border="0" alt="rigidskin_structure" /> </td>
		</tr>
		</tbody>
	</table>

<iframe id="CommonModelOption2" src="../../common/CommonModelOption2.html" frameborder="0" scrolling="auto" width="100%" height="550"></iframe>


<h4><span id="options_anim">Animation Options</span></h4>
<p>These are animation-related options.</p>
<center><img src="images/AnimOpt1.gif" alt="AnimOpt1" />
</center>

<iframe id="CommonAnimationOption" src="../../common/CommonAnimationOption.html" frameborder="0" scrolling="auto" width="100%" height="1400px"></iframe>


<h4><span id="options_tolerance">Tolerance Options</span></h4>
<p>This option specifies the allowable range of errors when animation curve data is optimized.</p>
<center><img src="images/ToleranceOpt1.gif" alt="ToleranceOpt1"/>
</center>
<br /> <iframe id="CommonTolerance" src="../../common/CommonTolerance.html" frameborder="0" scrolling="auto" width="100%" height="400"></iframe>

<h4><span id="manage_options">Managing Option Settings</span></h4>
<p>To input or output the option settings as a C3ES (CTR 3D Export Settings) file, use the <B>NW4C Settings</B> menu item in the Options window.</p>
<center><img src="images/LoadSaveSettings.gif" alt="LoadSaveSettings" />
</center>
<br />

<h4><span id="scene_settings">Saving Option Settings for a Scene</span></h4>
<p>
    If <B>Save / Load Scene Settings</B> is selected (the default), the option settings used the last time an intermediate file was output will be saved as scene data when a scene is saved. When the scene is opened, the option settings that were saved in the scene data are loaded. The current option settings remain if option settings were not saved with the scene data. Furthermore, an option setting is loaded when a scene for which option settings have been saved is imported.
</p>
<p>
    If <strong>Save / Load Scene Settings</strong> is cleared, no option settings are saved with the scene. Furthermore, option settings are not loaded when scene data is opened.<br />
</p>
<p>
    Regardless of whether <strong>Save/Load Scene Settings</strong> is on or off, option settings at the time an intermediate file was last output are saved as a default settings file.<br /> In addition, this default settings file is loaded at time of next startup.<BR> The default settings file is saved under the name nw4cmax.c3es in the plug-in settings folder C:\Documents and Settings\[user_name]\Local Settings\Application Data\Autodesk\3dsmax\[max_version]\jpn\plugcfg.
</p>
<p>
    To delete the option settings saved in the scene data, click <B>Reset Scene Settings</B>.
</p>
<p>
    To delete the option settings that were saved in the scene data, click <B>Delete Scene Settings</B>. However, this only works if you clear <B>Save / Load Scene Settings</B> and then save the scene data. If you do not save the scene data, the option settings are retained.
</p>

<h4><span id="c3es_file">Loading/Saving Option Settings Using C3ES Files</span></h4>
<p>
To output option settings to a C3ES file, click <B>Save Settings to r3es File</B>. Option settings will be output when an output file name is specified on the file selection window. If the extension of the output file is other than .c3es, .c3es will be added automatically.
</p>
<p>
Click <B>Load Settings from c3es File</B> to enter option settings from a C3ES file. Option settings will be input when an input file name is specified on the file selection window.
</p>
<br />


<h2><span id="error_warning">Errors and Warnings</span></h2>

<h3><span id="erroroutput">Error Verification</span></h3>
<p>If an error or warning occurs during export, it will be output to the listener window.</p>
<p>Some errors are also displayed in a message box.</p>
<br />

<h3><span id="errors">Error Types and Handling Errors</span></h3>
<p>The error list as currently implemented is presented below in alphabetical order.</p>
<p>When an error is detected, the Export process halts.</p>
<br />

<ul>
<li><strong>Can't open file</strong>
<p>This error occurs when the file does not exist, cannot be opened, or cannot be overwritten.</p>
</li>

<li><strong>CreativeStudio cannot be found</strong>
<p>CreativeStudio has not been correctly installed.<br /> CreativeStudio must be installed in the folder <CODE>tools\CreativeStudio</CODE>, located beneath the folder defined by the environment variable <CODE>NW4C_ROOT</CODE>. If the environment variable <strong>NW4C_ROOT</strong> is not defined correctly, correct the definition and restart 3ds Max.</p>
</li>

<li><strong>Failed to start CreativeStudio</strong>
<p>CreativeStudio has failed to start. Be sure to check CreativeStudio error output.</p>
</li>

<li><strong>3DEditor cannot be found</strong>
<p>3D editor has not been correctly installed.<br /> 3DEditor must be installed in the folder <CODE>3DEditor</CODE>, located beneath the folder defined by the environment variable <CODE>NW4R_ROOT</CODE>. If the environment variable <strong>NW4C_ROOT</strong> is not defined correctly, correct the definition and restart 3ds Max.</p>
</li>

<li><strong>Failed to start 3DEditor</strong>
<p>Failed to start the 3D editor. Check for error output from 3DEditor.</p>
</li>


<li><strong>Influence object is not outputted</strong>
<p>Nodes affected by skinning are not output. This error arises when Export Target is set as selection and nodes affected by skinning are not selected, or when no envelope has been assigned to a vertex even though a skinning modifier and Physique modifier are being applied.
</p>

</li>

<li><strong>Path of cmdl file to merge is wrong</strong>
<p>This error occurs if the path for the CMDL file to be merged is left blank or if the filename contains illegal characters.</p>
</li>
<li><strong>No effective node</strong>
<p>There is no active node to be output.</p>
</li>

<li><strong>No output file</strong>
<p>This error occurs when the output specifications for the intermediate file are all cleared, or when only the output specifications for texture data are selected but there is no texture to output.</p>
</li>

<li><strong>Output File Name is wrong</strong>
<p>This error occurs if the Export option Output File Name is left blank or if the filename contains illegal characters.</p>
</li>

<li><strong>Output Folder is wrong</strong>
<p>This error occurs if the Export option Output Folder Name is left blank or if the filename contains illegal characters.</p>
</li>

<li><strong>Same user attribute exists</strong>
<p>More than one vertex color exists for the user vertex attribute of the given number. For example, this error would occur if there were vertex colors with the names <I>nw4cUser0</I> and <I>nw4cUser0_b</I> for the same single object. Either delete the unnecessary vertex colors or change their names.</p>
</li>

<li><strong>Texture size is wrong</strong>
<p>A texture has a size whose height and width cannot be handled by CTR. Height and width must both be set to a power of two equal to or greater than 8 and equal to or less than 1024.</p>
</li>


<li><strong>The number of vertices exceeds the limitation</strong>
<p>The number of mesh vertices excess the limit (65535). If this error occurs, divide up the pertinent mesh to get the appropriate size.</p></li>


<li><strong>Polygon bone size is over</strong>
<p>The number of bones used by a polygon exceeds the maximum number of bones that can be referenced by a primitive.<BR> If an error occurs, adjust the <a href="export.html#options_model">Max Reserved Uniform Registers option</a> to decrease the number of uniform registers being reserved.
</p></li>

<li><strong>Max Reserved Uniform Registers is wrong</strong>
<p>An out-of-bounds value has been specified for the <a href="export.html#options_model">Max Reserved Uniform Registers option</a>.<br /> The setting value must range from 0 to 57 (from 0 to 54 when the <a href="export.html#options_model">Non-Uniform Scale option</a> is ON.
</p></li>

</ul>
<br />


<h3><span id="warnings">Warning Types and Handling Warnings</span></h3>
<p>The Warning List, as it is currently implemented, is presented below in alphabetical order.</p>
<p>The Export process will continue, even if a warning is detected.</p>
<br />

<ul>

<li><strong>Custom Animation Range was trimmed</strong>
<p>The specified output range exceeds the playback range of 3ds Max. The output range is changed to fit within the playback range of 3ds Max.</p>
</li>

<li><strong>Node has no material</strong>
<p>No material has been set for a node being output. A dummy material is output.</p>
</li>

<li><strong>Texture file doesn't exist.</strong>
<p>The allocated texture does not exist. If a path is included in the file name for the texture allocated for a material, the image saved in the path is accessed during output. This error occurs when no image exists on the path. Furthermore, if the texture file name does not include a path, images in the directory where the current max file exists are accessed.</p>
</li>

<li><strong>The number of composite textures is over 3</strong>
<p>This error is issued if more than three textures are set for a material. Make sure the number of textures used by a material is three or less.</p>
</li>

<li><strong>Can't get UV data for generating the tangent</strong>
<p>This error occurs when UV data used to calculate the tangent used by an anisotropic reflection shader cannot be found.</p>
</li>

<li><strong>Map channel does not exist</strong>
<p>
The channel <B>n</B> map is set in the objects for which a map channel <B>n</B> does not exist.<br /> Because normal output cannot occur in this state, output is performed by forcibly pasting the UV information for map channel 1.
</p>
</li>


<li><strong>Material name is changed</strong>
<p>A material name output to the intermediate file was changed because two or more materials had the same name.</p>
</li>

<li><strong>Node name is changed</strong><br />
<p>This warning occurs when two or more nodes have the same name, when illegal characters are included in a node name, or when the node name to be output to the intermediate file is changed.</p>
</li>

<li><strong>Texture name is changed</strong>
<p>The texture name contains illegal characters. Illegal characters are converted to an underscore (<CODE>_</CODE>) and output as such.</p>
</li>

<li><strong>There are multiple texture files with the same name</strong>
<p>There are two or more texture files with the same filename as the export target, but in different folders or with a different extension. Make sure that there is only one CTEX file to be output.</p>
</li>

<li><strong>Texture type is not supported</strong>
<p>The only texture maps that can be used are mipmaps, normal maps and composite maps.</p>
</li>

<li><strong>Zero normal exists</strong>
<p>A normal vector that has length 0 exists. Lighting effects will not be carried out normally. Fix this using some means like the <CODE>Edit normal</CODE> modifier or a smoothing group.</p>
</li>


<li><strong>Inherits of node link info is off</strong>
<p>One of &quot;Hierarchy,&quot; &quot;Link Information,&quot; or &quot;Inheritance&quot; for the node is OFF.  Objects will not display correctly if this is not selected.</p>
</li>


<li><strong>Billboard Type is ignored if 'Convert To Model' option is ON</strong>
<p>Billboard settings are not output when the <B>Convert to Model</B> option is turned ON.</p>
</li>


</ul>

<hr><p>CONFIDENTIAL</p></body>
</html>