A container of input information that is to be filled with output information by an IOFactory. More...

#include <IOFactory.h>

Collaboration diagram for FactoryParameters:

Public Member Functions
void	addWarning (const FileFactoryWarning &warning)
	Adds a warning that will be shown to the user when the IOFactory operation is completed.

	FactoryParameters (const File &file, const FileFormat &format, const String &name="default")

	FactoryParameters (const FileRequest &request, const String &name="default")

const File &	file (const String &name="default") const
	The address for reading/writing. If factory supports more than one file (eg: .obj and .mtl), the name parameter can specify which part to lookup.

FileFormat &	format (const String &name="default")
	The format to read/write. If factory supports more than one format (eg: .obj and .mtl), the name parameter can specify which part to lookup.

const FileFormat &	format (const String &name="default") const
	The format to read/write. If factory supports more than one format (eg: .obj and .mtl), the name parameter can specify which part to lookup.

bool	shouldWriteModel (const Model &model) const
	Checks to see if a given model is on the list.

Public Attributes
Buffer< UUID >	cameras

ProgressInfo *	log = nullptr

DesignObjectLookup *	lookup = nullptr

Buffer< UUID >	models

FactoryOptions	options

Dictionary< String, FileRequest >	requests

Buffer< FileFactoryWarning >	warnings

Detailed Description

A container of input information that is to be filled with output information by an IOFactory.

Constructor & Destructor Documentation

◆ FactoryParameters() [1/2]

FactoryParameters	(	const File &	file,
		const FileFormat &	format,
		const String &	name = "default" )

◆ FactoryParameters() [2/2]

FactoryParameters	(	const FileRequest &	request,
		const String &	name = "default" )

Member Function Documentation

◆ addWarning()

void addWarning ( const FileFactoryWarning & warning )

Adds a warning that will be shown to the user when the IOFactory operation is completed.

◆ file()

const File & file ( const String & name = "default" ) const

The address for reading/writing. If factory supports more than one file (eg: .obj and .mtl), the name parameter can specify which part to lookup.

◆ format() [1/2]

FileFormat & format ( const String & name = "default" )

The format to read/write. If factory supports more than one format (eg: .obj and .mtl), the name parameter can specify which part to lookup.

◆ format() [2/2]

const FileFormat & format ( const String & name = "default" ) const

The format to read/write. If factory supports more than one format (eg: .obj and .mtl), the name parameter can specify which part to lookup.

◆ shouldWriteModel()

bool shouldWriteModel ( const Model & model ) const

Checks to see if a given model is on the list.

Member Data Documentation

◆ cameras

Buffer<UUID> cameras

◆ log

ProgressInfo* log = nullptr

◆ lookup

DesignObjectLookup* lookup = nullptr

◆ models

Buffer<UUID> models

◆ options

FactoryOptions options

◆ requests

Dictionary<String, FileRequest> requests

◆ warnings

Buffer<FileFactoryWarning> warnings

The documentation for this struct was generated from the following file:

IOFactory/Headers/IOFactory.h

Public Member Functions

Public Attributes