Skip to main content

ACP in-app scripting API 2026 R1

Scene

Last update: 16.07.2026

class compolyx.Scene(graph, model=None, name='', id=None, title='', view=None, parent=None, active_set=None)

Represents a scene.

Attributes

Name Description
Scene.active_set Set of active entities.
Scene.background Background color.
Scene.background2 Background color 2.
Scene.camera Camera settings.
Scene.changed Status boolean.
Scene.continuous_pick_enabled
Scene.deformed
Scene.descriptions_changed Set to True if descriptions should be updated.
Scene.display_data
Scene.event_snapshot
Scene.fit_to_window Reset the zoom of the window.
Scene.foreground Foreground color.
Scene.id
Scene.is_dict_item Indicates whether the object is an item in a dictionary.
Scene.is_list_item Indicates whether the object is an item of a list.
Scene.lighting_mode
Scene.link_path Root path of the current node in the tree for links to this object.
Scene.logo_type Logo type (“default” or “black”).
Scene.mode Current ACP mode (preprocessing).
Scene.model
Scene.name Name of the object.
Scene.parent Parent object in the tree.
Scene.projection Projection method ("parallel" or "perspective").
Scene.root_path Root path of the current node in the tree.
Scene.scale_factor Scale factor of the deformed mesh.
Scene.show_contour_and_direction_in_front
Scene.show_draped_fiber_directions
Scene.show_draped_transverse_directions
Scene.show_edges
Scene.show_element_selection_through_mesh
Scene.show_element_type Highlight "shell" or "solid" elements, or use "automatic" to select solid elements if the object belongs to a solid model.Note: Only analysis plies have solid elements.
Scene.show_fiber_directions
Scene.show_global_coordinate_system Toggle visibility of global coordinate system marker.
Scene.show_labeled_bounding_box Toggle visibility of labeled bounding box.
Scene.show_legend
Scene.show_material_1_directions
Scene.show_measure
Scene.show_mesh_silhouette
Scene.show_minmax
Scene.show_normals
Scene.show_orientations
Scene.show_ref_directions
Scene.show_section_cut_plots
Scene.show_selected_mesh Indicates whether to show/highlight currently selected Elements.
Scene.show_silhouette Whether to show the silhouette of currently selected elements.
Scene.show_surface
Scene.show_transverse_directions
Scene.static_display_data
Scene.static_plots
Scene.status Status of the object.
Scene.title Scene title.
Scene.uptodate Apply a view to the scene.
Scene.view Apply a view to the scene.

Methods

Name Description
Scene.connect()
Scene.disconnect()
Scene.find_parent(type) Steps up the tree and returns the first parent with given type.
Scene.get_display_data_for(obj)
Scene.save_snapshot(path[, width, height, ...]) Create a snapshot of the scene.
Scene.serialize() Serialize to Python string.
Scene.update()
Scene.update_direction_display_data(entities) Function synchronizes the following direction plots with the added/removed entities given: - "orientations" - "ref_directions" - "fiber_directions" - "draped_fiber_directions".
Scene.visit(visitor) Walk through the tree and let the visitor perform action on every descendant node.

Connect with Ansys