Documentation

Support

Asset Transformer SDK


User Manual

Python API

C# API

Changelog

Discussions

Asset Transformer SDK

PiXYZAPI

Class
Read time 2 minutesLast updated 18 hours ago

Inheritance
Inherited Members
Namespace: UnityEngine.Pixyz.API
public class PiXYZAPI : Interface

Constructors

PiXYZAPI(IntPtr)

public PiXYZAPI(IntPtr session)
Parameters

Type

Name

Description

IntPtrsession

Fields

Session

public IntPtr Session { get; }
Returns

Type

Description

IntPtr

ProductName

public string ProductName { get; }
Returns

Type

Description

string

Core

public CoreInterface Core { get; }
Returns

Type

Description

CoreInterface

Geom

public GeomInterface Geom { get; }
Returns

Type

Description

GeomInterface

Material

public MaterialInterface Material { get; }
Returns

Type

Description

MaterialInterface

Polygonal

public PolygonalInterface Polygonal { get; }
Returns

Type

Description

PolygonalInterface

CAD

public CADInterface CAD { get; }
Returns

Type

Description

CADInterface

Algo

public AlgoInterface Algo { get; }
Returns

Type

Description

AlgoInterface

Scene

public SceneInterface Scene { get; }
Returns

Type

Description

SceneInterface

View

public ViewInterface View { get; }
Returns

Type

Description

ViewInterface

IO

public IOInterface IO { get; }
Returns

Type

Description

IOInterface

Unity

public UnityInterface Unity { get; }
Returns

Type

Description

UnityInterface

Methods

GetLastError

public static string GetLastError()
Returns

Type

Description

string

Initialize

Initialize Pixyz API and create a new session.
public static PiXYZAPI Initialize(string productName = "", string validationKey = "", string[] optionalTokenList = null, string license = "")
Parameters

Type

Name

Description

stringproductNameProduct name.
stringvalidationKeyProduct validation key.
string[]optionalTokenListToken list to initialize the product with.
stringlicenseLicense file (content).
Returns

Type

Description

PiXYZAPI

Release

Release Pixyz API and clear the session.
public void Release()

ActiveSessions

List all active sessions.
public static List<PiXYZAPI> ActiveSessions()
Returns

Type

Description

List<PiXYZAPI>

SetUnityLicenseClientChannels

Set the licensing channel name to use if using a Unity license. Use if the licensing client was launched by another process (e.g the Unity Hub or the Unity Editor).
Should be called before initialization.
public static void SetUnityLicenseClientChannels(string channelName, string secondaryChannelName)
Parameters

Type

Name

Description

stringchannelNameChannel name to which to connect.
stringsecondaryChannelNameSecondary channel name to which to connect.