Main API¶

Patchwork 3D scripting¶

See also

class CurrentP3DSession(fallback_port=None)¶

Bases: p3dsdk.P3DSession

Class that connects to the running Patchwork 3D instance.

If the script is not executed from Patchwork 3D, fallback_port lets you specify a port to connect to. In this case it is equivalent to P3DSession("localhost", fallback_port).

Parameters: fallback_port (int, optional) -- Port to use to connect to Patchwork 3D on localhost when the script is not run from Patchwork 3D.
Raises: P3DError -- If no fallback_port is given and the script is not executed in the Patchwork 3D Python console.

close()¶: Close the session.

property data¶

Access to the current Database opened in Patchwork 3D.

Type: Database, read-only

property host¶

Host of the session.

Type: str, read-only

property port¶

TCP port of the session.

Type: int, read-only

class P3DSession(host, port)¶

Class that manages a scripting session with Patchwork 3D.

Note

If possible use IP address directly for host. This way, it will avoid a hostname lookup and queries will be quicker. For example, instead of connecting to localhost, prefer using 127.0.0.1.

Parameters

host (str) -- IP address or hostname of Patchwork 3D instance to connect to.
port (int) -- TCP port of Patchwork 3D instance to connect to.

close()¶: Close the session.