ProtoTwin API
    Preparing search index...

    Class SetTcpRobotInstruction

    Set Tool Center Point (TCP) instruction.

    Instructs the robot controller to set the specified TCP as the active TCP. This instruction can be used to switch to using a different TCP during the simulation, which can be helpful when the robot has multiple tools/end-effectors.

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    Methods

    Constructors

    Accessors

    • get program(): null | RobotProgram

      The program to which the instruction has been assigned.

      Returns null | RobotProgram

      If the program is null then the instruction hasn't been added to a program.

    • set program(value: null | RobotProgram): void

      Parameters

      Returns void

    • get tcp(): null | Entity

      The entity that represents the TCP.

      Returns null | Entity

      If the TCP entity has a RobotTCPComponent component, then the local offsets will be used to define the TCP frame.

    • set tcp(value: null | Entity): void

      Parameters

      Returns void

    Methods