aboutsummaryrefslogtreecommitdiff
path: root/docs/_source/authoring_tool.txt
blob: cfa614539c1dc1f8779d1b64ef9ad369ea05bef0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*! \page pageauthoring AuthoringTool

The application <b>AuthoringTool</b> is a command-line asset authoring utility.  It reads a file containing a single graphics mesh
(currently .fbx and .obj format are supported in this tool), and fractures it according to the parameters given in the command line.
The user can configure the output of the tool. It can save render mesh geometry to .fbx or .obj files. It also optionally could save 
collision geometry in the same .fbx file.

Additionally, the user can choose how Blast&tm; data should be saved (in .blast file):

  1) LL-asset which is Low Level asset data (NvBlastAsset). Default mode.

  2) Tk-asset which is Toolkit asset data (Nv::Blast::TkAsset).

	3) ExtPx-asset which incorporates Blast&tm; data and collision geometry for physics engine (Nv::Blast::ExtPxAsset). 

.blast and .obj files may be consumed by the \ref pagesampleassetviewer.

This tool uses the Authoring Tools Extension (\ref pageextauthoring).  Therefore the restrictions on the input mesh are those of the authoring tools, see \ref fracturemeshrestrictions.


\verbatim



USAGE: 

   AuthoringTool_x64.exe  [--ovar <by default
                            0.0>] [--avar <by default 0.0>]
                            [--slices <by default 1 1 1>]
                            [--radius <by default 1.0>]
                            [--clusters <by default 5>]
                            [--cells <by default 5>] [--mode <v
                            - voronoi, c - clustered voronoi, s
                            - slicing.>] [--nonskinned]
                            [--fbxcollision] [--fbx] [--obj]
                            [--fbxascii] [--tk] [--px]
                            [--clean] [--outputDir <by default
                            directory of the input file>] [--]
                            [--version] [-h] <infile> <output
                            asset name>


Where: 

   --ovar <by default 0.0>
     Slicing offset variation

   --avar <by default 0.0>
     Slicing angle variation

   --slices <by default 1 1 1>
     Number of slices per direction

   --radius <by default 1.0>
     Clustered Voronoi cluster radius

   --clusters <by default 5>
     Uniform Voronoi cluster count

   --cells <by default 5>
     Voronoi cells count

   --mode <v - voronoi, c - clustered voronoi, s - slicing.>
     Fracturing mode

   --nonskinned
     Output a non-skinned FBX file

   --fbxcollision
     Add collision geometry to FBX file

   --fbx
     Output a FBX mesh to the output directory

   --obj
     Output a OBJ mesh to the output directory

   --fbxascii
     Output FBX as an ascii file (defaults to binary output)

   --tk
     Output TkAsset to the .blast file in the output directory instead of
     LL Blast asset (NvBlastAsset).

   --px
     Output ExtPxAsset to the .blast file in the output directory instead
     of LL Blast asset (NvBlastAsset).

   --clean
     Try cleaning mesh before fracturing

   --outputDir <by default directory of the input file>
     Output directory

   --,  --ignore_rest
     Ignores the rest of the labeled arguments following this flag.

   --version
     Displays version information and exits.

   -h,  --help
     Displays usage information and exits.

   <infile>
     (required)  File to load

   <output asset name>
     (required)  Output asset name


   Blast SDK: Authoring Tool




\endverbatim

<br>
See \ref pagecopyrights for license information regarding third-party software used by ApexImporter.

<br>
*/