Viewer

Usage:

Viewer Class API Wrapper

class Viewer

Bases: object

Wrapper for Viewer class of Moldflow Synergy.

property active_clipping_plane: EntList

Gets the active clipping plane.

Returns:

The active clipping plane.

Return type:

EntList

property active_plot: Plot

Gets the active plot.

Returns:

The active plot.

Return type:

Plot

add_bookmark(name, normal_view, up_view, focal_point, eye_position, clipping_range_min, clipping_range_max, view_angle, parallel_scale)

Adds a bookmark with the given parameters.

Parameters:

• name (str) – The name of the bookmark.

• normal_view (Vector | None) – The normal view vector.

• up_view (Vector | None) – The up view vector.

• focal_point (Vector | None) – The focal point vector.

• eye_position (Vector | None) – The eye position vector.

• clipping_range_min (float) – The minimum clipping range.

• clipping_range_max (float) – The maximum clipping range.

• view_angle (float) – The view angle.

• parallel_scale (float) – The parallel scale.

Return type:

None

center(center_x, center_y)

Centers the view at the given coordinates.

Parameters:

• center_x (float) – The x-coordinate to center on.

• center_y (float) – The y-coordinate to center on.

Return type:

None

create_bookmark(name)

Creates a bookmark with the given name.

Parameters:

name (str) – The name of the bookmark.

Return type:

None

create_clipping_plane(normal, distance)

Creates a clipping plane with the given normal and distance.

Parameters:

• normal (Vector | None) – The normal vector of the clipping plane.

• distance (float) – The distance from the origin to the clipping plane.

Returns:

Object containing created clipping plane.

Return type:

EntList

create_default_clipping_plane()

Creates a default clipping plane.

Returns:

Object containing created clipping plane.

Return type:

EntList

delete_bookmark(name)

Deletes a bookmark with the given name.

Parameters:

name (str) – The name of the bookmark.

Return type:

None

delete_clipping_plane(plane)

Deletes the given clipping plane.

Parameters:

plane (EntList | None) – The clipping plane to delete.

Return type:

None

delete_clipping_plane_by_id(plane_id)

Deletes clipping by plane ID.

Parameters:

plane_id (int) – The ID of the plane.

Return type:

None

enable_clipping_plane(plane, enable)

Enables or disables the given clipping plane.

Parameters:

• plane (EntList | None) – The clipping plane to enable or disable.

• enable (bool) – Whether to enable or disable the clipping plane.

Return type:

None

enable_clipping_plane_by_id(plane_id, enable)

Enables or disables clipping by plane ID.

Parameters:

• plane_id (int) – The ID of the plane.

• enable (bool) – Whether to enable or disable clipping.

Return type:

None

fit()

Fits the view to the current model.

Return type:

None

get_first_clipping_plane()

Gets the first clipping plane.

Returns:

The first clipping plane.

Return type:

EntList

get_histogram_location()

Gets the histogram location.

Returns:

The histogram location.

Return type:

DoubleArray

get_min_max_maximum_label_location()

Gets the maximum label location for the min/max plot.

Returns:

The maximum label location.

Return type:

DoubleArray

get_min_max_minimum_label_location()

Gets the minimum label location for the min/max plot.

Returns:

The minimum label location.

Return type:

DoubleArray

get_next_clipping_plane(plane)

Gets the next clipping plane after the given one.

Parameters:

plane (EntList | None) – The current clipping plane.

Returns:

The next clipping plane.

Return type:

EntList

get_number_frames_by_name(plot_name)

Gets the number of frames for the given plot. :type plot_name: str :param plot_name: The name of the plot. :type plot_name: str

Returns:

The number of frames.

Return type:

int

get_plot(plot_id)

Get a plot by its ID.

Parameters:

plot_id (int) – The ID of the plot.

Returns:

The plot with the given ID.

Return type:

Plot

go_to_bookmark(name)

Goes to a bookmark with the given name.

Parameters:

name (str) – The name of the bookmark.

Return type:

None

go_to_standard_view(name)

Go to a standard view

Parameters:

name (StandardViews | str) – The name of the standard view.

Return type:

None

hide_plot(plot)

Hide the given plot.

Parameters:

plot (Plot | None) – The plot to hide.

Return type:

None

is_play_animation()

Checks if the animation is currently playing.

Returns:

True if the animation is playing, False otherwise.

Return type:

bool

modify_clipping_plane(plane, normal, distance)

Modifies the given clipping plane with the new normal and distance.

Parameters:

