Package com.solibri.smc.api.visualization

Interface Visualization

public interface Visualization
Visualization to visualize results of a rule.
Since:
9.10.2
See Also:
Result.withVisualization(java.util.function.Consumer)

  • Method Details

    • create

      static Visualization create()
      Creates an empty Visualization with no components, section planes or visualization items.
      Returns:
      the new visualization
      Since:
      9.12.0

    • addVisualizationItem

      void addVisualizationItem​(VisualizationItem visualizationItem)
      Adds a visualization item to this visualization.
      Parameters:
      visualizationItem - the visualization item.
      Since:
      9.10.2

    • addVisualizationItems

      void addVisualizationItems​(Collection<VisualizationItem> visualizationItems)
      Adds a collection of VisualizationItem to this visualization.
      Parameters:
      visualizationItems - the visualization items
      Since:
      9.10.2

    • getVisualizationItems

      Collection<VisualizationItem> getVisualizationItems()
      Returns the visualization items of this visualization.
      Returns:
      the visualization items.
      Since:
      9.12.0

    • addComponent

      void addComponent​(Component component, double transparency)
      Adds a component to this visualization. Color of the component is not changed.
      Parameters:
      component - the component
      transparency - the transparency from 0.0 to 1.0
      Since:
      9.10.2

    • addComponents

      void addComponents​(Collection<? extends Component> components, double transparency)
      Adds a collection of components to this visualization.
      Parameters:
      components - the components
      transparency - the transparency from 0.0 to 1.0
      Since:
      9.10.2

    • addComponentWithColor

      void addComponentWithColor​(Component component, ARGBColor color)
      Adds a component with a color to this visualization.
      Parameters:
      component - the component
      color - the color
      Since:
      9.10.2

    • addComponentsWithColor

      void addComponentsWithColor​(Collection<? extends Component> components, ARGBColor color)
      Adds a collection of components with color to the visualization.
      Parameters:
      components - the components
      color - the color
      Since:
      9.10.2

    • getComponentsWithColor

      Map<ARGBColor,​List<Component>> getComponentsWithColor()
      Returns the colored components of the visualization as a map from color to the component list.
      Returns:
      the map from color to the component list
      Since:
      9.12.0

    • addFootprints

      void addFootprints​(double bottomElevation, double topElevation)
      Adds the footprints between the given elevations to this visualization. The elevations are inclusive.
      Parameters:
      bottomElevation - the bottom elevation
      topElevation - the top elevation
      Since:
      9.10.2

    • addFootprints

      void addFootprints​(Component component)
      Adds the footprints on the elevation of the component to this visualization.
      Parameters:
      component - the component
      Since:
      9.10.2

    • addSection

      void addSection​(Plane sectionPlane)
      Adds a section plane to this visualization.
      Parameters:
      sectionPlane - the section plane
      Since:
      9.10.2

    • addSections

      void addSections​(Collection<Plane> sectionPlanes)
      Adds the given section planes to this visualization.
      Parameters:
      sectionPlanes - the section planes
      Since:
      9.10.2

    • getSections

      Collection<Plane> getSections()
      Returns the section planes of this visualization.
      Returns:
      the section planes
      Since:
      9.12.0

    • getVisibleComponents

      Set<Component> getVisibleComponents()
      Returns the visible components.
      Returns:
      the visible components
      Since:
      9.12.0

    • setVisibleComponents

      void setVisibleComponents​(Collection<Component> components)
      Sets visible components that are shown with original color.
      Parameters:
      components - the visible components
      Since:
      9.12.0