Softimage/html/data_plugins.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<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>Data Creation Plug-Ins</title>
</head>
<body>
<h1>Data Creation Plug-Ins</h1>
<p>The data creation plug-ins are a group of plug-ins that aid in the creation of data for NintendoWare.</p>
<p>
The plug-ins are used to set NintendoWare attributes and search for settings primarily for nodes in Softimage.
</p>
<p>
The data creation plug-ins are executed from the NW4C main menu.
</p>
<p>
<a href="#kind">The Types of Data Creation Plug-Ins</a><br />

</p>

<h2><a name="kind">The Types of Data Creation Plug-Ins</a></h2>
<p>The following table shows a list of data creation plug-ins.</p>
<table class="arguments"><tbody><tr>
<tr>
<td>Plug-In Name</td>
<td>Description</td>
</tr>
<tr>
<td valign="top"><a href="#mat_attr">NW4C Set Material Attribute</a></td>
<td>Sets attributes for materials.</td>
</tr>
<tr>
<td valign="top"><a href="#render_priority">NW4C Set Render Priority</a></td>
<td>Sets the polygon rendering priority for materials.</td>
</tr>
<tr>

<tr>
<td valign="top"><a href="#no_compress_node">NW4C Set No Compress Node</a></td>
<td>Sets the node compression disable flag for nodes.</td>
</tr>
<tr>
<td valign="top"><a href="#billboard">NW4C Set Billboard</a></td>
<td>Sets a billboard for nodes.</td>
</tr>
<tr>
<td valign="top"><a href="#combineGroup">NW4C Set Combine Group</a></td>
<td>Sets a combine group for nodes.</td>
</tr>

<tr>
<td valign="top"><a href="#user_data">NW4C Set User Data</a></td>
<td>Allows user data to be set for nodes, materials, cameras, and/or lights.</td>
</tr>

<tr>
<td valign="top"><a href="#forceExportKey">NW4C Set Force Export Key</a></td>
<td>Sets the forced output of animation keys for nodes.</td>
</tr>
</tbody></table>


<h2>
<a NAME="mat_attr"></a>Plug-In for Setting Material Attributes (NW4C Set Material Attribute)
</h2>
<p>
Sets the NintendoWare material attributes for materials. Note, however, that this is not reflected on the XSI screen. It is also possible to search for settings. To display properties, click <B>NW4C</B> and select <STRONG>NW4C Set Material Attribute...</STRONG>.<br />

</p>
<p><img SRC="images/SetMatAttr1.gif" BORDER=0 width="500" height="458" ></p>

<h3>
<a NAME="mat_attr_set1"></a>Setting Method</h3>

<p>
Select an object, polygon cluster, or material (multiple selections are allowed), and then click NW4C and select NW4C Set Material Attribute, and the Properties page will appear. If you select an object, you can set the global material of that object. If you select a polygon cluster, you can set the local material of that polygon cluster.<br /> Once set, the <CODE>Custom-NW4CMaterialAttrSet</CODE> property is created below the Material node.<br /> If the NW4CMaterialAttrProp property is already set, the property currently set is displayed.
</p>

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


<h3>
<a NAME="mat_attr_search"></a>Searching for Attributes
</h3>
<p>
Select <b>Search</b>, and click the <b>Search</b> button to select and display the corresponding <CODE>NW4C_MaterialAttrProp</CODE> property.<br /> If the <B>and</B> radio button located to the left of the <B>Search</B> button is selected, a search is made for the materials which have the same attributes. If the <B>or</B> radio button is selected, a search is made for materials with at least one of the same attributes. If no radio buttons are selected, attributes are excluded from search conditions.
</p>

<h2>
<a NAME="render_priority"></a>Plug-In for Setting the Rendering Priority of Polygons (NW4C Set Render Priority)
</h2>
<p>
Sets the polygon rendering priority for materials. It is also possible to search for settings.<br /> To display properties, click <B>NW4C</B> and select <B>NW4C Set Render Priority</B>.<br />
<p></p>


<p><img SRC="images/SetRenderPriority1.gif" BORDER=0>

<h3>
<a NAME="render_priority_set"></a>Setting Method
</h3>

<p>
Select an object, polygon cluster, or material (multiple selections are allowed), and then click NW4C and select NW4C Set Render Priority, and Properties will appear. If you select an object, the global material of that object is set. If you select a polygon cluster, the local material of that polygon cluster is set.<br /> Using the radio buttons, select <B>Don't care</B> (no render priority specification) or <B>Care</B>. When specifying as a numeric value, enter an integer ranging from 1 to 255 for the priority. Polygons with the materials that have the lowest values are rendered first. If there is more than one material with the same value, the order in which the polygons are rendered is undefined (that is, it depends on the rendering routine). It is possible to make multiple selections and change all selected nodes at once.<br /> Once set, the <CODE>Custom-NW4CRenderPriorityProp</CODE> property is created below the Material node.<br /> If the NW4CRenderPriorityProp property is already set, the property currently set is displayed.
</p>

<h3>
<a NAME="render_priority_search"></a>Searching for Attributes
</h3>
<p>
Select <b>Don't care</b> in the <b>Search</b> field (no rendering priority specified), or select a conditional specification and click the <b>Search</b> button to select the corresponding <CODE>NW4C_RenderPriorityPSet</CODE> property.<BR> The following conditions can be selected: under (&lt;), below (&lt;=), exactly (=), above (&gt;=), and over (&gt;). below), equal (= : exactly), over (&gt;= : above), over(&gt; : over). Integers from 1 to 255 can be specified for the numeric value.
</p>

<h2>
<a NAME="render_priority_list"></a>Plug-In for Setting the Rendering Priority of Polygons, List Version (NW4C Render Priority List)
</h2>
<p>
The rendering priority of polygons in a scene may be set in list format.<br /> To display the property window, click NW4C and select NW4C Render Priority List.
</p>

<p><img SRC="images/SetRenderPriorityList.gif" BORDER=0>
<h3>
<a NAME="render_priority_set"></a>Setting Method
</h3>

<p>
Clicking the <strong>Update</strong> button in the lower left corner of the window will display the scene rendering priority in list format.<br /> Here, <B>Don't care</B> is displayed as 0.
</p>

<p>
To select an object or a polygon cluster, click on the name of a material in the list.<br /> If the <B>Frame Objects</B> checkbox is ON at this time, the corresponding polygons will fill the view.
</p>

<p>
Clicking the <strong>Priority</strong> or <STRONG>Material</STRONG> button will sort the list by rendering priority or material name, respectively.<br /> Clicking the same button twice will reverse the sorting order.<br /> Under the initial settings, sorting is performed in the ascending order of rendering priority.<br /> Rendering priority may be changed individually, by clicking the <STRONG>Edit</STRONG> button. Multiple rendering priorities may not be edited together.
</p>

<p>
To switch the rendering priority of the material directly above the currently selected one, click the <STRONG>Move Up</STRONG> button.<br /> In the same way, to switch the rendering priority of the material directly below the currently selected one, click on the <STRONG>Move Down</STRONG> button.
</p>


<h3>
<a NAME="render_priority_list_update"></a>Updating the List
</h3>
<p>
To update the list in an open window such that it reflects the addition of new materials, deletions, and name changes in the scene, click the <STRONG>Update</STRONG> button.
</p>


<h2><a name="no_compress_node">Plug-In for Disabling Node Compression (NW4C Set No Compress Node)</a></h2>
<p>Sets a flag so objects and nodes are not compressed even if the node compression feature is enabled. It is also possible to search for settings.<br /> <img src="images/SetNoCompressNode.gif"border="0">
<h3>
<a name="no_compress_node_set"></a>Setting Method
</h3>


<p>
Select a Null or joint node (multiple selections are possible), then click <B>NW4C</B> and select <B>NW4C Set No Compress Node</B> to display the property.<br /> The flag for disabling node compression can be changed by clicking the combo box. It is possible to make multiple selections and change all selected nodes at once.<br /> If <b>Compress this node if possible</b> is set, compression will be performed when the node compression function is enabled. This is the default.<br />