• plane (EntList | None) – The clipping plane to modify.

• normal (Vector | None) – The new normal vector of the clipping plane.

• distance (float) – The new distance from the origin to the clipping plane.

Return type:

None

modify_clipping_plane_by_id(plane_id, normal, distance)

Modifies the clipping plane with the given ID with the new normal and distance.

Parameters:

• plane_id (int) – The ID of the clipping plane to modify.

• normal (Vector | None) – The new normal vector of the clipping plane.

• distance (float) – The new distance from the origin to the clipping plane.

Return type:

None

overlay_plot(plot)

Overlays a plot on another plot in the viewer

Parameters:

plot (Plot | None) – The plot to overlay.

Return type:

None

pan(x, y)

Pans the view

Parameters:

• x (float) – Pan Factor, < 0 to move to the left > 0 to move to the right

• y (float) – Pan Factor, < 0 to move to the bottom > 0 to move to the top

Return type:

None

Notes

factors are normalized to the screen height, i.e., a factor of 1 moves the model by one screen-height to the top

play_animation()

Plays the current animation.

Return type:

None

print()

Prints the current view.

Return type:

None

reset()

Resets the viewer to its default state.

Return type:

None

reset_legend()

Resets the legend to its default state.

Return type:

None

reset_view(normal_view, up_view)

Resets the view with given normal and “up” directions.

Parameters:

• normal_view (Vector | None) – The normal view vector.

• up_view (Vector | None) – The up view vector.

Return type:

None

rotate(angle_x, angle_y, angle_z)

Rotates the view to the given set of angles.

Parameters:

• angle_x (float) – The rotation angle around the x-axis.

• angle_y (float) – The rotation angle around the y-axis.

• angle_z (float) – The rotation angle around the z-axis.

Return type:

None

rotate_by(angle_x, angle_y, angle_z)

Rotates by the given angles.

Parameters:

• angle_x (float) – The rotation angle around the x-axis.

• angle_y (float) – The rotation angle around the y-axis.

• angle_z (float) – The rotation angle around the z-axis.

Return type:

None

rotate_x(angle_x)

Rotates the view about the X axis to a specified angle

Parameters:

angle_x (float) – The rotation angle around the x-axis.

Return type:

None

rotate_x_by(angle_x)

Rotates the view about the X axis by a specified angle

Parameters:

angle_x (float) – The rotation angle around the x-axis.

Return type:

None

rotate_y(angle_y)

Rotates the view about the Y axis to a specified angle

Parameters:

angle_y (float) – The rotation angle around the y-axis.

Return type:

None

rotate_y_by(angle_y)

Rotates the view about the Y axis by a specified angle

Parameters:

angle_y (float) – The rotation angle around the y-axis.

Return type:

None

rotate_z(angle_z)

Rotates the view about the Z axis to a specified angle

Parameters:

angle_z (float) – The rotation angle around the z-axis.

Return type:

None

rotate_z_by(angle_z)

Rotates the view about the Z axis by a specified angle

Parameters:

angle_z (float) – The rotation angle around the z-axis.

Return type:

None

property rotation_x: float

Get the current rotation around the x-axis in degrees.

Returns:

The rotation around the x-axis.

Return type:

float

property rotation_y: float

Get the current rotation around the y-axis in degrees.

Returns:

The rotation around the y-axis.

Return type:

float

property rotation_z: float

Get the current rotation around the z-axis in degrees.

Returns:

The rotation around the z-axis.

Return type:

float

save_animation(filename, speed, prompts=False)

Saves the current view as an animation.

Parameters:

• filename (str) – The name of the file to save the animation to.

• speed (AnimationSpeed | str) – The speed of the animation.

• prompts (bool) – Whether to include prompts in the animation.

Returns:

True if successful, False otherwise.

Return type:

bool

save_axis_image(filename)

Saves the current axis as an image.

Parameters:

filename (str) – The name of the file to save the image to.

Note:The image scale and size is the same as on the screen @

Returns:

True if successful, False otherwise.

Return type:

bool

save_image(filename, x=0, y=0, result=False, legend=False, axis=False, rotation=False, scale_bar=False, plot_info=False, study_title=False, ruler=False, logo=False, histogram=False, min_max=False)

Saves the current view as an image.

Parameters:

• filename (str) – The name of the file to save the image to.

• x (int) – The width of the image.

• y (int) – The height of the image.

• result (bool) – Whether to include results in the image.

• legend (bool) – Whether to include the legend in the image.

