Version: 
PiXYZ Plugin for Unity
Scripting API Documentation
PiXYZ.Plugin.Unity Namespace Reference

Classes

class  Configuration
 
class  ImportedModel
 
class  Importer
 
class  ImportSettings
 
class  LODSettings
 
class  LODsSettings
 

Enumerations

enum  TreeProcessType {
  NONE = 0, COMPRESS = 1, RAKE = 2, MERGE = 3,
  MERGE_BY_MATERIAL = 4, MERGE_FINAL_ASSEMBLIES = 5
}
 
enum  LODsMode { ROOT = 0, LEAVES = 1 }
 
enum  LODQuality {
  MAXIMUM, HIGH, MEDIUM, LOW,
  POOR, CULLED
}
 
enum  MeshQuality {
  MAXIMUM, HIGH, MEDIUM, LOW,
  POOR
}
 

Functions

delegate void ImportCompletedCallback (GameObject importedObject)
 
delegate void ProgressedCallback (float progress, string message)
 

Enumeration Type Documentation

◆ LODQuality

enum LODQuality
strong

LOD Quality.

Enumerator
MAXIMUM 

Use this setting if you wish to obtain a very dense and precise mesh (quality is a priority over low-density) OR if you are importing a very small asset (under 1cm).

A tessellation process is run.

HIGH 

This is a modification of the Very High preset.

PiXYZ will deliver a superior quality mesh. Gives high-quality results for small objects. A tessellation process is run.

MEDIUM 

Typically the best option to obtain a balanced mesh between quality and polygon count.

A tessellation process is run.

LOW 

Efficient setting to obtain a low-density mesh, or to process large objects while limiting polygon count.

A tessellation process is run.

POOR 

Setting to obtain a very low-density mesh, or to process large objects while strongly limiting polygon count.

A tessellation process is run.

CULLED 

LOD is culled for maximum performances.

◆ LODsMode

enum LODsMode
strong

Mode to use for LODs.

Enumerator
ROOT 

The LOD Group is placed on the root node of the imported model.

Use this setting if you wish to control the global visibility of the entire imported model at once.

LEAVES 

The LOD Group is placed on the parent-node of each mesh (or object) existing in the hierarchy.

Use this setting if you wish to control the visibility of each sub-part of the imported model.

◆ MeshQuality

enum MeshQuality
strong

Mesh quality

Enumerator
MAXIMUM 

Use this setting if you wish to obtain a very dense and precise mesh (quality is a priority over low-density) OR if you are importing a very small asset (under 1cm).

A tessellation process is run.

HIGH 

This is a modification of the Very High preset.

PiXYZ will deliver a superior quality mesh. Gives high-quality results for small objects. A tessellation process is run.

MEDIUM 

Typically the best option to obtain a balanced mesh between quality and polygon count.

A tessellation process is run.

LOW 

Efficient setting to obtain a low-density mesh, or to process large objects while limiting polygon count.

A tessellation process is run.

POOR 

Setting to obtain a very low-density mesh, or to process large objects while strongly limiting polygon count.

A tessellation process is run.

◆ TreeProcessType

enum TreeProcessType
strong

Tree processing type

Enumerator
NONE 

No modification of the hierarchy.

COMPRESS 

Compresses the hierarchy by removing empty nodes, or any node containing only one sub-node.

RAKE 

Simplifies the hierarchy by transferring all imported 3D objects (or GameObjects) under the root node of the imported model.

MERGE 

All objects contained in the original model will be merged together, as one single object.

MERGE_BY_MATERIAL 

All objects contained in the original model that share the same material will be merged together.

MERGE_FINAL_ASSEMBLIES 

Use this setting to assemble together unconnected CAD surfaces prior to any data treatment at import (it is a pre-process).

Function Documentation

◆ ImportCompletedCallback()

delegate void PiXYZ.Plugin.Unity.ImportCompletedCallback ( GameObject  importedObject)

Delegate to an Import ended callback.

Use PiXYZ.Plugin.Unity.EditorExtensions.GetDependencies to get all runtime dependencies (Editor Only).

Parameters
importedObjectImported GameObject

◆ ProgressedCallback()

delegate void PiXYZ.Plugin.Unity.ProgressedCallback ( float  progress,
string  message 
)

Delegate to an Import progressed callback.

Parameters
progressProgress value, from 0 to 1
messageProgress message