Used by 3ds Max and Maya visual exporters to validate the files before exporting, the set of rules is defined in bigworld/tools/res/visual_rules.xml. For more details, see the document Content Tools Reference Guide's chapter 3ds Max and Maya Exporters.
The grammar of visual_rules.xml is listed below:
<visual_rules.xml>
*<rule>
<identifier> string </identifier>
?<parent> string </parent>
?<exportAs> normal|static|static with nodes </exportAs>
?<path> folder </path>
?<filespec> string </filespec>
?<minSize> float float float </minSize>
?<maxSize> float float float </maxSize>
?<maxNodesPerRenderSet> integer </maxNodesPerRenderSet>
?<maxTriangles> integer </maxTriangles>
?<minTriangles> integer </minTriangles>
?<portals> true|false </portals>
?<portalSnap> float float float </portalSnap>
?<portalDistance> float </portalDistance>
?<portalOffset> float </portalOffset>
*<hardPoint> string </hardPoint>
?<checkUnknownHardPoints> true|false </checkUnknownHardPoints>
</rule>
</visual_rules.xml>Grammar of bigworld/tools/res/visual_rules.xml
The list below describes the tags in file visual_rules.xml:
-
checkUnknownHardPoints
Specified if the hard point not specified in the set of <hardPoint> tags should be flagged as error.
-
exportAs
Specifies how to save the visual. Can have one of the following values: normal, static, or static with nodes.
-
fileSpec
Matching criteria (using wildcards) specifying the visuals for which this rule applies to. This option is not inherited via the tag parent.
-
hardPoint
Name of the hard point that the visual must have. The set of hard points to check against is the one formed by all hard points mentioned in all parents. This tag may be defined multiple times for the same rule.
-
identifier
Name of the rule.
-
maxNodesPerRenderSetA
Maximum nodes allowed per renderset, i.e., how many bones each geometric element is allowed to use for skinning.
-
maxSizeA
Maximum size of the visual in metres.
-
maxTrianglesA
Maximum number of triangles in the visual.
-
minSizeA
Minimum size of the visual in metres.
-
minTrianglesA
Minimum number of triangles in the visual.
-
parent
Name of the rule from which to inherit options.
For each option, the plug-in will search up the hierarchy until it finds a match for it.
The options path and fileSpec are not inherited.
-
path
Resource folder which visuals this rule applies to.
This option is not inherited via the tag parent.
-
portalDistanceA
Number of which the distance between the origin and the portal must be a multiple of.
-
portalOffsetA
Number of which the centre of the portal must be a multiple of on the portal plane.
-
portals
Specifies if the visual may have portals.
-
portalSnapA
Number of which the bounding box of the portal must be a multiple of.
A value must be specified for each dimension.
A — A value of zero indicates that the option should not be checked