viewport

class ansys.api.pyensight.ensight_api.viewport(session: Session)

Class wrapper for EnSight viewport module

This class acts as a proxy for the EnSight Python module ensight.viewport

Methods

viewport.auto_centering(p0)	Viewport: auto_centering
viewport.background_image(p0)	Specify the image file to be used as the background for the selected viewport(s).
viewport.background_type(p0)	Specify the type of background to be displayed for the selected viewport(s).
viewport.blend_editlevel(p0)	Specify the level to edit of the corresponding blended background type for the selected viewport(s), i.e. used to edit either the position or color of the level.
viewport.blend_levels(p0)	Specify the number of (vertical) levels of the corresponding blended background type for the selected viewport(s).
viewport.blend_position(p0)	Specify the position of the specified blend level of the corresponding blended background type for the selected viewport(s).
viewport.blend_rgb(p0, p1, p2)	Specify the red, green and blue components of the blended background color for the specified level of the selected viewport(s).
viewport.border_rgb(p0, p1, p2)	Set the color for the viewport border.
viewport.border_visible(p0)	Set visibility of viewport border.
viewport.constant_rgb(p0, p1, p2)	Specify the red, green and blue components of the constant background color for the selected viewport(s)
viewport.delete()	Delete all selected viewports.
viewport.exchange_with_largest(p0)	Viewport: exchange_with_largest
viewport.global_axis_location(p0, p1)	Viewport: global_axis_location
viewport.global_axis_visible(p0)	Viewport: global_axis_visible
viewport.global_axis_xlabel(p0)	Viewport: global_axis_xlabel
viewport.global_axis_ylabel(p0)	Viewport: global_axis_ylabel
viewport.global_axis_zlabel(p0)	Viewport: global_axis_zlabel
viewport.height(p0)	Specify the normalized height for the selected viewport(s).
viewport.hidden_line(p0)	Toggle whether hidden line meshes are to be overlaid onto parts in active viewport(s).
viewport.hidden_surface(p0)	Toggle whether hidden surfaces are to be removed from parts in active viewport(s).
viewport.light1_azimuth(p0)	Defines the azimuth angle of light source 1.
viewport.light1_elevation(p0)	Defines the elevation angle of light source 1.
viewport.light1_position(p0)	Defines whether light source 1 is defined in the model coordinate system (absolute) or in reference to the viewer.
viewport.light2_intensity(p0)	Defines the intensity of light source 2, which is always at the location of the viewer (camera).
viewport.light_converttoabs()	Converts light coordinates which are relative to the viewport to be absolute (relative to the model coordinate system) and thus have a static lighting effect.
viewport.lower()	Lower the selected viewport(s) to be located beneath all the other viewports - except the main viewport.
viewport.new()	Specify a new viewport to be created.
viewport.new_or_mod(p0)	This command has not yet been documented.
viewport.not_used(p0)	Viewport: not_used
viewport.origin_x(p0)	Specify the normalized x/y-coordinate value of the origin for the selected viewport(s).
viewport.origin_y(p0)	Specify the normalized x/y-coordinate value of the origin for the selected viewport(s).
viewport.perspective(p0)	Toggle whether viewing frustrum is to be perspective or orthographic in selected viewport(s).
viewport.query_count(args)	Viewport: query_count
viewport.query_display_attributes(args)	Viewport: query_display_attributes
viewport.query_location(args)	Viewport: query_location
viewport.query_mouse_info(args)	Viewport: query_mouse_info
viewport.query_object_atwindowxy(args)	Viewport: query_object_atwindowxy
viewport.query_size(args)	Viewport: query_size
viewport.query_window_depth(args)	Viewport: query_window_depth
viewport.query_window_mousepress(args)	Viewport: query_window_mousepress
viewport.query_window_rgba(args)	Viewport: query_window_rgba
viewport.query_window_size(args)	Viewport: query_window_size
viewport.select_all()	Select all created viewports for editing.
viewport.select_begin(*args, **kwargs)	Set active viewport(s) selection construct for subsequent viewport modification.
viewport.select_default()	Allows the setting of default viewport attributes prior to creating the next viewport.
viewport.track(p0)	Specify the location of the position to track (if any tracking is to be used).
viewport.tracking_node_id(p0)	Specify the node id to track.
viewport.tracking_part_id(args)	Specify the part id to use for the other location options for tracking.
viewport.tracking_partbyname(args)	Specify the part name to use for the other location options for tracking.
viewport.view_dimension(p0)	Set the dimension of the viewport.
viewport.viewport_layout(p0)	Specify the type of layout to be used in dividing the graphics window into viewports.
viewport.visible(p0)	Toggle whether selected viewports are visible.
viewport.width(p0)	Specify the normalized width for the selected viewport(s).