Interface MPPViewportAgent


@ForUseOnly public interface MPPViewportAgent
Definition of an agent offering capabilities to modify the viewports of the multi-perspective preview (MPP).
Since:
5.2.604
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    Technical type of an agent specialized for multi-perspective viewport handling.
  • Method Summary

    Modifier and Type
    Method
    Description
    get()
    Returns a new configuration object containing the multi-perspective viewports of the current project.
    void
    set(@NotNull MPPViewports viewports)
    Takes the given configuration and writes it back the the current project.
  • Field Details

    • TYPE

      static final SpecialistType<MPPViewportAgent> TYPE
      Technical type of an agent specialized for multi-perspective viewport handling.
      Since:
      5.2.604
  • Method Details

    • get

      Returns a new configuration object containing the multi-perspective viewports of the current project.
      Returns:
      a new configuration object containing the multi-perspective viewports of the current project
      Since:
      5.2.604
      See Also:
    • set

      void set(@NotNull @NotNull MPPViewports viewports) throws LockException
      Takes the given configuration and writes it back the the current project. In order to do this, the project will be locked and saved.
      Parameters:
      viewports - the viewports to set
      Throws:
      LockException - if the project could not be locked
      Since:
      5.2.604