Skip to main content

ACP in-app scripting API 2026 R1

TubeSelectionRule

Last update: 16.07.2026

class compolyx.TubeSelectionRule(graph, obj, parent=None)

Represents a tube selection rule.

Attributes

Name Description
TubeSelectionRule.active Active status of the object.
TubeSelectionRule.changed Triggers an observable to dispatch a change notification.
TubeSelectionRule.display_data The tube rule mesh plot.
TubeSelectionRule.edge_set Edge Set for the Tube Selection Rule.
TubeSelectionRule.enabled Indicates whether the object is enabled.
TubeSelectionRule.extend_endings Whether to extend the ending of the edge.
TubeSelectionRule.extent Extent of the rule.
TubeSelectionRule.head Defines the head of the tube.
TubeSelectionRule.head_extension Specifies the length of the extension at the head of the tube.
TubeSelectionRule.id ID of the object.
TubeSelectionRule.include_rule_type include type.
TubeSelectionRule.inner_radius Inner tube-radius.
TubeSelectionRule.is_closed Returns true if the edge set of this rule is closed.
TubeSelectionRule.is_dict_item Indicates whether the object is an item in a dictionary.
TubeSelectionRule.is_list_item Indicates whether the object is an item of a list.
TubeSelectionRule.link_path Root path of the current node in the tree for links to this object.
TubeSelectionRule.mesh The mesh of the tube rule.
TubeSelectionRule.name Name of the object.
TubeSelectionRule.nodes Returns the nodes of this tube as nx3 array including the extensions.
TubeSelectionRule.outer_radius Outer tube-radius.
TubeSelectionRule.parent Parent object in the tree.
TubeSelectionRule.relative_rule_type relative type.
TubeSelectionRule.root_path Root path of the current node in the tree.
TubeSelectionRule.status Status of the object.
TubeSelectionRule.status_changed Boolean flag which is set to true in C++ when up-to-date status of object changes.
TubeSelectionRule.symmetrical_extension Whether the extensions are equal on both ends or not.
TubeSelectionRule.tail_extension Specifies the length of the extension at the tail of the tube.
TubeSelectionRule.uid UID of the object.
TubeSelectionRule.vertex Raises an error if the object has been removed from the graph.

Methods

Name Description
TubeSelectionRule.find_parent(type) Steps up the tree and returns the first parent with given type.
TubeSelectionRule.get_nodes() * Return:
List of nodes that define the central line of the tube.
TubeSelectionRule.get_short_description()
TubeSelectionRule.obj_exists() Checks if __obj still references the c++ object (has not been reset to None by self._delete) and exists in the graph.
TubeSelectionRule.serialize() Serialize to Python string.
TubeSelectionRule.serialize_name_and_id() Serializes the name and ID.
TubeSelectionRule.serialize_rule_types()
TubeSelectionRule.update()
TubeSelectionRule.visit(visitor) Walk through the tree and let the visitor perform action on every descendant node.

Connect with Ansys