aboutsummaryrefslogtreecommitdiff
path: root/docs/_source/authoring_tool.txt
blob: 602aa97b8785509a325d5e6735234e0a29b112d2 (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
/*! \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.
User can configure output of tool. It can save render mesh geometry to .fbx or .obj file. 

Additionally user can set how Blast data should be saved:

	1) BPXA-asset which incorporates Blast data and collision geometry for physics engine. 

	2) LL-asset which is Low Level asset data

	3) Tk-asset which is Toolkit asset data

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


\verbatim

USAGE:

   AuthoringTool  <infile> <output asset name> [--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.>] 
											   [--block] [--proto]
                                       	       [--fbx] [--obj] [--fbxascii]
                                               [--ue4] [--ll] [--tk] [--bpxa]
                                               [--outputDir <by default directory of the input file>] [--]
                                               [--version] [-h]  


Where:

   Blast data output mode:

  	 --bpxa output BPXA asset
   	 --tk   output Toolkit asset
  	 --ll   output Low Level asset

   Blast data serialization mode:
   
	 --block - Serialize Blast asset as continuous block of memory	 
	 --proto - Serialize Blast asset with CapnProto
	 
   Render mesh geometry output mode:

	--fbx Output render mesh to .fbx file
	--obj Output render mesh to .obj file
	
		   
   --ue4 Enable output FBX with UE4 coordinate system	
	
   --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

   --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
   
   --radius <by default 0.5> 
	 Cluster radius for clustered Voronoi fracturing mode.

   --outputDir <output directory>
	 Result output directory. If is not specified, result will be saved to folder with input file.


   --,  --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.

\endverbatim

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

<br>
*/