Machines Manual

Table of Contents

• About
• MachinesInterface
• MachineInterface
• Further Reading

About

A maxon::MachineInterface interface represents either the local machine (running Cinema 4D) or a machine connected via RPC. Typically one accesses the local machine to obtain specific interfaces.

MachinesInterface

maxon::MachinesInterface gives access to the local or connected machines:

• maxon::MachinesInterface::GetLocal(): Returns the local machine.
• maxon::MachinesInterface::GetRPCMachines(): Returns a list of all available machines in the application.
• maxon::MachinesInterface::FindRPCMachine(): Returns the machine with the given UUID.
• maxon::MachinesInterface::FindOrAddRPCMachine(): Returns the machine with the given UUID or calls the callback functions to add a new machine.
• maxon::MachinesInterface::RemoveRPCMachine(): Removes the given machine from the list.

  // This example lists all connected machines including the local machine.
 
  maxon::BaseArray<maxon::MachineRef> machines;
  maxon::MachinesInterface::GetRPCMachines(machines) iferr_return;
 
  for (auto machine : machines)
  {
    const maxon::DataDictionary machineInfo  = machine.GetMachineInfo() iferr_return;
    const maxon::String         computerName = machineInfo.Get(maxon::MACHINEINFO::COMPUTERNAME) iferr_return;
    DiagnosticOutput("Machine @", computerName);
  }

MachineInterface

A maxon::MachineInterface represents the local machine or a connected machine.

The connection state is stored as maxon::MACHINESTATE.

• maxon::MachineInterface::GetState(): Returns the connection state.
• maxon::MachineInterface::SetState(): Sets the connection state.

General information on the machine can be obtained with:

• maxon::MachineInterface::GetMachineInfo(): Returns information about the system and processor. See maxon::MACHINEINFO for IDs. See also Application Manual.
• maxon::MachineInterface::GetUniqueId(): Returns the UUID as a maxon::String.
• maxon::MachineInterface::ToString(): Returns a readable string of the content.

  // This example prints various infos on the local machine to the console.
 
  const maxon::MachineRef localMachine = maxon::MachinesInterface::GetLocal();
 
  const maxon::DataDictionary machineInfo  = localMachine.GetMachineInfo() iferr_return;
  const maxon::String         computerName = machineInfo.Get(maxon::MACHINEINFO::COMPUTERNAME) iferr_return;
  const maxon::String         osVersion = machineInfo.Get(maxon::MACHINEINFO::OSVERSION) iferr_return;
  const maxon::String         uid = localMachine.GetUniqueId();
 
  DiagnosticOutput("Machine @ (@) running @", computerName, uid, osVersion);

A maxon::MachineInterface gives access to various interfaces:

• maxon::MachineInterface::GetInterface(): Returns the given interface.

The maxon::MachineInterface provides this observable:

• ObservableMessageReceived: Called when the machine receives a message.

Further Reading

• Observables