viewport_manager

class ansys.cfx.core.generated.post_processing.settings_261.viewport_manager.viewport_manager(name: str | None = None, parent=None)

Bases: Group

This object stores the parameters that control the global viewport controls.

Attributes

Attribute	Summary
background_colour	Defines the R, G and B values for the viewer background colour.
background_colour_2	Defines the R, G and B values for the second viewer background colour (used for gradients).
background_colour_type	Specifies the type of background colour gradient to use in the viewer.
background_image	The predefined image to use.
background_image_file	The image file to use for the viewer background.
background_image_mapping	Flat - image is mapped as a flat background; Spherical - image is mapped to a background sphere (must have 2x1 width to height pixel ratio).
background_image_type	The type of image to use.
background_type	Specifies the type of background to use in the viewer.
global_edge_colour	Defines the global colour used for mesh edges.
global_text_colour	Defines the global colour used for Text objects.
maximized_viewport	If set to a viewport number (1-4), the viewport will be resized to fill up the screen, regardless of the viewport layout.
synchronize_camera	Specifies if cameras in the active views will be synchronized.
synchronize_visibility	Specifies if visibility of an object in the active views will be synchronized.
view_length_units	Length units used in viewer.
viewer_camera_z	Specifies the distance from the scene origin to the screen plane.
viewer_eye_point	Specifies whether to place the viewer in a Stereo mode.
viewer_eye_separation	Specifies the distance between the eyes for Stereo Mode. A larger number will increase the stereo effect, and a smaller number will decrease the stereo effect.
viewport_1_view	Specifies the VIEW that Viewport 1 should display.
viewport_2_view	Specifies the VIEW that Viewport 2 should display.
viewport_3_view	Specifies the VIEW that Viewport 3 should display.
viewport_4_view	Specifies the VIEW that Viewport 4 should display.
viewport_layout	Specifies the layout of viewports.
x_split	The normalized location of the vertical viewport splitter.
y_split	The normalized location of the horizontal viewport splitter.

Methods

Method	Summary
suspend	Suspend immediate update for the object.
unsuspend	Restore immediate update for the object.

Included in:

Parent	Summary
results	Encapsulates a CFX post-processing setup.