Table of Contents

Class IO

Namespace
IO

Methods

configureFunctionLogger 

io.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime)

Parameters

functionName String
enableFunction Boolean
enableParameters Boolean
enableExecutionTime Boolean

exportSceneToDTPlatform

Export current scene to a local directory

See also:

io.exportSceneToDTPlatform(root=1, directory)

Parameters

root Occurrence

Identifier of the destination occurrence

directory String

Directory to export in

exportSceneToReflect

Export current scene to a reflect project

See also:

io.exportSceneToReflect(root=1, sourceName="", uid="", keepHierarchy=False, configFile="", disableDecimation=True)

Parameters

root Occurrence

Identifier of the destination occurrence

sourceName String

Push source name

uid String

UID of the push, overwrite old push if it's same UID

keepHierarchy Boolean

Keep hierarchy or rake tree

configFile FilePath

Use existing JSON config file, discard reflect UI prompt

disableDecimation Boolean

Forces to disable the decimation applied on SyncObjectInstances on Reflect Server side

importSceneFromDTPlatform

Import scene from a local directory

See also:

io.importSceneFromDTPlatform(directory, root=0)

Parameters

directory DirectoryPath

Directory to import from

root Occurrence

Identifier of the destination occurrence

exportScene

Export a file

See also:

io.exportScene(fileName, root=0)

Parameters

fileName OutputFilePath

Path of the file to export

root Occurrence

Identifier of the root occurrence to export

exportSelection

Export the selection to a file

See also:

io.exportSelection(fileName, keepIntermediaryNodes=False)

Parameters

fileName OutputFilePath

Path of the file to export

keepIntermediaryNodes Boolean

If true, intermerdiary hierarchy is kept

getExportFormats

Give all the format name and their extensions that can be exported in Pixyz

See also:

io.getExportFormats() -> core.FormatList

Returns

FormatList

Formats that can be exported in Pixyz

getImportFormats

Give all the format name and their extensions that can be imported in Pixyz

See also:

io.getImportFormats() -> core.FormatList

Returns

FormatList

Formats that can be imported in Pixyz

importFiles

Import files

See also:

io.importFiles(fileNames, root) -> scene.OccurrenceList

Parameters

fileNames FilesList

List of files's paths to import

root Occurrence

Identifier of the destination occurrence

Returns

OccurrenceList

The root occurrences of each imported file

importPicture

Imports a picture and applies is at as a texture on a 3D plane created in the scene.

See also:

io.importPicture(filename, root) -> scene.Occurrence

Parameters

filename FilePath

Path of the file to import

root Occurrence

Identifier of the destination occurrence

Returns

Occurrence

The root occurrence if defined, otherwise a new occurrence created by the importer

importRemote3mxFile

Import a remote 3mx file

See also:

io.importRemote3mxFile(filePath, origin, root) -> scene.Occurrence

Parameters

filePath String

The path of the temp file

origin String

Remote origin of the file

root Occurrence

Identifier of the destination occurrence

Returns

Occurrence

The root occurrence if defined, otherwise a new occurrence created by the importer

importScene

Import a file

See also:

io.importScene(fileName, root) -> scene.Occurrence

Parameters

fileName FilePath

Path of the file to import

root Occurrence

Identifier of the destination occurrence

Returns

Occurrence

The root occurrence if defined, otherwise a new occurrence created by the importer

listVariants

List all variants if file

See also:

io.listVariants(fileName) -> io.VariantNameList

Parameters

fileName FilePath

Path of the file to import

Returns

VariantNameList

List all variants

loadReferencedData

See also:

io.loadReferencedData(component, recursively)

Parameters

component ReferencedDataComponent

The component to load

recursively Bool

Load it recursively or not

registerImportCallback

add new homade importer

io.registerImportCallback(name, extensions, callback)

Parameters

name String

Callback name

extensions StringList

Handled extensions

callback importFileCallback

Callback that import a file

splitPointCloud 

io.splitPointCloud(files, outputDirectory, minVoxSize, useKDTree, aabb, density=-1)

Parameters

files FilePathList

Path of the point cloud files to process

outputDirectory OutputDirectoryPath

Output directory

minVoxSize Double

Size of minimum leaves (mm)

useKDTree Boolean

If true, uses a kd_tree, otherwise, uses an octree

aabb AABB

Global scene aabb

density Double

Point cloud density (-1 to compute)