If <B>Don’t compress this node</B> is set, compression will never be performed even if the node compression function is enabled.<br /> Once set, the <CODE>NW4CNoCompProp</CODE> property is created below the selected node.<br /> If the NW4CNoCompProp property is already set, the property currently set is displayed.
</p>

<h3>
<a name="no_compress_node_search"></a>Searching for Attributes
</h3>
<p>
Select <b>Search</b>, and click the <b>Search</b> button to select the corresponding <CODE>NW4CNoCompProp</CODE> property. If multiple check boxes have been selected, a search is made for nodes that satisfy any of the settings.

</p>

<h2><a name="billboard">Plug-In for Setting Billboards (NW4C Set Billboard)</a></h2>
<p>Sets a billboard for nodes. However, the settings are not reflected in the 3ds Max Work View. It is also possible to search for settings.</p>
<p>To display the window, click NW4C → NW4C Set Billboard.</p><br/> <img src="images/SetBillboard1.gif"border="0"> <br/>

<br/>
<p><strong>Billboard Coordinates</strong></p>
<p>
The billboard feature is suitable for use when the z direction of local coordinates for a node is being used for the view direction.<BR> <img src="images/billboard-axis.gif"border="0" />
</p>

<br />

<p><strong>Setting Attributes</strong></p>
<p>When a node is selected (multiple selections are possible), the <strong>Set</strong> field displays current settings for the selected node(s).<br /> If multiple selections were made, the settings get displayed for the node that was selected first.</p>
<p>Billboard mode can be changed by clicking the combo box. If multiple nodes are selected, they can all be changed at once.</p>
<iframe id="CommonBillboard" src="../../common/CommonBillboard.html" frameborder="0" scrolling="auto" width="100%" height="250px"></iframe>


<p><strong>Searching for Attributes</strong></p>
<p>Select a <B>Search</B> field check box and click the <B>Search</B> button to select the corresponding nodes. If multiple check boxes have been selected, a search is made for nodes that satisfy any of the settings.
</p>
<br />

<h2><a name="combineGroup">Plug-in for Setting Combine Group (NW4C Set Combine Group)</a></h2>
<p>You can specify a range of nodes for optimization and grouping by specifying a combine group by number for those nodes. <BR> When setting a combine group, meshes that exist underneath nodes with different numbers are not combined. <BR> (For details on mesh combines, click <a href="../../common/CommonMeshCombine.html">Here</a>.)<br> <br>

To display the window, click NW4C → NW4C Set No Compress Node.</p>
<img src="images/SetCombineGroup.gif" alt="SetCombineGroup" border="0" />
<p><strong>Setting Attributes</strong></p>
<p>
When an object or node is selected (multiple selections are possible), the <strong>Set</strong> field displays current settings for the selected node(s).<br /> It is possible to make multiple selections and change all selected nodes at once.<br />
</p>
<p>
If <strong>Don't Care</strong> is selected, the value of the parent node is inherited. If the parent also has been set to <strong>Don't Care</strong> the combine group is not exported. This is the default.<br /> Values in the range of 0-255 can  be set for Combine Group.<br />
</p>
<p>
If you select multiple nodes and press <strong>Set Sequential</strong>, the node hierarchy will be configured from shallow to deep while incrementing the count one at a time from the specified value. If the value exceeds 255, a warning will display and the configuration process will not proceed.
</p>

<p><strong>Searching for Attributes</strong></p>
<p>
Select <strong>Don't care</strong> (that is, no specified combine group) in the <strong>Search</strong> field, or select a conditional specification and then click the <strong>Search</strong> button to display the pertinent materials. The following conditions can be selected: under (&lt;), below (&lt;=), exactly (=), above (&gt;=), and over (&gt;). below), equal (= : exactly), over (&gt;= : above), over(&gt; : over). Integers from 0 to 255 can be specified for the numeric value.<br />
</p>


<h2><a name="forceExportKey">Plug-in for setting the forced output of animation keys （NW4C Set Force Export Key）</a></h2>

<p>This plug-in sets the forced output of animation keys for nodes. It is also possible to search for settings.<br />

From the NW4C menu, run NW4C Set Force Export Key to display a window.</p>
<img src="images/SetForceExportKey.gif" border="0" />
<p>Selected file nodes are displayed in the <strong>Selected Nodes</strong> column.</p>