• axis (bool) – Whether to include axes in the image.

• rotation (bool) – Whether to include rotation in the image.

• scale_bar (bool) – Whether to include a scale bar in the image.

• plot_info (bool) – Whether to include plot information in the image.

• study_title (bool) – Whether to include study title in the image.

• ruler (bool) – Whether to include a ruler in the image.

• logo (bool) – Whether to include a logo in the image.

• histogram (bool) – Whether to include a histogram in the image.

• min_max (bool) – Whether to include min/max values in the image.

Returns:

True if successful, False otherwise.

Return type:

bool

save_image_legacy(filename, x=None, y=None)

Save image using legacy behavior only (V1/V2): - filename only -> SaveImage(filename) - filename and positive x,y -> SaveImage2(filename, x, y) :type filename: str :param filename: Output image path. :type x: int | None :param x: Width in pixels (must be > 0 when provided). :type y: int | None :param y: Height in pixels (must be > 0 when provided).

Returns:

True if successful (V2 returns its bool; V1 coerced to True).

Return type:

bool

Raises:

• TypeError – If types are invalid.

• ValueError – If only one of x/y provided or sizes are not positive.

save_plot_scale_image(filename)

Saves the current plot scale as an image.

Parameters:

filename (str) – The name of the file to save the image to.

Note:The image scale and size is the same as on the screen @

Returns:

True if successful, False otherwise.

Return type:

bool

set_banded_contours(plot_name, banding, num_colours)

Sets banded contours for the given plot.

Parameters:

• plot_name (str) – The name of the plot.

• banding (bool) – Whether to enable or disable banding.

• num_colours (int) – The number of colours to use for banding.

Return type:

None

set_histogram_location(x, y, x_size, y_size)

Sets the histogram location.

Parameters:

• x (float) – The x-coordinate of the bottom left corner of the histogram location.

• y (float) – The y-coordinate of the bottom left corner of the histogram location.

• x_size (float) – The width of the histogram.

• y_size (float) – The height of the histogram.

Return type:

None

set_min_max_maximum_label_location(x, y, x_size, y_size)

Sets the maximum label location for the min/max plot.

Parameters:

• x (float) – The x-coordinate of the bottom left corner of the maximum label location.

• y (float) – The y-coordinate of the bottom left corner of the maximum label location.

• x_size (float) – The width of the maximum label.

• y_size (float) – The height of the maximum label.

Return type:

None

set_min_max_minimum_label_location(x, y, x_size, y_size)

Sets the minimum label location for the min/max plot.

Parameters:

• x (float) – The x-coordinate of the bottom left corner of the minimum label location.

• y (float) – The y-coordinate of the bottom left corner of the minimum label location.

• x_size (float) – The width of the minimum label.

• y_size (float) – The height of the minimum label.

Return type:

None

set_view_mode(perspective)

Enables parallel or perspective projection.

Parameters:

perspective (ViewModes | int) – The perspective mode.

Return type:

None

set_view_size(size_x, size_y)

Sets the view size.

Parameters:

• size_x (int) – The width of the view.

• size_y (int) – The height of the view.

Returns:

True if successful, False otherwise.

Return type:

bool

show_plot(plot)

Show the given plot.

Parameters:

plot (Plot | None) – The plot to show.

Return type:

None

show_plot_by_name(plot_name)

Shows the plot with the given name.

Parameters:

plot_name (str) – The name of the plot to show.

Return type:

None

show_plot_frame(plot, frame)

Shows the given plot frame.

Parameters:

• plot (Plot | None) – The plot to show.

• frame (int) – The frame number to show.

Return type:

None

show_plot_frame_by_name(plot_name, frame)

Shows the plot frame with the given name and frame number.

Parameters:

• plot_name (str) – The name of the plot.

• frame (int) – The frame number to show.

Return type:

None

property view_size_x: int

Get the current view size width in pixels on the window restored size and position

Returns:

The width of the view.

Return type:

int

property view_size_y: int

Get the current view size height in pixels on the window restored size and position

Returns:

The height of the view.

Return type:

int

world_to_display(world_coord)

Converts world coordinates to display coordinates.

Parameters:

world_coord (Vector | None) – The world coordinates to convert.

Returns:

The converted display coordinates.

Return type:

Vector

zoom(factor)

Zooms the view

Parameters:

factor (float) – Zoom Factor, < 0 to zoom out > 0 to zoom in factors are normalized to the screen height, i.e., a factor of 1 moves the model by one screen-height to the top

Return type:

None