eu.printingin3d.javascad.utils

Class SaveScadFiles

java.lang.Object

eu.printingin3d.javascad.utils.SaveScadFiles

public class SaveScadFiles
extends Object

Helper class to save several models to a directory.

A typical usage looks like this:

new SaveScadFiles(new File("c:/temp"))
  .addModel("test.scad", new TestModel())
  .saveScadFiles();
 

Author:

ivivan

Constructor Summary

Constructors

Constructor and Description
SaveScadFiles(File root) Creates the object with the given root directory.

Method Summary

Modifier and Type	Method and Description
SaveScadFiles	addModel(String fileName, Abstract3dModel model, IScadGenerationContext scadContext) Deprecated.
SaveScadFiles	addModel(String fileName, IModel model) Adds a SCAD file with the given file name and the given model using the default generation context.
SaveScadFiles	addModel(String fileName, IModel model, IColorGenerationContext context) Adds a SCAD file with the given file name and the given model.
SaveScadFiles	addModel(String fileName, IModel model, ITagColors tagColors) Adds a SCAD file with the given file name and the given model.
SaveScadFiles	addModelProvider(IModelProvider provider) Adds a model provider with the default generation context.
SaveScadFiles	addModelProvider(IModelProvider provider, IColorGenerationContext context) Adds a model provider with the given color context.
SaveScadFiles	addModelProvider(IModelProvider provider, ITagColors tagColors) Adds a model provider with the given tag colors.
SaveScadFiles	addModels(String fileName, Collection<IModel> models) Adds a SCAD file with the given file name and the given model list.
SaveScadFiles	addModels(String fileName, Collection<IModel> models, IColorGenerationContext context) Adds a SCAD file with the given file name and the given model list.
SaveScadFiles	addScadFile(IScadFile scadFile) Adds a SCAD file.
SaveScadFiles	addScadFiles(Collection<IScadFile> scadFile) Adds a collection of SCAD files.
void	saveScadFiles() Save the added SCAD files into the corresponding files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SaveScadFiles

public SaveScadFiles(File root)
              throws IllegalValueException

Creates the object with the given root directory.

Parameters:

root - the root directory where the files will be saved

Throws:

IllegalValueException - if the root is null or exists as a file

Method Detail

addScadFile

public SaveScadFiles addScadFile(IScadFile scadFile)

Adds a SCAD file.

Parameters:

scadFile - the SCAD file to be saved

Returns:

return this object to make it possible to chain more method call

addScadFiles

public SaveScadFiles addScadFiles(Collection<IScadFile> scadFile)

Adds a collection of SCAD files.

Parameters:

scadFile - the SCAD files to be saved

Returns:

return this object to make it possible to chain more method call

addModels

public SaveScadFiles addModels(String fileName,
                               Collection<IModel> models)

Adds a SCAD file with the given file name and the given model list.

Parameters:

fileName - the name of the file where the model will be saved

models - the models to be saved

Returns:

return this object to make it possible to chain more method call

addModels

public SaveScadFiles addModels(String fileName,
                               Collection<IModel> models,
                               IColorGenerationContext context)

Adds a SCAD file with the given file name and the given model list.

Parameters:

fileName - the name of the file where the model will be saved

models - the models to be saved

context - the context used for the scad file generation

Returns:

return this object to make it possible to chain more method call

addModel

public SaveScadFiles addModel(String fileName,
                              IModel model)

Adds a SCAD file with the given file name and the given model using the default generation context. A default Consts is added before the model.

Parameters:

fileName - the name of the file where the model will be saved

model - the model to be saved

Returns:

return this object to make it possible to chain more method call

addModel

public SaveScadFiles addModel(String fileName,
                              IModel model,
                              ITagColors tagColors)

Adds a SCAD file with the given file name and the given model. A default Consts is added before the model.

Parameters:

fileName - the name of the file where the model will be saved

model - the model to be saved

tagColors - the colors used for the scad file generation

Returns:

return this object to make it possible to chain more method call

addModel

public SaveScadFiles addModel(String fileName,
                              IModel model,
                              IColorGenerationContext context)

Adds a SCAD file with the given file name and the given model. A default Consts is added before the model.

Parameters:

fileName - the name of the file where the model will be saved

model - the model to be saved

context - the color context used for the scad file generation

Returns:

return this object to make it possible to chain more method call

addModel

@Deprecated
public SaveScadFiles addModel(String fileName,
                                           Abstract3dModel model,
                                           IScadGenerationContext scadContext)

Deprecated.

Adds a SCAD file with the given file name and the given model. A default Consts is added before the model.

A method for backward compatibility only - use addModel(fileName, model.subModel(context)) instead.

Parameters:

fileName - the name of the file where the model will be saved

model - the model to be saved

scadContext - the context used for the scad file generation

Returns:

return this object to make it possible to chain more method call

addModelProvider

public SaveScadFiles addModelProvider(IModelProvider provider)

Adds a model provider with the default generation context. A default Consts is added before the model.

Parameters:

provider - the provider to be added

Returns:

return this object to make it possible to chain more method call

addModelProvider

public SaveScadFiles addModelProvider(IModelProvider provider,
                                      ITagColors tagColors)

Adds a model provider with the given tag colors. A default Consts is added before the model.

Parameters:

provider - the provider to be added

tagColors - the tag-color pairs to be used for the SCAD file generation

Returns:

return this object to make it possible to chain more method call

addModelProvider

public SaveScadFiles addModelProvider(IModelProvider provider,
                                      IColorGenerationContext context)

Adds a model provider with the given color context. A default Consts is added before the model.

Parameters:

provider - the provider to be added

context - the context used for the SCAD file generation

Returns:

return this object to make it possible to chain more method call

saveScadFiles

public void saveScadFiles()
                   throws IOException

Save the added SCAD files into the corresponding files.

Throws:

IOException - if any IO error happens during the file write