# IO

> Python API types

### CloudDirectory

Select between:

* local: [io.LocalDirectoryAccess](./io_types.md#localdirectoryaccess)
* openStack: [io.OpenStackAccess](./io_types.md#openstackaccess)
* dropBox: [io.DropBoxAccess](./io_types.md#dropboxaccess)
* ownCloud: [io.OwnCloudAccess](./io_types.md#owncloudaccess)
* webDAV: [io.WebDAVAccess](./io_types.md#webdavaccess)

***

### CloudFile

Select between:

* local: [io.LocalFileAccess](./io_types.md#localfileaccess)
* openStack: [io.OpenStackAccess](./io_types.md#openstackaccess)
* dropBox: [io.DropBoxAccess](./io_types.md#dropboxaccess)
* ownCloud: [io.OwnCloudAccess](./io_types.md#owncloudaccess)
* webDAV: [io.WebDAVAccess](./io_types.md#webdavaccess)

***

### DropBoxAccess

DropBox connection informations.
Fields

| Type  | Name   | Default | Description |
| ----- | ------ | ------- | ----------- |
| path  | String |         |             |
| token | String |         |             |

***

### ExportFilePath

File path of a supported file for export.
Base class: [core.OutputFilePath](./core_types.md#outputfilepath)


**Frame:**
```mermaid
classDiagram
    class ExportFilePath
    OutputFilePath <|-- ExportFilePath
```

Functions accepting this type or a list of this type as a parameter:

* [core.save](./core_functions.md#save)
* [core.generateActivationCode](./core_functions.md#generateactivationcode)
* [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode)
* [core.setCoreDumpFile](./core_functions.md#setcoredumpfile)
* [core.setLogFile](./core_functions.md#setlogfile)
* [io.exportScene](./io_functions.md#exportscene)
* [io.exportSelection](./io_functions.md#exportselection)
* [material.exportImage](./material_functions.md#exportimage)
* [view.takeScreenshot](./view_functions.md#takescreenshot)
* [core.load](./core_functions.md#load)
* [core.installLicense](./core_functions.md#installlicense)
* [core.getModuleDescFromXML](./core_functions.md#getmoduledescfromxml)
* [io.importPicture](./io_functions.md#importpicture)
* [io.importScene](./io_functions.md#importscene)
* [io.listVariants](./io_functions.md#listvariants)
* [io.splitPointCloud](./io_functions.md#splitpointcloud)
* [material.importImage](./material_functions.md#importimage)
* [scene.exportFilterLibrary](./scene_functions.md#exportfilterlibrary)
* [scene.importFilterLibrary](./scene_functions.md#importfilterlibrary)
* [algo.configureFunctionLogger](./algo_functions.md#configurefunctionlogger)
* [algo.bakeMaterialPropertyMap](./algo_functions.md#bakematerialpropertymap)
* [algo.bakeOccurrencePropertyMap](./algo_functions.md#bakeoccurrencepropertymap)
* [algo.sawWithAABB](./algo_functions.md#sawwithaabb)
* [algo.sawWithOBB](./algo_functions.md#sawwithobb)
* [algo.sawWithPlane](./algo_functions.md#sawwithplane)
* [cad.configureFunctionLogger](./cad_functions.md#configurefunctionlogger)
* [core.configureFunctionLogger](./core_functions.md#configurefunctionlogger)
* [core.getEvent](./core_functions.md#getevent)
* [core.getEvents](./core_functions.md#getevents)
* [core.getFunction](./core_functions.md#getfunction)
* [core.getFunctions](./core_functions.md#getfunctions)
* [core.getGroup](./core_functions.md#getgroup)
* [core.getGroups](./core_functions.md#getgroups)
* [core.getModuleTypes](./core_functions.md#getmoduletypes)
* [core.getType](./core_functions.md#gettype)
* [core.getTypeAttributes](./core_functions.md#gettypeattributes)
* [core.addWantedToken](./core_functions.md#addwantedtoken)
* [core.checkWebLogin](./core_functions.md#checkweblogin)
* [core.configureLicenseServer](./core_functions.md#configurelicenseserver)
* [core.needToken](./core_functions.md#needtoken)
* [core.ownToken](./core_functions.md#owntoken)
* [core.releaseToken](./core_functions.md#releasetoken)
* [core.releaseWebLicense](./core_functions.md#releaseweblicense)
* [core.removeWantedToken](./core_functions.md#removewantedtoken)
* [core.requestWebLicense](./core_functions.md#requestweblicense)
* [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses)
* [core.tokenValid](./core_functions.md#tokenvalid)
* [core.parallelStart](./core_functions.md#parallelstart)
* [core.removeModule](./core_functions.md#removemodule)
* [core.pushProgression](./core_functions.md#pushprogression)
* [core.addCustomProperties](./core_functions.md#addcustomproperties)
* [core.addCustomProperty](./core_functions.md#addcustomproperty)
* [core.getModuleProperty](./core_functions.md#getmoduleproperty)
* [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo)
* [core.getProperties](./core_functions.md#getproperties)
* [core.getProperty](./core_functions.md#getproperty)
* [core.getPropertyInfo](./core_functions.md#getpropertyinfo)
* [core.hasCustomProperty](./core_functions.md#hascustomproperty)
* [core.hasProperty](./core_functions.md#hasproperty)
* [core.listModuleProperties](./core_functions.md#listmoduleproperties)
* [core.removeCustomProperty](./core_functions.md#removecustomproperty)
* [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue)
* [core.setModuleProperty](./core_functions.md#setmoduleproperty)
* [core.setProperties](./core_functions.md#setproperties)
* [core.setProperty](./core_functions.md#setproperty)
* [core.unsetProperty](./core_functions.md#unsetproperty)
* [core.startUndoRedoStep](./core_functions.md#startundoredostep)
* [core.log](./core_functions.md#log)
* [geom.configureFunctionLogger](./geom_functions.md#configurefunctionlogger)
* [io.configureFunctionLogger](./io_functions.md#configurefunctionlogger)
* [io.addAssetPaths](./io_functions.md#addassetpaths)
* [io.findInDirectories](./io_functions.md#findindirectories)
* [io.setAssetPaths](./io_functions.md#setassetpaths)
* [io.importRemote3mxFile](./io_functions.md#importremote3mxfile)
* [io.registerIOCallbacks](./io_functions.md#registeriocallbacks)
* [io.getExtensionPriority](./io_functions.md#getextensionpriority)
* [material.addUniformProperty](./material_functions.md#adduniformproperty)
* [material.configureFunctionLogger](./material_functions.md#configurefunctionlogger)
* [material.createCustomMaterialPattern](./material_functions.md#createcustommaterialpattern)
* [material.createMaterial](./material_functions.md#creatematerial)
* [material.findCustomMaterialPatternByName](./material_functions.md#findcustommaterialpatternbyname)
* [material.findMaterialsByPattern](./material_functions.md#findmaterialsbypattern)
* [material.findMaterialsByProperty](./material_functions.md#findmaterialsbyproperty)
* [material.getPointsAndMaterialFromText](./material_functions.md#getpointsandmaterialfromtext)
* [material.getUniformPropertyType](./material_functions.md#getuniformpropertytype)
* [material.setCoeffOrTextureProperty](./material_functions.md#setcoeffortextureproperty)
* [material.setColorAlphaProperty](./material_functions.md#setcoloralphaproperty)
* [material.setColorOrTextureProperty](./material_functions.md#setcolorortextureproperty)
* [material.setFragmentShader](./material_functions.md#setfragmentshader)
* [material.setMaterialPattern](./material_functions.md#setmaterialpattern)
* [material.setVertexShader](./material_functions.md#setvertexshader)
* [material.createImageFromData](./material_functions.md#createimagefromdata)
* [polygonal.configureFunctionLogger](./polygonal_functions.md#configurefunctionlogger)
* [polygonal.createMeshFromText](./polygonal_functions.md#createmeshfromtext)
* [scene.configureFunctionLogger](./scene_functions.md#configurefunctionlogger)
* [scene.createOccurrence](./scene_functions.md#createoccurrence)
* [scene.createOccurrenceFromSelection](./scene_functions.md#createoccurrencefromselection)
* [scene.createOccurrenceFromText](./scene_functions.md#createoccurrencefromtext)
* [scene.createOccurrences](./scene_functions.md#createoccurrences)
* [scene.getActivePropertyValue](./scene_functions.md#getactivepropertyvalue)
* [scene.getActivePropertyValues](./scene_functions.md#getactivepropertyvalues)
* [scene.setOccurrenceName](./scene_functions.md#setoccurrencename)
* [scene.findOccurrencesByMetadata](./scene_functions.md#findoccurrencesbymetadata)
* [scene.findOccurrencesByProperty](./scene_functions.md#findoccurrencesbyproperty)
* [scene.createLight](./scene_functions.md#createlight)
* [scene.addMetadata](./scene_functions.md#addmetadata)
* [scene.addMetadataBlock](./scene_functions.md#addmetadatablock)
* [scene.getMetadata](./scene_functions.md#getmetadata)
* [scene.removeMetadata](./scene_functions.md#removemetadata)
* [scene.createAlternativeTree](./scene_functions.md#createalternativetree)
* [scene.createAnimation](./scene_functions.md#createanimation)
* [scene.getSubChannel](./scene_functions.md#getsubchannel)
* [scene.linkPropertyToAnimation](./scene_functions.md#linkpropertytoanimation)
* [scene.unlinkPropertyToAnimation](./scene_functions.md#unlinkpropertytoanimation)
* [scene.addFilterToLibrary](./scene_functions.md#addfiltertolibrary)
* [scene.findFilterByName](./scene_functions.md#findfilterbyname)
* [scene.setReferencedDataComponentPath](./scene_functions.md#setreferenceddatacomponentpath)
* [scene.addAnnotationGroup](./scene_functions.md#addannotationgroup)
* [scene.addVariant](./scene_functions.md#addvariant)
* [scene.duplicateVariant](./scene_functions.md#duplicatevariant)
* [unity.configureFunctionLogger](./unity_functions.md#configurefunctionlogger)
* [view.configureFunctionLogger](./view_functions.md#configurefunctionlogger)
* [view.getViewerProperty](./view_functions.md#getviewerproperty)
* [view.getViewerPropertyInfo](./view_functions.md#getviewerpropertyinfo)
* [view.setViewerProperty](./view_functions.md#setviewerproperty)
* [view.startRecording](./view_functions.md#startrecording)

***

### ExportFilePathList

List of [io.ExportFilePath](./io_types.md#exportfilepath)

***

### FileFormat

Describe the file format.
Fields

| Type                   | Name                  | Default         | Description                                                                        |
| ---------------------- | --------------------- | --------------- | ---------------------------------------------------------------------------------- |
| product                | String                |                 |                                                                                    |
| extension              | String                |                 |                                                                                    |
| version                | String                |                 |                                                                                    |
| priority               | PriorityImportLevel   | Priority\_1     |                                                                                    |
| read                   | Boolean               | False           |                                                                                    |
| write                  | Boolean               | False           |                                                                                    |
| hasTessellated         | FileFormatDescription | NOT\_APPLICABLE |                                                                                    |
| hasBREP                | FileFormatDescription | NOT\_APPLICABLE | B-rep support on import.                                                           |
| hasAlternativeImporter | FileFormatDescription | NOT\_APPLICABLE |                                                                                    |
| hasMetadata            | FileFormatDescription | NOT\_APPLICABLE |                                                                                    |
| hasPMI                 | FileFormatDescription | NOT\_APPLICABLE | PMI support on import.                                                             |
| osMask                 | Int                   | 7               | Mask based on Windows (1), Linux (2), OSX (4).                                     |
| hasBREPExport          | FileFormatDescription | NOT\_APPLICABLE | B-rep support on export (independent of hasBREP); only meaningful when write=true. |
| hasPMIExport           | FileFormatDescription | NOT\_APPLICABLE | PMI support on export (independent of hasPMI); only meaningful when write=true.    |

Functions accepting this type or a list of this type as a parameter:

* [io.registerIOCallbacks](./io_functions.md#registeriocallbacks)

***

### FileFormatDescription

Enumeration of option states.
Enum of [core.Int](./core_types.md#int)

| Name            | Value |
| --------------- | ----- |
| NO              | 0     |
| YES             | 1     |
| NOT\_APPLICABLE | 2     |

***

### FileFormatList

List of [io.FileFormat](./io_types.md#fileformat)

Functions accepting this type or a list of this type as a parameter:

* [io.registerIOCallbacks](./io_functions.md#registeriocallbacks)

***

### FilesList

List of [core.FilePath](./core_types.md#filepath)

Functions accepting this type or a list of this type as a parameter:

* [io.importFiles](./io_functions.md#importfiles)

***

### ImportFilePath

File path of a supported file for import.
Base class: [core.FilePath](./core_types.md#filepath)


**Frame:**
```mermaid
classDiagram
    class ImportFilePath
    FilePath <|-- ImportFilePath
```

Functions accepting this type or a list of this type as a parameter:

* [core.load](./core_functions.md#load)
* [core.installLicense](./core_functions.md#installlicense)
* [core.getModuleDescFromXML](./core_functions.md#getmoduledescfromxml)
* [io.importPicture](./io_functions.md#importpicture)
* [io.importScene](./io_functions.md#importscene)
* [io.listVariants](./io_functions.md#listvariants)
* [io.splitPointCloud](./io_functions.md#splitpointcloud)
* [material.importImage](./material_functions.md#importimage)
* [scene.exportFilterLibrary](./scene_functions.md#exportfilterlibrary)
* [scene.importFilterLibrary](./scene_functions.md#importfilterlibrary)
* [algo.configureFunctionLogger](./algo_functions.md#configurefunctionlogger)
* [algo.bakeMaterialPropertyMap](./algo_functions.md#bakematerialpropertymap)
* [algo.bakeOccurrencePropertyMap](./algo_functions.md#bakeoccurrencepropertymap)
* [algo.sawWithAABB](./algo_functions.md#sawwithaabb)
* [algo.sawWithOBB](./algo_functions.md#sawwithobb)
* [algo.sawWithPlane](./algo_functions.md#sawwithplane)
* [cad.configureFunctionLogger](./cad_functions.md#configurefunctionlogger)
* [core.configureFunctionLogger](./core_functions.md#configurefunctionlogger)
* [core.getEvent](./core_functions.md#getevent)
* [core.getEvents](./core_functions.md#getevents)
* [core.getFunction](./core_functions.md#getfunction)
* [core.getFunctions](./core_functions.md#getfunctions)
* [core.getGroup](./core_functions.md#getgroup)
* [core.getGroups](./core_functions.md#getgroups)
* [core.getModuleTypes](./core_functions.md#getmoduletypes)
* [core.getType](./core_functions.md#gettype)
* [core.getTypeAttributes](./core_functions.md#gettypeattributes)
* [core.addWantedToken](./core_functions.md#addwantedtoken)
* [core.checkWebLogin](./core_functions.md#checkweblogin)
* [core.configureLicenseServer](./core_functions.md#configurelicenseserver)
* [core.needToken](./core_functions.md#needtoken)
* [core.ownToken](./core_functions.md#owntoken)
* [core.releaseToken](./core_functions.md#releasetoken)
* [core.releaseWebLicense](./core_functions.md#releaseweblicense)
* [core.removeWantedToken](./core_functions.md#removewantedtoken)
* [core.requestWebLicense](./core_functions.md#requestweblicense)
* [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses)
* [core.tokenValid](./core_functions.md#tokenvalid)
* [core.parallelStart](./core_functions.md#parallelstart)
* [core.removeModule](./core_functions.md#removemodule)
* [core.pushProgression](./core_functions.md#pushprogression)
* [core.addCustomProperties](./core_functions.md#addcustomproperties)
* [core.addCustomProperty](./core_functions.md#addcustomproperty)
* [core.getModuleProperty](./core_functions.md#getmoduleproperty)
* [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo)
* [core.getProperties](./core_functions.md#getproperties)
* [core.getProperty](./core_functions.md#getproperty)
* [core.getPropertyInfo](./core_functions.md#getpropertyinfo)
* [core.hasCustomProperty](./core_functions.md#hascustomproperty)
* [core.hasProperty](./core_functions.md#hasproperty)
* [core.listModuleProperties](./core_functions.md#listmoduleproperties)
* [core.removeCustomProperty](./core_functions.md#removecustomproperty)
* [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue)
* [core.setModuleProperty](./core_functions.md#setmoduleproperty)
* [core.setProperties](./core_functions.md#setproperties)
* [core.setProperty](./core_functions.md#setproperty)
* [core.unsetProperty](./core_functions.md#unsetproperty)
* [core.startUndoRedoStep](./core_functions.md#startundoredostep)
* [core.log](./core_functions.md#log)
* [geom.configureFunctionLogger](./geom_functions.md#configurefunctionlogger)
* [io.configureFunctionLogger](./io_functions.md#configurefunctionlogger)
* [io.addAssetPaths](./io_functions.md#addassetpaths)
* [io.findInDirectories](./io_functions.md#findindirectories)
* [io.setAssetPaths](./io_functions.md#setassetpaths)
* [io.importRemote3mxFile](./io_functions.md#importremote3mxfile)
* [io.registerIOCallbacks](./io_functions.md#registeriocallbacks)
* [io.getExtensionPriority](./io_functions.md#getextensionpriority)
* [material.addUniformProperty](./material_functions.md#adduniformproperty)
* [material.configureFunctionLogger](./material_functions.md#configurefunctionlogger)
* [material.createCustomMaterialPattern](./material_functions.md#createcustommaterialpattern)
* [material.createMaterial](./material_functions.md#creatematerial)
* [material.findCustomMaterialPatternByName](./material_functions.md#findcustommaterialpatternbyname)
* [material.findMaterialsByPattern](./material_functions.md#findmaterialsbypattern)
* [material.findMaterialsByProperty](./material_functions.md#findmaterialsbyproperty)
* [material.getPointsAndMaterialFromText](./material_functions.md#getpointsandmaterialfromtext)
* [material.getUniformPropertyType](./material_functions.md#getuniformpropertytype)
* [material.setCoeffOrTextureProperty](./material_functions.md#setcoeffortextureproperty)
* [material.setColorAlphaProperty](./material_functions.md#setcoloralphaproperty)
* [material.setColorOrTextureProperty](./material_functions.md#setcolorortextureproperty)
* [material.setFragmentShader](./material_functions.md#setfragmentshader)
* [material.setMaterialPattern](./material_functions.md#setmaterialpattern)
* [material.setVertexShader](./material_functions.md#setvertexshader)
* [material.createImageFromData](./material_functions.md#createimagefromdata)
* [polygonal.configureFunctionLogger](./polygonal_functions.md#configurefunctionlogger)
* [polygonal.createMeshFromText](./polygonal_functions.md#createmeshfromtext)
* [scene.configureFunctionLogger](./scene_functions.md#configurefunctionlogger)
* [scene.createOccurrence](./scene_functions.md#createoccurrence)
* [scene.createOccurrenceFromSelection](./scene_functions.md#createoccurrencefromselection)
* [scene.createOccurrenceFromText](./scene_functions.md#createoccurrencefromtext)
* [scene.createOccurrences](./scene_functions.md#createoccurrences)
* [scene.getActivePropertyValue](./scene_functions.md#getactivepropertyvalue)
* [scene.getActivePropertyValues](./scene_functions.md#getactivepropertyvalues)
* [scene.setOccurrenceName](./scene_functions.md#setoccurrencename)
* [scene.findOccurrencesByMetadata](./scene_functions.md#findoccurrencesbymetadata)
* [scene.findOccurrencesByProperty](./scene_functions.md#findoccurrencesbyproperty)
* [scene.createLight](./scene_functions.md#createlight)
* [scene.addMetadata](./scene_functions.md#addmetadata)
* [scene.addMetadataBlock](./scene_functions.md#addmetadatablock)
* [scene.getMetadata](./scene_functions.md#getmetadata)
* [scene.removeMetadata](./scene_functions.md#removemetadata)
* [scene.createAlternativeTree](./scene_functions.md#createalternativetree)
* [scene.createAnimation](./scene_functions.md#createanimation)
* [scene.getSubChannel](./scene_functions.md#getsubchannel)
* [scene.linkPropertyToAnimation](./scene_functions.md#linkpropertytoanimation)
* [scene.unlinkPropertyToAnimation](./scene_functions.md#unlinkpropertytoanimation)
* [scene.addFilterToLibrary](./scene_functions.md#addfiltertolibrary)
* [scene.findFilterByName](./scene_functions.md#findfilterbyname)
* [scene.setReferencedDataComponentPath](./scene_functions.md#setreferenceddatacomponentpath)
* [scene.addAnnotationGroup](./scene_functions.md#addannotationgroup)
* [scene.addVariant](./scene_functions.md#addvariant)
* [scene.duplicateVariant](./scene_functions.md#duplicatevariant)
* [unity.configureFunctionLogger](./unity_functions.md#configurefunctionlogger)
* [view.configureFunctionLogger](./view_functions.md#configurefunctionlogger)
* [view.getViewerProperty](./view_functions.md#getviewerproperty)
* [view.getViewerPropertyInfo](./view_functions.md#getviewerpropertyinfo)
* [view.setViewerProperty](./view_functions.md#setviewerproperty)
* [view.startRecording](./view_functions.md#startrecording)

***

### ImportFilePathList

List of [io.ImportFilePath](./io_types.md#importfilepath)

***

### LocalDirectoryAccess

Local file.
Fields

| Type | Name          | Default | Description |
| ---- | ------------- | ------- | ----------- |
| path | DirectoryPath |         |             |

***

### LocalFileAccess

Local file.
Fields

| Type | Name     | Default | Description |
| ---- | -------- | ------- | ----------- |
| path | FilePath |         |             |

***

### OpenStackAccess

OpenStack connection informations.
Fields

| Type        | Name     | Default | Description |
| ----------- | -------- | ------- | ----------- |
| path        | String   |         |             |
| authUrl     | String   |         |             |
| region      | String   |         |             |
| user        | String   |         |             |
| password    | Password |         |             |
| domainId    | String   |         |             |
| projectId   | String   |         |             |
| container   | String   |         |             |
| objectStore | String   | swift   |             |

***

### OwnCloudAccess

OwnCloud connection informations.
Fields

| Type     | Name     | Default | Description |
| -------- | -------- | ------- | ----------- |
| path     | String   |         |             |
| authUrl  | String   |         |             |
| user     | String   |         |             |
| password | Password |         |             |

***

### PriorityImportLevel

Priority levels for importer.
Enum of [core.Int](./core_types.md#int)

| Name         | Value |
| ------------ | ----- |
| unavailable  | 0     |
| Priority\_1  | 1     |
| Priority\_2  | 2     |
| Priority\_3  | 3     |
| Priority\_4  | 4     |
| Priority\_5  | 5     |
| Priority\_6  | 6     |
| Priority\_7  | 7     |
| Priority\_8  | 8     |
| Priority\_9  | 9     |
| Priority\_10 | 10    |

***

### Protocol

Web access protocol.
Enum of [core.Int](./core_types.md#int)

| Name  | Value |
| ----- | ----- |
| HTTP  | 1     |
| HTTPS | 2     |

***

### VariantNameList

List of [core.String](./core_types.md#string)

***

### WebDAVAccess

WebDAV connection informations.
Fields

| Type     | Name     | Default | Description |
| -------- | -------- | ------- | ----------- |
| path     | String   |         |             |
| host     | String   |         |             |
| port     | UShort   | 0       |             |
| protocol | Protocol | HTTP    |             |
| user     | String   |         |             |
| password | Password |         |             |
| url      | String   |         |             |

***

### exportFileCallback

Functions accepting this type or a list of this type as a parameter:

* [io.registerIOCallbacks](./io_functions.md#registeriocallbacks)

***

### importFileCallback

Functions accepting this type or a list of this type as a parameter:

* [io.registerIOCallbacks](./io_functions.md#registeriocallbacks)