IO
Python API types
Read time 5 minutesLast updated 9 months ago
CloudDirectory
Select between:
- local: io.LocalDirectoryAccess
- openStack: io.OpenStackAccess
- dropBox: io.DropBoxAccess
- ownCloud: io.OwnCloudAccess
- webDAV: io.WebDAVAccess
CloudFile
Select between:
- local: io.LocalFileAccess
- openStack: io.OpenStackAccess
- dropBox: io.DropBoxAccess
- ownCloud: io.OwnCloudAccess
- webDAV: io.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
Functions accepting this type or a list of this type as a parameter:
- core.save
- core.generateActivationCode
- core.generateDeactivationCode
- core.setCoreDumpFile
- core.setLogFile
- io.exportScene
- io.exportSelection
- material.exportImage
- view.takeScreenshot
- core.load
- core.installLicense
- core.getModuleDescFromXML
- io.importPicture
- io.importScene
- io.listVariants
- io.splitPointCloud
- material.importImage
- scene.exportFilterLibrary
- scene.importFilterLibrary
- algo.configureFunctionLogger
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithPlane
- cad.configureFunctionLogger
- core.configureFunctionLogger
- core.getEvent
- core.getEvents
- core.getFunction
- core.getFunctions
- core.getGroup
- core.getGroups
- core.getModuleTypes
- core.getType
- core.getTypeAttributes
- core.addWantedToken
- core.checkWebLogin
- core.configureLicenseServer
- core.needToken
- core.ownToken
- core.releaseToken
- core.releaseWebLicense
- core.removeWantedToken
- core.requestWebLicense
- core.retrieveWebLicenses
- core.tokenValid
- core.parallelStart
- core.removeModule
- core.pushProgression
- core.addCustomProperties
- core.addCustomProperty
- core.getModuleProperty
- core.getModulePropertyInfo
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listModuleProperties
- core.removeCustomProperty
- core.restoreModulePropertyDefaultValue
- core.setModuleProperty
- core.setProperties
- core.setProperty
- core.unsetProperty
- core.startUndoRedoStep
- core.log
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.addAssetPaths
- io.findInDirectories
- io.setAssetPaths
- io.importRemote3mxFile
- io.registerIOCallbacks
- io.getExtensionPriority
- material.addUniformProperty
- material.configureFunctionLogger
- material.createCustomMaterialPattern
- material.createMaterial
- material.findCustomMaterialPatternByName
- material.findMaterialsByPattern
- material.findMaterialsByProperty
- material.getPointsAndMaterialFromText
- material.getUniformPropertyType
- material.setCoeffOrTextureProperty
- material.setColorAlphaProperty
- material.setColorOrTextureProperty
- material.setFragmentShader
- material.setMaterialPattern
- material.setVertexShader
- material.createImageFromData
- polygonal.configureFunctionLogger
- polygonal.createMeshFromText
- scene.configureFunctionLogger
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrenceFromText
- scene.createOccurrences
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.setOccurrenceName
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByProperty
- scene.createLight
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.removeMetadata
- scene.createAlternativeTree
- scene.createAnimation
- scene.getSubChannel
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
- scene.addFilterToLibrary
- scene.findFilterByName
- scene.setReferencedDataComponentPath
- scene.addAnnotationGroup
- scene.addVariant
- scene.duplicateVariant
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.setViewerProperty
- view.startRecording
ExportFilePathList
List of io.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 | |
| hasAlternativeImporter | FileFormatDescription | NOT_APPLICABLE | |
| hasMetadata | FileFormatDescription | NOT_APPLICABLE | |
| hasPMI | FileFormatDescription | NOT_APPLICABLE | |
| osMask | Int | 7 | Mask based on Windows (1), Linux (2), OSX (4). |
Functions accepting this type or a list of this type as a parameter:
FileFormatDescription
Enumeration of option states.
Enum of core.Int
Name | Value |
|---|---|
| NO | 0 |
| YES | 1 |
| NOT_APPLICABLE | 2 |
FileFormatList
List of io.FileFormat
Functions accepting this type or a list of this type as a parameter:
FilesList
List of core.FilePath
Functions accepting this type or a list of this type as a parameter:
ImportFilePath
File path of a supported file for import.
Base class: core.FilePath
Functions accepting this type or a list of this type as a parameter:
- core.load
- core.installLicense
- core.getModuleDescFromXML
- io.importPicture
- io.importScene
- io.listVariants
- io.splitPointCloud
- material.importImage
- scene.exportFilterLibrary
- scene.importFilterLibrary
- algo.configureFunctionLogger
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithPlane
- cad.configureFunctionLogger
- core.configureFunctionLogger
- core.getEvent
- core.getEvents
- core.getFunction
- core.getFunctions
- core.getGroup
- core.getGroups
- core.getModuleTypes
- core.getType
- core.getTypeAttributes
- core.addWantedToken
- core.checkWebLogin
- core.configureLicenseServer
- core.needToken
- core.ownToken
- core.releaseToken
- core.releaseWebLicense
- core.removeWantedToken
- core.requestWebLicense
- core.retrieveWebLicenses
- core.tokenValid
- core.parallelStart
- core.removeModule
- core.pushProgression
- core.addCustomProperties
- core.addCustomProperty
- core.getModuleProperty
- core.getModulePropertyInfo
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listModuleProperties
- core.removeCustomProperty
- core.restoreModulePropertyDefaultValue
- core.setModuleProperty
- core.setProperties
- core.setProperty
- core.unsetProperty
- core.startUndoRedoStep
- core.log
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.addAssetPaths
- io.findInDirectories
- io.setAssetPaths
- io.importRemote3mxFile
- io.registerIOCallbacks
- io.getExtensionPriority
- material.addUniformProperty
- material.configureFunctionLogger
- material.createCustomMaterialPattern
- material.createMaterial
- material.findCustomMaterialPatternByName
- material.findMaterialsByPattern
- material.findMaterialsByProperty
- material.getPointsAndMaterialFromText
- material.getUniformPropertyType
- material.setCoeffOrTextureProperty
- material.setColorAlphaProperty
- material.setColorOrTextureProperty
- material.setFragmentShader
- material.setMaterialPattern
- material.setVertexShader
- material.createImageFromData
- polygonal.configureFunctionLogger
- polygonal.createMeshFromText
- scene.configureFunctionLogger
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrenceFromText
- scene.createOccurrences
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.setOccurrenceName
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByProperty
- scene.createLight
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.removeMetadata
- scene.createAlternativeTree
- scene.createAnimation
- scene.getSubChannel
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
- scene.addFilterToLibrary
- scene.findFilterByName
- scene.setReferencedDataComponentPath
- scene.addAnnotationGroup
- scene.addVariant
- scene.duplicateVariant
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.setViewerProperty
- view.startRecording
ImportFilePathList
List of io.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
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
Name | Value |
|---|---|
| HTTP | 1 |
| HTTPS | 2 |
VariantNameList
List of core.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:
importFileCallback
Functions accepting this type or a list of this type as a parameter: