 |
NDEVR
API Documentation
|
|
NDEVR
API Documentation
|
A container of input information that is to be filled with output information by an IOFactory. More...
Public Member Functions | |
| FactoryParameters (const FactoryParameters ¶ms) | |
| Copy constructor. | |
| FactoryParameters (const File &file, const FileFormat &format, const StringView &name="default") | |
| Constructs FactoryParameters from a file, format, and optional name. | |
| FactoryParameters (const FileRequest &request, const StringView &name="default") | |
| Constructs FactoryParameters from a FileRequest and optional name. | |
| void | addMissingFile (const DynamicPointer< FindFileFunction > &file) |
| Registers a missing file that the user needs to locate before the operation can complete. | |
| void | addWarning (const FileFactoryWarning &warning) |
| Adds a warning that will be shown to the user when the IOFactory operation is completed. | |
| const File & | file (const StringView &name="default") const |
| The address for reading/writing. | |
| FileFormat & | format (const StringView &name="default") |
| The format to read/write. | |
| const FileFormat & | format (const StringView &name="default") const |
| The format to read/write. | |
| FactoryParameters & | operator= (const FactoryParameters ¶ms) |
| Copy assignment operator. | |
| void | setInfoPipe (InfoPipe *pipe) |
| Sets the info pipe for streaming log messages or cancelling the operation. | |
| bool | shouldWriteModel (const Model &model) const |
| Checks whether a given model is in the list of models to be written. | |
Public Attributes | |
| std::function< bool(UUID library_id, Model &model)> | assign_to_library |
| Callback to assign a model to a specific library by UUID. | |
| Buffer< UUID > | cameras |
| UUIDs of cameras created or targeted by the operation. | |
| CancelInfo | cancel |
| Provides cancellation support for the operation. | |
| TranslatedString | custom_message |
| An optional custom message to display during the operation. | |
| String | custom_message_icon |
| An optional icon name for the custom message. | |
| DesignObjectLookup * | lookup = nullptr |
| The design object lookup used to resolve models and objects. | |
| Buffer< DynamicPointer< FindFileFunction > > | missing_files |
| Files that could not be found and require user input. | |
| Buffer< UUID > | models |
| UUIDs of models created or targeted by the operation. | |
| FactoryOptions | options |
| All read/write options including special parameters. | |
| ProgressInfo | progress |
| Tracks progress of the read/write operation. | |
| Dictionary< String, FileRequest > | requests |
| Maps name keys to FileRequest objects for multi-file formats. | |
| Buffer< FileFactoryWarning > | warnings |
| Any warnings to show to the user after the operation. | |
A container of input information that is to be filled with output information by an IOFactory.
FactoryParameters bundles together the file, format, options, and output state needed by an IOFactory read or write operation. It is passed into the factory and populated with results such as created model UUIDs, warnings, and missing file requests.
Definition at line 104 of file IOFactory.h.
| FactoryParameters::FactoryParameters | ( | const File & | file, |
| const FileFormat & | format, | ||
| const StringView & | name = "default" ) |
Constructs FactoryParameters from a file, format, and optional name.
| [in] | file | The file to read from or write to. |
| [in] | format | The file format to use. |
| [in] | name | An optional name key for multi-file formats (e.g., "default"). |
References file(), and format().
Referenced by FactoryParameters(), and operator=().
| FactoryParameters::FactoryParameters | ( | const FileRequest & | request, |
| const StringView & | name = "default" ) |
Constructs FactoryParameters from a FileRequest and optional name.
| [in] | request | The file request containing file and format information. |
| [in] | name | An optional name key for multi-file formats (e.g., "default"). |
| FactoryParameters::FactoryParameters | ( | const FactoryParameters & | params | ) |
Copy constructor.
| [in] | params | The FactoryParameters to copy from. |
References FactoryParameters().
| void FactoryParameters::addMissingFile | ( | const DynamicPointer< FindFileFunction > & | file | ) |
Registers a missing file that the user needs to locate before the operation can complete.
| [in] | file | The missing file request wrapped in a DynamicPointer. |
References file().
| void FactoryParameters::addWarning | ( | const FileFactoryWarning & | warning | ) |
Adds a warning that will be shown to the user when the IOFactory operation is completed.
| [in] | warning | The warning to add to the warnings list. |
| const File & FactoryParameters::file | ( | const StringView & | 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.
| [in] | name | The name key identifying which file to retrieve. |
Referenced by FactoryParameters(), and addMissingFile().
| FileFormat & FactoryParameters::format | ( | const StringView & | 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.
| [in] | name | The name key identifying which format to retrieve. |
| const FileFormat & FactoryParameters::format | ( | const StringView & | 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.
| [in] | name | The name key identifying which format to retrieve. |
Referenced by FactoryParameters().
| FactoryParameters & FactoryParameters::operator= | ( | const FactoryParameters & | params | ) |
Copy assignment operator.
| [in] | params | The FactoryParameters to copy from. |
References FactoryParameters().
| void FactoryParameters::setInfoPipe | ( | InfoPipe * | pipe | ) |
Sets the info pipe for streaming log messages or cancelling the operation.
| [in] | pipe | The InfoPipe to use for progress and cancellation. |
Referenced by GoogleEarthApplicationManager::createAppLauncher().
| bool FactoryParameters::shouldWriteModel | ( | const Model & | model | ) | const |
Checks whether a given model is in the list of models to be written.
| [in] | model | The model to check. |