Asset Transformer SDK (ex Pixyz) PiXYZAPI Class
Inheritance
Inherited Members
Namespace: UnityEngine.Pixyz.API
public class PiXYZAPI : Interface
Constructors
PiXYZAPI(IntPtr)
public PiXYZAPI(IntPtr session)
Parameters
Type Name Description IntPtr session
Fields
Session
public IntPtr Session { get; }
Returns
ProductName
public string ProductName { get; }
Returns
Core
public CoreInterface Core { get; }
Returns
Geom
public GeomInterface Geom { get; }
Returns
Material
public MaterialInterface Material { get; }
Returns
Polygonal
public PolygonalInterface Polygonal { get; }
Returns
CAD
public CADInterface CAD { get; }
Returns
Algo
public AlgoInterface Algo { get; }
Returns
Scene
public SceneInterface Scene { get; }
Returns
View
public ViewInterface View { get; }
Returns
IO
public IOInterface IO { get; }
Returns
Unity
public UnityInterface Unity { get; }
Returns
SessionId
Get the session ID of the current session.
public uint SessionId { get; }
Returns
Methods
GetLastError
public static string GetLastError()
Returns
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 string productName Product name. string validationKey Product validation key. string[] optionalTokenList Token list to initialize the product with. string license License file (content).
Returns
Release
Release Pixyz API and clear the session.
ActiveSessions
List all active sessions.
public static List<PiXYZAPI> ActiveSessions()
Returns
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).
public static void SetUnityLicenseClientChannels(string channelName, string secondaryChannelName)
Parameters
Type Name Description string channelName Channel name to which to connect. string secondaryChannelName Secondary channel name to which to connect.
StartServer
Start a Pixyz gRPC server.
public void StartServer(string host, ushort port, bool blocking = true)
Parameters
Type Name Description string host Host address to bind to. ushort port Port to listen on. bool blocking If true, blocks until server stops; if false, runs in background.
StartClient
Connect to a Pixyz gRPC server.
public void StartClient(string host, ushort port)
Parameters
Type Name Description string host Host address of the server. ushort port Port of the server.
IsRemote
Returns true if the current session is a remote session (connected to a server).
Returns