Class IOInterface

Inheritance

object

Interface

IOInterface

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Pixyz.IO

Syntax

public class IOInterface : Interface

Methods

AddAssetPaths(StringList)

add directory paths to search assets in

Declaration

[HandleProcessCorruptedStateExceptions]
public void AddAssetPaths(StringList path)

Parameters

Type	Name	Description
StringList	path	The paths to add

ApplyAutoTessellate(uint)

Handle auto tessellate options on given part, need to be complete

Declaration

[HandleProcessCorruptedStateExceptions]
public void ApplyAutoTessellate(uint part)

Parameters

Type	Name	Description
uint	part	Part to be auto tessellated

ClearAssetPaths()

clear all asset paths

Declaration

[HandleProcessCorruptedStateExceptions]
public void ClearAssetPaths()

ConfigureFunctionLogger(string, bool, bool, bool)

Declaration

[HandleProcessCorruptedStateExceptions]
public void ConfigureFunctionLogger(string functionName, bool enableFunction, bool enableParameters, bool enableExecutionTime)

Parameters

Type	Name	Description
string	functionName
bool	enableFunction
bool	enableParameters
bool	enableExecutionTime

ExportScene(string, uint)

Export a file

Declaration

[HandleProcessCorruptedStateExceptions]
public void ExportScene(string fileName, uint root = 0)

Parameters

Type	Name	Description
string	fileName	Path of the file to export
uint	root	Identifier of the root occurrence to export

ExportSelection(string, bool)

Export the selection to a file

Declaration

[HandleProcessCorruptedStateExceptions]
public void ExportSelection(string fileName, bool keepIntermediaryNodes = false)

Parameters

Type	Name	Description
string	fileName	Path of the file to export
bool	keepIntermediaryNodes	If true, intermerdiary hierarchy is kept

FindInDirectories(string)

find the final path. This will search for the file in asset paths

Declaration

[HandleProcessCorruptedStateExceptions]
public string FindInDirectories(string filePath)

Parameters

Type	Name	Description
string	filePath	The (relative) file path to search for

Returns

Type	Description
string

GetAssetPaths()

get user defined paths to find assets

Declaration

[HandleProcessCorruptedStateExceptions]
public StringList GetAssetPaths()

Returns

Type	Description
StringList

GetExportFormats()

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

Declaration

[HandleProcessCorruptedStateExceptions]
public FormatList GetExportFormats()

Returns

Type	Description
FormatList

GetExtensionPriority(string)

get the priority of an extension from the pixyz importer

Declaration

[HandleProcessCorruptedStateExceptions]
public PriorityImportLevel GetExtensionPriority(string extensionName)

Parameters

Type	Name	Description
string	extensionName	The name of the extension

Returns

Type	Description
PriorityImportLevel

GetImportFormats()

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

Declaration

[HandleProcessCorruptedStateExceptions]
public FormatList GetImportFormats()

Returns

Type	Description
FormatList

GetLastError()

Declaration

public static string GetLastError()

Returns

Type	Description
string

ImportFiles(FilesList, uint)

Import files

Declaration

[HandleProcessCorruptedStateExceptions]
public OccurrenceList ImportFiles(FilesList fileNames, uint root = 0)

Parameters

Type	Name	Description
FilesList	fileNames	List of files's paths to import
uint	root	Identifier of the destination occurrence

Returns

Type	Description
OccurrenceList

ImportPicture(string, uint)

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

Declaration

[HandleProcessCorruptedStateExceptions]
public uint ImportPicture(string filename, uint root = 0)

Parameters

Type	Name	Description
string	filename	Path of the file to import
uint	root	Identifier of the destination occurrence

Returns

Type	Description
uint

ImportRemote3mxFile(string, string, uint)

Import a remote 3mx file

Declaration

[HandleProcessCorruptedStateExceptions]
public uint ImportRemote3mxFile(string filePath, string origin = "", uint root = 0)

Parameters

Type	Name	Description
string	filePath	The path of the temp file
string	origin	Remote origin of the file
uint	root	Identifier of the destination occurrence

Returns

Type	Description
uint

ImportScene(string, uint)

Import a file

Declaration

[HandleProcessCorruptedStateExceptions]
public uint ImportScene(string fileName, uint root = 0)

Parameters

Type	Name	Description
string	fileName	Path of the file to import
uint	root	Identifier of the destination occurrence

Returns

Type	Description
uint

ListVariants(string)

List all variants if file

Declaration

[HandleProcessCorruptedStateExceptions]
public VariantNameList ListVariants(string fileName)

Parameters

Type	Name	Description
string	fileName	Path of the file to import

Returns

Type	Description
VariantNameList

LoadReferencedData(uint, bool)

Load partial model

Declaration

[HandleProcessCorruptedStateExceptions]
public void LoadReferencedData(uint component, bool recursively)

Parameters

Type	Name	Description
uint	component	The component to load
bool	recursively	Load it recursively or not

RegisterIOCallbacks(string, importFileCallback, exportFileCallback, FileFormatList)

Register import and export callbacks

Declaration

[HandleProcessCorruptedStateExceptions]
public void RegisterIOCallbacks(string name, IOInterface.importFileCallback importCallback, IOInterface.exportFileCallback exportCallback, FileFormatList fileFormats)

Parameters

Type	Name	Description
string	name	Callback name
IOInterface.importFileCallback	importCallback	Callback that import a file
IOInterface.exportFileCallback	exportCallback	Callback that exports to a file
FileFormatList	fileFormats	Gives the extension and parameters to Import/Export

SetAssetPaths(StringList)

replace paths to find assets

Declaration

[HandleProcessCorruptedStateExceptions]
public void SetAssetPaths(StringList assetPaths)

Parameters

Type	Name	Description
StringList	assetPaths	The asset paths

SplitPointCloud(FilePathList, string, double, bool, AABB, double)

Declaration

[HandleProcessCorruptedStateExceptions]
public void SplitPointCloud(FilePathList files, string outputDirectory, double minVoxSize, bool useKDTree, AABB aabb = null, double density = -1)

Parameters

Type	Name	Description
FilePathList	files	Path of the point cloud files to process
string	outputDirectory	Output directory
double	minVoxSize	Size of minimum leaves (mm)
bool	useKDTree	If true, uses a kd_tree, otherwise, uses an octree
AABB	aabb	Global scene aabb
double	density	Point cloud density (-1 to compute)

UnloadReferencedData(uint)

Unload partial model

Declaration

[HandleProcessCorruptedStateExceptions]
public void UnloadReferencedData(uint component)

Parameters

Type	Name	Description
uint	component	The component to unload