<p><strong>Setting Attributes</strong></p>
<p>When a node is selected (multiple selections are possible), the <strong>Set</strong> field displays current settings for the selected node(s).<br />

Animation key output settings can be changed by clicking the check box. If multiple nodes are selected, they can all be changed at once.</p><br />
<ul>
  <li><strong>Force Export Translate Key</strong></li>
  <li><strong>Force Export Rotate Key</strong></li>
  <li><strong>Force Export Scale Key</strong>
	  <p>These options specify whether to forcibly output the Translate, Rotate, and Scale value keys of skeletal animations. The default setting is OFF.<br /> If turned ON, at least one key will be output even if there is no animation or the value is the same as the bind pose. If turned OFF, no keys will be output for a skeletal animation if there is no animation or the value is the same as the bind pose.
	  </p>
  </li>
  <li><strong>Force Export Visibility Key</strong>
    <p>Specifies whether to forcibly output node visibility keys. The default setting is OFF.<br /> If set to ON, at least one key will be exported even if there is no animation.  If set to OFF, keys are not exported to the model animation file if there is no animation.
    </p>
  </li>
</ul><br />

<p>A different node can be set by selecting it without closing the window.</p>

<p><strong>Searching for Attributes</strong></p>
<p>Select the <B>Search</B> field check box and click the <B>Search</B> button to select the corresponding nodes. If the <B>and</B> radio button located above the <B>Search</B> button is selected, a search is made for all nodes that have the same attributes. If the <B>or</B> radio button is selected, a search is made for nodes with at least one of the same attributes. Items for which no check boxes are selected are excluded from search conditions.</p>


<h2><a name="user_data">Plug-in for Setting User Data (NW4C Set User Data)</a></h2>
<p>This plug-in sets user data for the object or material.<br /> From the NW4C menu, run NW4C Set User Data to display the window.</p>
<p><img src="images/SetUserData1.gif" border="0"></p>

<p><strong>Setting Attributes</strong></p>
<p>If <strong>only one</strong> object or material is selected, current settings for the selected node are shown in the window. New user data can be added by clicking the <strong>Add</strong> button. If an item in the list is selected, data is inserted in the selected location; if no item is selected, data is added to the end of the list. (The selection can be canceled by clicking &quot;-----&quot; at the bottom of the list.) The name and contents of existing user data can be changed by selecting an item in the list and clicking <strong>Edit</strong> or by double-clicking on the item.<br /> Selected user data can be deleted by selecting an item in the list and clicking <strong>Delete</strong>.<br /> The order of user data can be changed by selecting an item in the list and clicking <strong>Move Up</strong> or <strong>Move Down</strong>.<br /> A different object can be set by selecting another object without closing the window. <br /> A user data entry window can be displayed by clicking Add or Edit.</p>
<p><img src="images/SetUserData2.gif" border="0"></p>
<ul>
<li><strong>Name</strong>
  <p>Enter the name of user data. Double-byte characters and half-space kana characters cannot be used. Symbols other than the hyphen (-), underscore (_), and period (.) cannot be used.</p>
  </li>
<li><strong>Type</strong>
  <p>Specifies the type of user data. <B>String</B> is a character type, <B>Integer</B> is an integer type, and <B>Float</B> is a real number type.</p>
  </li>
<li><strong>Number or String</strong>
  <p>If Type is String, enter a text string.「&lt;」、「&gt;」、「&amp;」, single quotes, and double quotes cannot be used. More than one character string can be input by entering a return.</p>
  <p>If Type is Integer or Float, enter a numeric value. More than one numeric value can be entered by delimiting with a carriage return. (Only one value per row can be entered.)</p>
  </li>
</ul>
<p>User data can be added or changed by clicking <strong>OK</strong>. If the name, character string, or numeric value is invalid, an error will be displayed on the command line and in the script editor .</p>


<br />
<p>
Even if additional information just for NintendoWare has been set or, conversely, deleted, there will be no effect on the work view or data configuration under Softimage.<br /> <br />
</p>
<hr><p>CONFIDENTIAL</p></body>
</html>