Documentation Center public:dson_spec:object_definitions:region
/
2026-04-22T00:40:31+00:00Documentation Center
/
/lib/tpl/dazdoccenter/images/favicon.icotext/html2012-05-22T23:36:09+00:00region
/public/dson_spec/object_definitions/region/start
<h1 id="region">region</h1>
<div class="level1">
</div>
<h2 id="description">Description</h2>
<div class="level2">
<p>
Defines a hierarchy of regions using a series of vertex-weighted maps and region groups.
</p>
</div>
<h2 id="parent_objects">Parent Objects</h2>
<div class="level2">
<ul>
<li class="level1"><div class="li"> <a href="/public/dson_spec/object_definitions/geometry/start" class="wikilink1" title="public:dson_spec:object_definitions:geometry:start">geometry</a></div>
</li>
</ul>
</div>
<h2 id="properties">Properties</h2>
<div class="level2">
<div class="table sectionedit1"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Name </th><th class="col1"> Description </th><th class="col2"> Default </th><th class="col3"> Required </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> id </td><td class="col1"> A string representing the unique identifier within the region hierarchy. Must be unique within the region hierarchy. </td><td class="col2"> None </td><td class="col3"> yes </td>
</tr>
<tr class="row2">
<td class="col0"> label </td><td class="col1"> A string representing the user-facing name of this region. </td><td class="col2"> None </td><td class="col3"> no </td>
</tr>
<tr class="row3">
<td class="col0"> display_hint </td><td class="col1"> A string representing an application-specific hint about how to display the value for the region. Values can be “cards_on”, “cards_off”, etc. </td><td class="col2"> N/A </td><td class="col3"> no </td>
</tr>
<tr class="row4">
<td class="col0"> map </td><td class="col1"> An <a href="/public/dson_spec/format_description/data_types/start" class="wikilink1" title="public:dson_spec:format_description:data_types:start">int_array</a> of indices for all the polygons that are members of this region. </td><td class="col2"> N/A </td><td class="col3"> no </td>
</tr>
<tr class="row5">
<td class="col0"> children </td><td class="col1"> An array of child regions, either leaf nodes or group nodes. </td><td class="col2"> N/A </td><td class="col3"> no </td>
</tr>
</table></div>
<!-- EDIT1 TABLE [250-931] -->
</div>
<h2 id="details">Details</h2>
<div class="level2">
<p>
The <em>map</em> and <em>children</em> elements are mutually exclusive. If a <em>map</em> element is given, the region is a leaf node in the region hierarchy and may not have children. If a <em>children</em> element is present, the region is a group node in the region hierarchy and may not define its own map. All leaf nodes in the hierarchy must define a <em>map</em> element.
</p>
<p>
Polygons may exist in one and only one region. If a polygon index is given in multiple regions, the behavior is undefined.
</p>
</div>
<h2 id="example">Example</h2>
<div class="level2">
<pre class="code">{
"label" : "Root",
"children" :
[
{
"label" : "Torso",
"map" : [ 7, 8, 4, 9, 2 ]
},
{
"label" : "Lower Body",
"children" :
[
{
"label" : "Left Leg",
"map" : [ 0, 1, 3, 23, 45 ]
},
{
"label" : "Right Leg",
"map" : [ 5, 6, 10, 12, 13 ]
}
]
}
]
}</pre>
</div>