Skip to main content
Version: Next

InterfaceLayer

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

Class to represent interface layer.

Attributes

NameDescription
InterfaceLayer.activeSequence Entity is active
InterfaceLayer.enabledWhether this object is currently enabled
InterfaceLayer.global_ply_nr
InterfaceLayer.idID of object
InterfaceLayer.is_dict_itemSpecifies whether the object is an item of a dict
InterfaceLayer.is_list_itemSpecifies whether the object is an item of a list
InterfaceLayer.link_pathRoot path of the current node in the tree for links to this object
InterfaceLayer.nameName of object
InterfaceLayer.open_area_setsOpen area set(s) of the Interface Layer
InterfaceLayer.oriented_selection_setsOriented Selection Sets of the Interface Layer
InterfaceLayer.parentParent object in tree
InterfaceLayer.ply_offsetsGet the offsetted Interface Layer
InterfaceLayer.root_pathRoot path of the current node in the tree
InterfaceLayer.statusStatus of the object
InterfaceLayer.status_changedBoolean flag which is set to true in C++ when up-to-date status of object changes
InterfaceLayer.uidUID of object
InterfaceLayer.vertexThrows an error if the object has been removed from the graph

Methods

NameDescription
InterfaceLayer.add_open_area_set(value)Add open area set to interface layer
InterfaceLayer.add_oriented_selection_set(...)Add oriented selection set
InterfaceLayer.clear_open_area_sets()Clears the open area selection
InterfaceLayer.clear_oriented_selection_sets()Clear all oriented selection sets of the interface layer
InterfaceLayer.find_parent(type)Function steps up the tree and returns the first parent with given type
InterfaceLayer.obj_exists()Checks if __obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph
InterfaceLayer.remove_open_area_set(value)Remove open area set from interface layer
InterfaceLayer.remove_oriented_selection_set(...)Remove oriented selection set from interface layer
InterfaceLayer.serialize()Serialize to Python string
InterfaceLayer.serialize_name_and_id()Helper function to serialize name and ID
InterfaceLayer.update()
InterfaceLayer.visit(visitor)Walk through the tree and let the visitor perform action on every descendant node