rs3.RS3Modeler module#

class rs3.RS3Modeler.RS3ModelerBase(client: Client)#

Bases: object

openFile(path: str) → str#
closeProgram(saveModels: bool) → int#
rs3.RS3Modeler.RS3ModelerBase2RS3ModelerRS3ModelerBase(a: RS3ModelerBase) → rs3.generatedFiles.RS3ModelerService_pb2.RS3ModelerBase#
rs3.RS3Modeler.RS3ModelerRS3ModelerBase2RS3ModelerBase(client: Client, a: rs3.generatedFiles.RS3ModelerService_pb2.RS3ModelerBase) → RS3ModelerBase#
class rs3.RS3Modeler.RS3Modeler(port=60064)#

Bases: RS3ModelerBase

openFile(path: str) → Model#
classmethod startApplication(port: int, overridePathToExecutable: str = None, timeout: float = 120) → None#

Opens the most recently installed RS3 application. Starts the python server and binds it to the given port.

Parameters:

  • port (int) – the port to bind the python server to. Use this same port when initializing RS3Modeler

  • overridePathToExecutable (str, optional) – full path to the desired executable to be opened. If not provided, the latest installation of rs3 is used

  • timeout (float, optional) – the maximum amount of time to wait for the application and server to start.

Raises:

  • ValueError – Port range must be between 49152 and 65535, otherwise ValueError is raised

  • TimeoutError – if timeout is provided, raises TimeoutError if not able to connect to the server within that time.

closeProgram(saveModels=True, timeout: float = 120) → None#