Skip to main content

ACP in-app scripting API 2026 R1

CADShell

Last update: 16.07.2026

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

Represents a CADShell.

Attributes

Name Description
CADShell.active Active status of the object.
CADShell.enabled Indicates whether the object is enabled.
CADShell.id ID of the object.
CADShell.is_dict_item Indicates whether the object is an item in a dictionary.
CADShell.is_free Boolean that indicates whether the shape is free..
CADShell.is_list_item Indicates whether the object is an item of a list.
CADShell.link_path Root path of the current node in the tree for links to this object.
CADShell.locked Locked status of the CAD Component.
CADShell.map_index Map index of the shape.
CADShell.name Name of the object.
CADShell.parent Parent object in the tree.
CADShell.path Returns the topology path of the CAD component.
CADShell.root_path Root path of the current node in the tree.
CADShell.status Status of the object.
CADShell.status_changed Boolean flag which is set to true in C++ when up-to-date status of object changes.
CADShell.sub_shapes Sub faces of the CAD shell.
CADShell.uid UID of the object.
CADShell.vertex Raises an error if the object has been removed from the graph.

Methods

Name Description
CADShell.find_parent(type) Steps up the tree and returns the first parent with given type.
CADShell.get_short_description()
CADShell.obj_exists() Checks if __obj still references the c++ object (has not been reset to None by self._delete) and exists in the graph.
CADShell.serialize_name_and_id() Serializes the name and ID.
CADShell.update() Update the CAD component.
CADShell.visit(visitor) Walk through the tree and let the visitor perform action on every descendant node.

Connect with Ansys