ConvertCommandSettings class final

The parsed command line.

Constructors

ConvertCommandSettings({required List<String> inputs, String output = '.', bool dryRun = false, bool overwrite = false, String? assetPrefix, bool materials = true, String? reportPath, bool json = false, ModelSettings models = const ModelSettings(), bool split = false})

The settings for inputs: written to the current directory as one bundle each, with materials, no report file and text output, unless given.

const

Properties

assetPrefix → String?

--asset-prefix: what the paths a level document names start with; null takes the output directory as given, when it is relative.

final

dryRun → bool

--dry-run: read everything and report what would be written, but write nothing.

final

hashCode → int

The hash code for this object.

no setter, override

inputs → List<String>

The inputs as given: files, directories (every recognised file under them) or globs.

final

json → bool

--json: print the report as JSON (format f3d.cli) instead of text.

final

materials → bool

Whether a model's materials are also written as .fmat files; --no-materials turns it off.

final

models → ModelSettings

The options passed to every .f3d written: textures, mips, levels of detail, impostors, chunks.

final

output → String

-o: the directory every output is written under; . by default.

final

overwrite → bool

--overwrite: replace files that exist with different contents; without it such a conflict writes nothing and exits 4.

final

reportPath → String?

--report: a file the report is also written to as JSON; null for none.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

split → bool

Whether to keep the sidecar layout (--split): .fmat, .f3dmat, textures and level documents beside the .f3d, instead of one bundle per input.

final

Methods

copyWith({List<String>? inputs, String? output, bool? dryRun, bool? overwrite, String? assetPrefix, bool? materials, String? reportPath, bool? json, ModelSettings? models, bool? split, bool clearAssetPrefix = false, bool clearReportPath = false}) → ConvertCommandSettings

A copy with the given fields replaced. A clear… flag resets that nullable field to null, which passing null cannot say.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

parse(List<String> arguments) → ConvertCommandSettings

Parses arguments. Throws a ConvertUsageException saying what is wrong (an unknown option, a missing value, no input), or one whose ConvertUsageException.isHelp is set for -h and --help.