diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.direction_arrows.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.direction_arrows.md index 0da4e7fcbc..3e6114f623 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.direction_arrows.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.direction_arrows.md @@ -7,6 +7,6 @@ Direction arrows of the ply. * **Parameters:** - - arrow_length: Length of the arrow. - - arrow_type: ‘standard_arrow’ (default), ‘no_arrow’, ‘half_arrow’. - - offset_type: ‘no_offset’ (default), ‘bottom_offset’, ‘middle_offset’, ‘top_offset’. + - arrow_length: Length of the arrow + - arrow_type: `standard_arrow` (default), `no_arrow`, `half_arrow` + - offset_type: `no_offset` (default), `bottom_offset`, `middle_offset`, `top_offset` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.enabled.md index a8f1559871..d1b9bbc5c6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.enabled.md @@ -4,4 +4,4 @@ #### *property* AnalysisPly.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.find_parent.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.find_parent.md index 73fdc16771..d824dcd4b1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.find_parent.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.find_parent.md @@ -4,5 +4,5 @@ #### AnalysisPly.find_parent(type) -Function steps up the tree and returns the first parent with given type. +Steps up the tree and returns the first parent with given type. If object has no parent of this type, the function returns None. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_dict_item.md index 9695701c3e..a045d55fae 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* AnalysisPly.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_list_item.md index 6ff0965a97..a568938f52 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_list_item.md @@ -4,4 +4,4 @@ #### *property* AnalysisPly.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_reinforcing.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_reinforcing.md index 7e36f201b8..7c074e2ecd 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_reinforcing.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_reinforcing.md @@ -6,5 +6,5 @@ True if the AnalysisPly is a reinforcing ply. -For instance, if linked to a Layup Mapping object of type “reinforcing” or -to an Imported Solid Model via a Mapping Object of type “reinforcing”. +For instance, if linked to a Layup Mapping object of type `reinforcing` or +to an Imported Solid Model via a Mapping Object of type `reinforcing`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.md index f97dadce2d..bd3fcdb13e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.md @@ -4,45 +4,45 @@ ### *class* compolyx.AnalysisPly(graph, obj, parent=None) -ComPoLyX Class to represent analysis ply. +ComPoLyX class to represent analysis ply. ### Attributes | Name | Description | |---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`AnalysisPly.active`](compolyx.AnalysisPly.active.md#compolyx.AnalysisPly.active) | Sequence Entity is active | -| [`AnalysisPly.active_in_post_mode`](compolyx.AnalysisPly.active_in_post_mode.md#compolyx.AnalysisPly.active_in_post_mode) | True if failure criteria will be processed for this ply. | -| [`AnalysisPly.angle`](compolyx.AnalysisPly.angle.md#compolyx.AnalysisPly.angle) | Ply Angle of the Analysis Ply | -| [`AnalysisPly.draping_obj`](compolyx.AnalysisPly.draping_obj.md#compolyx.AnalysisPly.draping_obj) | Get the Fiber Directions of the Analysis Ply | -| [`AnalysisPly.enabled`](compolyx.AnalysisPly.enabled.md#compolyx.AnalysisPly.enabled) | Whether this object is currently enabled or not. | +| [`AnalysisPly.active`](compolyx.AnalysisPly.active.md#compolyx.AnalysisPly.active) | Sequence entity is active | +| [`AnalysisPly.active_in_post_mode`](compolyx.AnalysisPly.active_in_post_mode.md#compolyx.AnalysisPly.active_in_post_mode) | True if failure criteria will be processed for this ply | +| [`AnalysisPly.angle`](compolyx.AnalysisPly.angle.md#compolyx.AnalysisPly.angle) | Ply Angle of the analysis ply | +| [`AnalysisPly.draping_obj`](compolyx.AnalysisPly.draping_obj.md#compolyx.AnalysisPly.draping_obj) | Get the fiber directions of the analysis ply | +| [`AnalysisPly.enabled`](compolyx.AnalysisPly.enabled.md#compolyx.AnalysisPly.enabled) | Whether this object is currently enabled or not | | [`AnalysisPly.id`](compolyx.AnalysisPly.id.md#compolyx.AnalysisPly.id) | ID of object | -| [`AnalysisPly.is_dict_item`](compolyx.AnalysisPly.is_dict_item.md#compolyx.AnalysisPly.is_dict_item) | Specifies wether the object is an item of a dict | -| [`AnalysisPly.is_list_item`](compolyx.AnalysisPly.is_list_item.md#compolyx.AnalysisPly.is_list_item) | Specifies wether the object is an item of a list | +| [`AnalysisPly.is_dict_item`](compolyx.AnalysisPly.is_dict_item.md#compolyx.AnalysisPly.is_dict_item) | Specifies whether the object is an item of a dict | +| [`AnalysisPly.is_list_item`](compolyx.AnalysisPly.is_list_item.md#compolyx.AnalysisPly.is_list_item) | Specifies whether the object is an item of a list | | [`AnalysisPly.link_path`](compolyx.AnalysisPly.link_path.md#compolyx.AnalysisPly.link_path) | Root path of the current node in the tree for links to this object | -| [`AnalysisPly.material`](compolyx.AnalysisPly.material.md#compolyx.AnalysisPly.material) | Ply Material of the Analysis Ply | -| [`AnalysisPly.mesh`](compolyx.AnalysisPly.mesh.md#compolyx.AnalysisPly.mesh) | Mesh. | +| [`AnalysisPly.material`](compolyx.AnalysisPly.material.md#compolyx.AnalysisPly.material) | Ply material of the analysis ply | +| [`AnalysisPly.mesh`](compolyx.AnalysisPly.mesh.md#compolyx.AnalysisPly.mesh) | Mesh | | [`AnalysisPly.name`](compolyx.AnalysisPly.name.md#compolyx.AnalysisPly.name) | Name of object | | [`AnalysisPly.parent`](compolyx.AnalysisPly.parent.md#compolyx.AnalysisPly.parent) | Parent object in tree | -| [`AnalysisPly.ply_material`](compolyx.AnalysisPly.ply_material.md#compolyx.AnalysisPly.ply_material) | Ply Material of the Analysis Ply | +| [`AnalysisPly.ply_material`](compolyx.AnalysisPly.ply_material.md#compolyx.AnalysisPly.ply_material) | Ply material of the analysis ply | | [`AnalysisPly.root_path`](compolyx.AnalysisPly.root_path.md#compolyx.AnalysisPly.root_path) | Root path of the current node in the tree | | [`AnalysisPly.status`](compolyx.AnalysisPly.status.md#compolyx.AnalysisPly.status) | Status of the object | -| [`AnalysisPly.status_changed`](compolyx.AnalysisPly.status_changed.md#compolyx.AnalysisPly.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`AnalysisPly.thickness`](compolyx.AnalysisPly.thickness.md#compolyx.AnalysisPly.thickness) | Thickness of the Analysis Ply | +| [`AnalysisPly.status_changed`](compolyx.AnalysisPly.status_changed.md#compolyx.AnalysisPly.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`AnalysisPly.thickness`](compolyx.AnalysisPly.thickness.md#compolyx.AnalysisPly.thickness) | Thickness of the analysis ply | | [`AnalysisPly.uid`](compolyx.AnalysisPly.uid.md#compolyx.AnalysisPly.uid) | UID of object | -| [`AnalysisPly.vertex`](compolyx.AnalysisPly.vertex.md#compolyx.AnalysisPly.vertex) | This will throw an error if the object has been removed from the graph. | +| [`AnalysisPly.vertex`](compolyx.AnalysisPly.vertex.md#compolyx.AnalysisPly.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| | [`AnalysisPly.boundaries`](compolyx.AnalysisPly.boundaries.md#compolyx.AnalysisPly.boundaries)([offset_type]) | | -| [`AnalysisPly.direction_arrows`](compolyx.AnalysisPly.direction_arrows.md#compolyx.AnalysisPly.direction_arrows)([arrow_length, ...]) | Direction arrows of the ply. | -| [`AnalysisPly.find_parent`](compolyx.AnalysisPly.find_parent.md#compolyx.AnalysisPly.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`AnalysisPly.direction_arrows`](compolyx.AnalysisPly.direction_arrows.md#compolyx.AnalysisPly.direction_arrows)([arrow_length, ...]) | Direction arrows of the ply | +| [`AnalysisPly.find_parent`](compolyx.AnalysisPly.find_parent.md#compolyx.AnalysisPly.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`AnalysisPly.get_short_description`](compolyx.AnalysisPly.get_short_description.md#compolyx.AnalysisPly.get_short_description)() | | -| [`AnalysisPly.is_reinforcing`](compolyx.AnalysisPly.is_reinforcing.md#compolyx.AnalysisPly.is_reinforcing)() | True if the AnalysisPly is a reinforcing ply. | -| [`AnalysisPly.obj_exists`](compolyx.AnalysisPly.obj_exists.md#compolyx.AnalysisPly.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. | +| [`AnalysisPly.is_reinforcing`](compolyx.AnalysisPly.is_reinforcing.md#compolyx.AnalysisPly.is_reinforcing)() | True if the AnalysisPly is a reinforcing ply | +| [`AnalysisPly.obj_exists`](compolyx.AnalysisPly.obj_exists.md#compolyx.AnalysisPly.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 | | [`AnalysisPly.serialize`](compolyx.AnalysisPly.serialize.md#compolyx.AnalysisPly.serialize)() | | -| [`AnalysisPly.serialize_name_and_id`](compolyx.AnalysisPly.serialize_name_and_id.md#compolyx.AnalysisPly.serialize_name_and_id)() | Helper function to serialize name and ID. | -| [`AnalysisPly.update`](compolyx.AnalysisPly.update.md#compolyx.AnalysisPly.update)() | Update the analysis ply. | -| [`AnalysisPly.visit`](compolyx.AnalysisPly.visit.md#compolyx.AnalysisPly.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | -| [`AnalysisPly.write_boundaries`](compolyx.AnalysisPly.write_boundaries.md#compolyx.AnalysisPly.write_boundaries)(filename[, ...]) | Write boundaries in .iges/.step format. | +| [`AnalysisPly.serialize_name_and_id`](compolyx.AnalysisPly.serialize_name_and_id.md#compolyx.AnalysisPly.serialize_name_and_id)() | Helper function to serialize name and ID | +| [`AnalysisPly.update`](compolyx.AnalysisPly.update.md#compolyx.AnalysisPly.update)() | Update the analysis ply | +| [`AnalysisPly.visit`](compolyx.AnalysisPly.visit.md#compolyx.AnalysisPly.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | +| [`AnalysisPly.write_boundaries`](compolyx.AnalysisPly.write_boundaries.md#compolyx.AnalysisPly.write_boundaries)(filename[, ...]) | Write boundaries in .iges/.step format | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.mesh.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.mesh.md index 08d6577a08..b16b76ee60 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.mesh.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.mesh.md @@ -4,4 +4,4 @@ #### *property* AnalysisPly.mesh -Mesh. Only available if analysis plyis reinforcement +Mesh. Only available if analysis ply is reinforced. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.obj_exists.md index bf77b98ebb..aceb801c9e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.obj_exists.md @@ -4,5 +4,5 @@ #### AnalysisPly.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.visit.md index 060a64eade..0f13891855 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.visit.md @@ -9,7 +9,7 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter - -Returns True if the visitor returned True for at least one descendant/linked node. + - visitor: A callable which accepts a TreeNode instance as parameter +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.write_boundaries.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.write_boundaries.md index 028590aaaa..f19954b1e0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.write_boundaries.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.write_boundaries.md @@ -7,9 +7,9 @@ Write boundaries in .iges/.step format. * **Parameters:** - - filename: Output file. - - format: ‘iges’, ‘step’, None (automatic format recognition). - - offset_type: ‘no_offset’ (default), ‘bottom_offset’, ‘middle_offset’, ‘top_offset’. - - with_direction_arrows: The element directions should be written to. - - arrow_length: Length of the direction arrows (default is average element edge size). - - arrow_type: Type to be used as arrows (‘standard_arrow’ (default), ‘no_arrow’, ‘half_arrow’). + - filename: Output file + - format: `iges`, `step`, `None` (automatic format recognition) + - offset_type: `no_offset` (default), `bottom_offset`, `middle_offset`, `top_offset` + - with_direction_arrows: The element directions should be written to + - arrow_length: Length of the direction arrows (default is average element edge size) + - arrow_type: Type to be used as arrows (`standard_arrow` (default), `no_arrow`, `half_arrow`) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.active.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.active.md index 186c05ae71..b2fd625999 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.active.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.active.md @@ -4,4 +4,4 @@ #### *property* BooleanSelectionRule.active -active status of object +Active status of object diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.add_rule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.add_rule.md index 01c8c180d1..a23d239114 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.add_rule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.add_rule.md @@ -10,7 +10,7 @@ Add selection rule to boolean selection rule. - rule: The rule to be added. - template_rule: Whether this is a template rule. - rule_values: Parameters of the template rule (for instance, the upper and lower limits of a ParallelSelectionRule). - - operation_type: Boolean operation type (intersect, add, remove). + - operation_type: Boolean operation type (`intersect`, `add`, `remove`). Example: >>> boolean_rule.add_rule(rule=model.selection_rules[‘ParallelRule.1’],template_rule=True, rule_values=(-20.0, 50.0), operation_type=’intersect’) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.enabled.md index 5e29a9ffc6..a81b298630 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.enabled.md @@ -4,4 +4,4 @@ #### *property* BooleanSelectionRule.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.extent.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.extent.md index 0fed0e2cae..39540aa0d7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.extent.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.extent.md @@ -4,4 +4,4 @@ #### *property* BooleanSelectionRule.extent -extent of the rule +Extent of the rule diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.include_rule_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.include_rule_type.md index be29744daf..b982ed6a44 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.include_rule_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.include_rule_type.md @@ -4,4 +4,4 @@ #### *property* BooleanSelectionRule.include_rule_type -include type +Include type diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_dict_item.md index 1b8118d911..d905ae620f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* BooleanSelectionRule.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_list_item.md index 8432d0a000..cf22c0ff2a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_list_item.md @@ -4,4 +4,4 @@ #### *property* BooleanSelectionRule.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.md index bf893d6247..42b944c587 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.md @@ -10,35 +10,35 @@ Boolean selection rule. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`BooleanSelectionRule.active`](compolyx.BooleanSelectionRule.active.md#compolyx.BooleanSelectionRule.active) | active status of object | +| [`BooleanSelectionRule.active`](compolyx.BooleanSelectionRule.active.md#compolyx.BooleanSelectionRule.active) | Active status of object | | [`BooleanSelectionRule.changed`](compolyx.BooleanSelectionRule.changed.md#compolyx.BooleanSelectionRule.changed) | Triggers Observable to dispatch changed message | -| [`BooleanSelectionRule.enabled`](compolyx.BooleanSelectionRule.enabled.md#compolyx.BooleanSelectionRule.enabled) | Whether this object is currently enabled or not. | -| [`BooleanSelectionRule.extent`](compolyx.BooleanSelectionRule.extent.md#compolyx.BooleanSelectionRule.extent) | extent of the rule | +| [`BooleanSelectionRule.enabled`](compolyx.BooleanSelectionRule.enabled.md#compolyx.BooleanSelectionRule.enabled) | Whether this object is currently enabled or not | +| [`BooleanSelectionRule.extent`](compolyx.BooleanSelectionRule.extent.md#compolyx.BooleanSelectionRule.extent) | Extent of the rule | | [`BooleanSelectionRule.id`](compolyx.BooleanSelectionRule.id.md#compolyx.BooleanSelectionRule.id) | ID of object | -| [`BooleanSelectionRule.include_rule_type`](compolyx.BooleanSelectionRule.include_rule_type.md#compolyx.BooleanSelectionRule.include_rule_type) | include type | -| [`BooleanSelectionRule.is_dict_item`](compolyx.BooleanSelectionRule.is_dict_item.md#compolyx.BooleanSelectionRule.is_dict_item) | Specifies wether the object is an item of a dict | -| [`BooleanSelectionRule.is_list_item`](compolyx.BooleanSelectionRule.is_list_item.md#compolyx.BooleanSelectionRule.is_list_item) | Specifies wether the object is an item of a list | +| [`BooleanSelectionRule.include_rule_type`](compolyx.BooleanSelectionRule.include_rule_type.md#compolyx.BooleanSelectionRule.include_rule_type) | Include type | +| [`BooleanSelectionRule.is_dict_item`](compolyx.BooleanSelectionRule.is_dict_item.md#compolyx.BooleanSelectionRule.is_dict_item) | Specifies whether the object is an item of a dict | +| [`BooleanSelectionRule.is_list_item`](compolyx.BooleanSelectionRule.is_list_item.md#compolyx.BooleanSelectionRule.is_list_item) | Specifies whether the object is an item of a list | | [`BooleanSelectionRule.link_path`](compolyx.BooleanSelectionRule.link_path.md#compolyx.BooleanSelectionRule.link_path) | Root path of the current node in the tree for links to this object | | [`BooleanSelectionRule.name`](compolyx.BooleanSelectionRule.name.md#compolyx.BooleanSelectionRule.name) | Name of object | | [`BooleanSelectionRule.parent`](compolyx.BooleanSelectionRule.parent.md#compolyx.BooleanSelectionRule.parent) | Parent object in tree | -| [`BooleanSelectionRule.relative_rule_type`](compolyx.BooleanSelectionRule.relative_rule_type.md#compolyx.BooleanSelectionRule.relative_rule_type) | relative type | +| [`BooleanSelectionRule.relative_rule_type`](compolyx.BooleanSelectionRule.relative_rule_type.md#compolyx.BooleanSelectionRule.relative_rule_type) | Relative type | | [`BooleanSelectionRule.root_path`](compolyx.BooleanSelectionRule.root_path.md#compolyx.BooleanSelectionRule.root_path) | Root path of the current node in the tree | | [`BooleanSelectionRule.selection_rules`](compolyx.BooleanSelectionRule.selection_rules.md#compolyx.BooleanSelectionRule.selection_rules) | Element Selection Rule of the Boolean Selection Rule. | | [`BooleanSelectionRule.status`](compolyx.BooleanSelectionRule.status.md#compolyx.BooleanSelectionRule.status) | Status of the object | -| [`BooleanSelectionRule.status_changed`](compolyx.BooleanSelectionRule.status_changed.md#compolyx.BooleanSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`BooleanSelectionRule.status_changed`](compolyx.BooleanSelectionRule.status_changed.md#compolyx.BooleanSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`BooleanSelectionRule.uid`](compolyx.BooleanSelectionRule.uid.md#compolyx.BooleanSelectionRule.uid) | UID of object | -| [`BooleanSelectionRule.vertex`](compolyx.BooleanSelectionRule.vertex.md#compolyx.BooleanSelectionRule.vertex) | This will throw an error if the object has been removed from the graph. | +| [`BooleanSelectionRule.vertex`](compolyx.BooleanSelectionRule.vertex.md#compolyx.BooleanSelectionRule.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`BooleanSelectionRule.add_rule`](compolyx.BooleanSelectionRule.add_rule.md#compolyx.BooleanSelectionRule.add_rule)(rule[, ...]) | Add selection rule to boolean selection rule. | -| [`BooleanSelectionRule.find_parent`](compolyx.BooleanSelectionRule.find_parent.md#compolyx.BooleanSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`BooleanSelectionRule.add_rule`](compolyx.BooleanSelectionRule.add_rule.md#compolyx.BooleanSelectionRule.add_rule)(rule[, ...]) | Add selection rule to boolean selection rule | +| [`BooleanSelectionRule.find_parent`](compolyx.BooleanSelectionRule.find_parent.md#compolyx.BooleanSelectionRule.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`BooleanSelectionRule.get_short_description`](compolyx.BooleanSelectionRule.get_short_description.md#compolyx.BooleanSelectionRule.get_short_description)() | | -| [`BooleanSelectionRule.obj_exists`](compolyx.BooleanSelectionRule.obj_exists.md#compolyx.BooleanSelectionRule.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. | -| [`BooleanSelectionRule.serialize`](compolyx.BooleanSelectionRule.serialize.md#compolyx.BooleanSelectionRule.serialize)() | Serialize to Python string. | -| [`BooleanSelectionRule.serialize_name_and_id`](compolyx.BooleanSelectionRule.serialize_name_and_id.md#compolyx.BooleanSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`BooleanSelectionRule.obj_exists`](compolyx.BooleanSelectionRule.obj_exists.md#compolyx.BooleanSelectionRule.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 | +| [`BooleanSelectionRule.serialize`](compolyx.BooleanSelectionRule.serialize.md#compolyx.BooleanSelectionRule.serialize)() | Serialize to Python string | +| [`BooleanSelectionRule.serialize_name_and_id`](compolyx.BooleanSelectionRule.serialize_name_and_id.md#compolyx.BooleanSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID | | [`BooleanSelectionRule.serialize_rule_types`](compolyx.BooleanSelectionRule.serialize_rule_types.md#compolyx.BooleanSelectionRule.serialize_rule_types)() | | | [`BooleanSelectionRule.update`](compolyx.BooleanSelectionRule.update.md#compolyx.BooleanSelectionRule.update)() | | -| [`BooleanSelectionRule.visit`](compolyx.BooleanSelectionRule.visit.md#compolyx.BooleanSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`BooleanSelectionRule.visit`](compolyx.BooleanSelectionRule.visit.md#compolyx.BooleanSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.obj_exists.md index 6a58741a38..e7d29a6038 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.obj_exists.md @@ -4,5 +4,5 @@ #### BooleanSelectionRule.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.relative_rule_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.relative_rule_type.md index fe1eff2230..2a99d673c3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.relative_rule_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.relative_rule_type.md @@ -4,4 +4,4 @@ #### *property* BooleanSelectionRule.relative_rule_type -relative type +Relative type diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.visit.md index cb04a0d839..8c1c6c46bd 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.enabled.md index 3887fbc65f..0ae530b610 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.enabled.md @@ -4,4 +4,4 @@ #### *property* ButtJointSequence.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.is_dict_item.md index 4ff433d571..c1e3a5194c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ButtJointSequence.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.is_list_item.md index 4d489a62ef..b6b99e8938 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ButtJointSequence.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.md index e71c11029a..7ea2599833 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.md @@ -11,11 +11,11 @@ Class to represent the butt-joint sequence. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| | [`ButtJointSequence.active`](compolyx.ButtJointSequence.active.md#compolyx.ButtJointSequence.active) | Sequence Entity is active | -| [`ButtJointSequence.enabled`](compolyx.ButtJointSequence.enabled.md#compolyx.ButtJointSequence.enabled) | Whether this object is currently enabled or not. | +| [`ButtJointSequence.enabled`](compolyx.ButtJointSequence.enabled.md#compolyx.ButtJointSequence.enabled) | Whether this object is currently enabled or not | | [`ButtJointSequence.global_ply_nr`](compolyx.ButtJointSequence.global_ply_nr.md#compolyx.ButtJointSequence.global_ply_nr) | | | [`ButtJointSequence.id`](compolyx.ButtJointSequence.id.md#compolyx.ButtJointSequence.id) | ID of object | -| [`ButtJointSequence.is_dict_item`](compolyx.ButtJointSequence.is_dict_item.md#compolyx.ButtJointSequence.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ButtJointSequence.is_list_item`](compolyx.ButtJointSequence.is_list_item.md#compolyx.ButtJointSequence.is_list_item) | Specifies wether the object is an item of a list | +| [`ButtJointSequence.is_dict_item`](compolyx.ButtJointSequence.is_dict_item.md#compolyx.ButtJointSequence.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ButtJointSequence.is_list_item`](compolyx.ButtJointSequence.is_list_item.md#compolyx.ButtJointSequence.is_list_item) | Specifies whether the object is an item of a list | | [`ButtJointSequence.link_path`](compolyx.ButtJointSequence.link_path.md#compolyx.ButtJointSequence.link_path) | Root path of the current node in the tree for links to this object | | [`ButtJointSequence.name`](compolyx.ButtJointSequence.name.md#compolyx.ButtJointSequence.name) | Name of object | | [`ButtJointSequence.parent`](compolyx.ButtJointSequence.parent.md#compolyx.ButtJointSequence.parent) | Parent object in tree | @@ -23,17 +23,17 @@ Class to represent the butt-joint sequence. | [`ButtJointSequence.root_path`](compolyx.ButtJointSequence.root_path.md#compolyx.ButtJointSequence.root_path) | Root path of the current node in the tree | | [`ButtJointSequence.secondary_plies`](compolyx.ButtJointSequence.secondary_plies.md#compolyx.ButtJointSequence.secondary_plies) | Secondary plies of the butt joint squence | | [`ButtJointSequence.status`](compolyx.ButtJointSequence.status.md#compolyx.ButtJointSequence.status) | Status of the object | -| [`ButtJointSequence.status_changed`](compolyx.ButtJointSequence.status_changed.md#compolyx.ButtJointSequence.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`ButtJointSequence.status_changed`](compolyx.ButtJointSequence.status_changed.md#compolyx.ButtJointSequence.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`ButtJointSequence.uid`](compolyx.ButtJointSequence.uid.md#compolyx.ButtJointSequence.uid) | UID of object | -| [`ButtJointSequence.vertex`](compolyx.ButtJointSequence.vertex.md#compolyx.ButtJointSequence.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ButtJointSequence.vertex`](compolyx.ButtJointSequence.vertex.md#compolyx.ButtJointSequence.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ButtJointSequence.find_parent`](compolyx.ButtJointSequence.find_parent.md#compolyx.ButtJointSequence.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`ButtJointSequence.obj_exists`](compolyx.ButtJointSequence.obj_exists.md#compolyx.ButtJointSequence.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. | -| [`ButtJointSequence.serialize`](compolyx.ButtJointSequence.serialize.md#compolyx.ButtJointSequence.serialize)() | Serialize to Python string. | -| [`ButtJointSequence.serialize_name_and_id`](compolyx.ButtJointSequence.serialize_name_and_id.md#compolyx.ButtJointSequence.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ButtJointSequence.find_parent`](compolyx.ButtJointSequence.find_parent.md#compolyx.ButtJointSequence.find_parent)(type) | Steps up the tree and returns the first parent with given type | +| [`ButtJointSequence.obj_exists`](compolyx.ButtJointSequence.obj_exists.md#compolyx.ButtJointSequence.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 | +| [`ButtJointSequence.serialize`](compolyx.ButtJointSequence.serialize.md#compolyx.ButtJointSequence.serialize)() | Serialize to Python string | +| [`ButtJointSequence.serialize_name_and_id`](compolyx.ButtJointSequence.serialize_name_and_id.md#compolyx.ButtJointSequence.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ButtJointSequence.update`](compolyx.ButtJointSequence.update.md#compolyx.ButtJointSequence.update)() | | -| [`ButtJointSequence.visit`](compolyx.ButtJointSequence.visit.md#compolyx.ButtJointSequence.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ButtJointSequence.visit`](compolyx.ButtJointSequence.visit.md#compolyx.ButtJointSequence.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.obj_exists.md index cbdef3ec38..3a3b1e7fa1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ButtJointSequence.obj_exists.md @@ -4,5 +4,5 @@ #### ButtJointSequence.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.active.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.active.md index 896a78486f..656ab855c7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.active.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.active.md @@ -4,4 +4,4 @@ #### *property* CADCompound.active -active status of object +Active status of object diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.enabled.md index c03435c4c1..86852a12d1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.enabled.md @@ -4,4 +4,4 @@ #### *property* CADCompound.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.is_dict_item.md index df6c9cbf4d..b99325732e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* CADCompound.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.is_list_item.md index f0b31715e7..eb24ed6435 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.is_list_item.md @@ -4,4 +4,4 @@ #### *property* CADCompound.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.md index c7b45d4ae4..2a24787e49 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.md @@ -10,32 +10,32 @@ ComPoLyX Class to represent CADCompound. | Name | Description | |------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`CADCompound.active`](compolyx.CADCompound.active.md#compolyx.CADCompound.active) | active status of object | -| [`CADCompound.enabled`](compolyx.CADCompound.enabled.md#compolyx.CADCompound.enabled) | Whether this object is currently enabled or not. | +| [`CADCompound.active`](compolyx.CADCompound.active.md#compolyx.CADCompound.active) | Active status of object | +| [`CADCompound.enabled`](compolyx.CADCompound.enabled.md#compolyx.CADCompound.enabled) | Whether this object is currently enabled or not | | [`CADCompound.id`](compolyx.CADCompound.id.md#compolyx.CADCompound.id) | ID of object | -| [`CADCompound.is_dict_item`](compolyx.CADCompound.is_dict_item.md#compolyx.CADCompound.is_dict_item) | Specifies wether the object is an item of a dict | -| [`CADCompound.is_free`](compolyx.CADCompound.is_free.md#compolyx.CADCompound.is_free) | Boolean whether the shape is free or not. | -| [`CADCompound.is_list_item`](compolyx.CADCompound.is_list_item.md#compolyx.CADCompound.is_list_item) | Specifies wether the object is an item of a list | +| [`CADCompound.is_dict_item`](compolyx.CADCompound.is_dict_item.md#compolyx.CADCompound.is_dict_item) | Specifies whether the object is an item of a dict | +| [`CADCompound.is_free`](compolyx.CADCompound.is_free.md#compolyx.CADCompound.is_free) | Boolean whether the shape is free or not | +| [`CADCompound.is_list_item`](compolyx.CADCompound.is_list_item.md#compolyx.CADCompound.is_list_item) | Specifies whether the object is an item of a list | | [`CADCompound.link_path`](compolyx.CADCompound.link_path.md#compolyx.CADCompound.link_path) | Root path of the current node in the tree for links to this object | -| [`CADCompound.locked`](compolyx.CADCompound.locked.md#compolyx.CADCompound.locked) | Locked status of the CAD Component | +| [`CADCompound.locked`](compolyx.CADCompound.locked.md#compolyx.CADCompound.locked) | Locked status of the CAD component | | [`CADCompound.map_index`](compolyx.CADCompound.map_index.md#compolyx.CADCompound.map_index) | Map index of the shape | | [`CADCompound.name`](compolyx.CADCompound.name.md#compolyx.CADCompound.name) | Name of object | | [`CADCompound.parent`](compolyx.CADCompound.parent.md#compolyx.CADCompound.parent) | Parent object in tree | -| [`CADCompound.path`](compolyx.CADCompound.path.md#compolyx.CADCompound.path) | Returns topology path of the CADComponent. | +| [`CADCompound.path`](compolyx.CADCompound.path.md#compolyx.CADCompound.path) | Returns topology path of the CADComponent | | [`CADCompound.root_path`](compolyx.CADCompound.root_path.md#compolyx.CADCompound.root_path) | Root path of the current node in the tree | | [`CADCompound.status`](compolyx.CADCompound.status.md#compolyx.CADCompound.status) | Status of the object | -| [`CADCompound.status_changed`](compolyx.CADCompound.status_changed.md#compolyx.CADCompound.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`CADCompound.sub_shapes`](compolyx.CADCompound.sub_shapes.md#compolyx.CADCompound.sub_shapes) | Sub faces of the CAD Compound. | +| [`CADCompound.status_changed`](compolyx.CADCompound.status_changed.md#compolyx.CADCompound.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`CADCompound.sub_shapes`](compolyx.CADCompound.sub_shapes.md#compolyx.CADCompound.sub_shapes) | Sub faces of the CAD compound | | [`CADCompound.uid`](compolyx.CADCompound.uid.md#compolyx.CADCompound.uid) | UID of object | -| [`CADCompound.vertex`](compolyx.CADCompound.vertex.md#compolyx.CADCompound.vertex) | This will throw an error if the object has been removed from the graph. | +| [`CADCompound.vertex`](compolyx.CADCompound.vertex.md#compolyx.CADCompound.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`CADCompound.find_parent`](compolyx.CADCompound.find_parent.md#compolyx.CADCompound.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`CADCompound.find_parent`](compolyx.CADCompound.find_parent.md#compolyx.CADCompound.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`CADCompound.get_short_description`](compolyx.CADCompound.get_short_description.md#compolyx.CADCompound.get_short_description)() | | -| [`CADCompound.obj_exists`](compolyx.CADCompound.obj_exists.md#compolyx.CADCompound.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. | -| [`CADCompound.serialize_name_and_id`](compolyx.CADCompound.serialize_name_and_id.md#compolyx.CADCompound.serialize_name_and_id)() | Helper function to serialize name and ID. | -| [`CADCompound.update`](compolyx.CADCompound.update.md#compolyx.CADCompound.update)() | Update the CadComponent. | -| [`CADCompound.visit`](compolyx.CADCompound.visit.md#compolyx.CADCompound.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`CADCompound.obj_exists`](compolyx.CADCompound.obj_exists.md#compolyx.CADCompound.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 | +| [`CADCompound.serialize_name_and_id`](compolyx.CADCompound.serialize_name_and_id.md#compolyx.CADCompound.serialize_name_and_id)() | Helper function to serialize name and ID | +| [`CADCompound.update`](compolyx.CADCompound.update.md#compolyx.CADCompound.update)() | Update the CadComponent | +| [`CADCompound.visit`](compolyx.CADCompound.visit.md#compolyx.CADCompound.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.obj_exists.md index 8b18e43fef..41e7b226fb 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.obj_exists.md @@ -4,5 +4,5 @@ #### CADCompound.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.visit.md index e30353e7ed..4fcef9f1c4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADCompound.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.active.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.active.md index 89f1bd9643..5f0a2d4d48 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.active.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.active.md @@ -4,4 +4,4 @@ #### *property* CADFace.active -active status of object +Active status of object diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.enabled.md index fa152a297b..9f0f63d3a5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.enabled.md @@ -4,4 +4,4 @@ #### *property* CADFace.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.is_dict_item.md index 1488dec0d4..002aacb9b2 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* CADFace.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.is_list_item.md index 36292834b7..38c008eed8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.is_list_item.md @@ -4,4 +4,4 @@ #### *property* CADFace.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.md index 628c294469..133a23e9e5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.md @@ -10,31 +10,31 @@ ComPoLyX Class to represent CADFace. | Name | Description | |------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`CADFace.active`](compolyx.CADFace.active.md#compolyx.CADFace.active) | active status of object | -| [`CADFace.enabled`](compolyx.CADFace.enabled.md#compolyx.CADFace.enabled) | Whether this object is currently enabled or not. | +| [`CADFace.active`](compolyx.CADFace.active.md#compolyx.CADFace.active) | Active status of object | +| [`CADFace.enabled`](compolyx.CADFace.enabled.md#compolyx.CADFace.enabled) | Whether this object is currently enabled or not | | [`CADFace.id`](compolyx.CADFace.id.md#compolyx.CADFace.id) | ID of object | -| [`CADFace.is_dict_item`](compolyx.CADFace.is_dict_item.md#compolyx.CADFace.is_dict_item) | Specifies wether the object is an item of a dict | -| [`CADFace.is_free`](compolyx.CADFace.is_free.md#compolyx.CADFace.is_free) | Boolean whether the shape is free or not. | -| [`CADFace.is_list_item`](compolyx.CADFace.is_list_item.md#compolyx.CADFace.is_list_item) | Specifies wether the object is an item of a list | +| [`CADFace.is_dict_item`](compolyx.CADFace.is_dict_item.md#compolyx.CADFace.is_dict_item) | Specifies whether the object is an item of a dict | +| [`CADFace.is_free`](compolyx.CADFace.is_free.md#compolyx.CADFace.is_free) | Boolean whether the shape is free or not | +| [`CADFace.is_list_item`](compolyx.CADFace.is_list_item.md#compolyx.CADFace.is_list_item) | Specifies whether the object is an item of a list | | [`CADFace.link_path`](compolyx.CADFace.link_path.md#compolyx.CADFace.link_path) | Root path of the current node in the tree for links to this object | -| [`CADFace.locked`](compolyx.CADFace.locked.md#compolyx.CADFace.locked) | Locked status of the CAD Component | +| [`CADFace.locked`](compolyx.CADFace.locked.md#compolyx.CADFace.locked) | Locked status of the CAD component | | [`CADFace.map_index`](compolyx.CADFace.map_index.md#compolyx.CADFace.map_index) | Map index of the shape | | [`CADFace.name`](compolyx.CADFace.name.md#compolyx.CADFace.name) | Name of object | | [`CADFace.parent`](compolyx.CADFace.parent.md#compolyx.CADFace.parent) | Parent object in tree | -| [`CADFace.path`](compolyx.CADFace.path.md#compolyx.CADFace.path) | Returns topology path of the CADComponent. | +| [`CADFace.path`](compolyx.CADFace.path.md#compolyx.CADFace.path) | Returns topology path of the CADComponent | | [`CADFace.root_path`](compolyx.CADFace.root_path.md#compolyx.CADFace.root_path) | Root path of the current node in the tree | | [`CADFace.status`](compolyx.CADFace.status.md#compolyx.CADFace.status) | Status of the object | -| [`CADFace.status_changed`](compolyx.CADFace.status_changed.md#compolyx.CADFace.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`CADFace.status_changed`](compolyx.CADFace.status_changed.md#compolyx.CADFace.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`CADFace.uid`](compolyx.CADFace.uid.md#compolyx.CADFace.uid) | UID of object | -| [`CADFace.vertex`](compolyx.CADFace.vertex.md#compolyx.CADFace.vertex) | This will throw an error if the object has been removed from the graph. | +| [`CADFace.vertex`](compolyx.CADFace.vertex.md#compolyx.CADFace.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`CADFace.find_parent`](compolyx.CADFace.find_parent.md#compolyx.CADFace.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`CADFace.find_parent`](compolyx.CADFace.find_parent.md#compolyx.CADFace.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`CADFace.get_short_description`](compolyx.CADFace.get_short_description.md#compolyx.CADFace.get_short_description)() | | -| [`CADFace.obj_exists`](compolyx.CADFace.obj_exists.md#compolyx.CADFace.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. | -| [`CADFace.serialize_name_and_id`](compolyx.CADFace.serialize_name_and_id.md#compolyx.CADFace.serialize_name_and_id)() | Helper function to serialize name and ID. | -| [`CADFace.update`](compolyx.CADFace.update.md#compolyx.CADFace.update)() | Update the CadComponent. | -| [`CADFace.visit`](compolyx.CADFace.visit.md#compolyx.CADFace.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`CADFace.obj_exists`](compolyx.CADFace.obj_exists.md#compolyx.CADFace.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. | +| [`CADFace.serialize_name_and_id`](compolyx.CADFace.serialize_name_and_id.md#compolyx.CADFace.serialize_name_and_id)() | Helper function to serialize name and ID | +| [`CADFace.update`](compolyx.CADFace.update.md#compolyx.CADFace.update)() | Update the CadComponent | +| [`CADFace.visit`](compolyx.CADFace.visit.md#compolyx.CADFace.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.obj_exists.md index dfaa27c0ad..465b6a1696 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.obj_exists.md @@ -4,5 +4,5 @@ #### CADFace.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.visit.md index 338f51582b..93b753244f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADFace.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.active.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.active.md index 4f5456c10f..9f436ad0cb 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.active.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.active.md @@ -4,4 +4,4 @@ #### *property* CADGeometry.active -active status of object +Active status of object diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.changed.md index 45cc43b4b7..3e44d1f90e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.changed.md @@ -4,4 +4,4 @@ #### *property* CADGeometry.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.enabled.md index ddeb602c0d..7364054723 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.enabled.md @@ -4,4 +4,4 @@ #### *property* CADGeometry.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.is_dict_item.md index 9dcf2f3f3a..ea270246af 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* CADGeometry.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.is_list_item.md index ee7371e7eb..9164e8ea35 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.is_list_item.md @@ -4,4 +4,4 @@ #### *property* CADGeometry.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.md index e89e6a9ba9..90b52ca9a2 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.md @@ -8,41 +8,41 @@ | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| -| [`CADGeometry.active`](compolyx.CADGeometry.active.md#compolyx.CADGeometry.active) | active status of object | -| [`CADGeometry.cad_compounds`](compolyx.CADGeometry.cad_compounds.md#compolyx.CADGeometry.cad_compounds) | Dictionary with all compounds in the CAD Geometry. | -| [`CADGeometry.cad_faces`](compolyx.CADGeometry.cad_faces.md#compolyx.CADGeometry.cad_faces) | Dictionary with all face shapes. | -| [`CADGeometry.cad_solids`](compolyx.CADGeometry.cad_solids.md#compolyx.CADGeometry.cad_solids) | Dictionary with all solid shapes. | -| [`CADGeometry.cad_surfaces`](compolyx.CADGeometry.cad_surfaces.md#compolyx.CADGeometry.cad_surfaces) | Dictionary with all shell shapes. | -| [`CADGeometry.changed`](compolyx.CADGeometry.changed.md#compolyx.CADGeometry.changed) | Status boolean. | +| [`CADGeometry.active`](compolyx.CADGeometry.active.md#compolyx.CADGeometry.active) | Active status of object | +| [`CADGeometry.cad_compounds`](compolyx.CADGeometry.cad_compounds.md#compolyx.CADGeometry.cad_compounds) | Dictionary with all compounds in the CAD geometry | +| [`CADGeometry.cad_faces`](compolyx.CADGeometry.cad_faces.md#compolyx.CADGeometry.cad_faces) | Dictionary with all face shapes | +| [`CADGeometry.cad_solids`](compolyx.CADGeometry.cad_solids.md#compolyx.CADGeometry.cad_solids) | Dictionary with all solid shapes | +| [`CADGeometry.cad_surfaces`](compolyx.CADGeometry.cad_surfaces.md#compolyx.CADGeometry.cad_surfaces) | Dictionary with all shell shapes | +| [`CADGeometry.changed`](compolyx.CADGeometry.changed.md#compolyx.CADGeometry.changed) | Status boolean | | [`CADGeometry.display_data`](compolyx.CADGeometry.display_data.md#compolyx.CADGeometry.display_data) | CAD geometry mesh surface plot | | [`CADGeometry.element_to_face_map`](compolyx.CADGeometry.element_to_face_map.md#compolyx.CADGeometry.element_to_face_map) | | -| [`CADGeometry.enabled`](compolyx.CADGeometry.enabled.md#compolyx.CADGeometry.enabled) | Whether this object is currently enabled or not. | -| [`CADGeometry.ext_id`](compolyx.CADGeometry.ext_id.md#compolyx.CADGeometry.ext_id) | External ID of the CAD Geometry object. | +| [`CADGeometry.enabled`](compolyx.CADGeometry.enabled.md#compolyx.CADGeometry.enabled) | Whether this object is currently enabled or not | +| [`CADGeometry.ext_id`](compolyx.CADGeometry.ext_id.md#compolyx.CADGeometry.ext_id) | External ID of the CAD Geometry object | | [`CADGeometry.id`](compolyx.CADGeometry.id.md#compolyx.CADGeometry.id) | ID of object | -| [`CADGeometry.is_dict_item`](compolyx.CADGeometry.is_dict_item.md#compolyx.CADGeometry.is_dict_item) | Specifies wether the object is an item of a dict | -| [`CADGeometry.is_list_item`](compolyx.CADGeometry.is_list_item.md#compolyx.CADGeometry.is_list_item) | Specifies wether the object is an item of a list | +| [`CADGeometry.is_dict_item`](compolyx.CADGeometry.is_dict_item.md#compolyx.CADGeometry.is_dict_item) | Specifies whether the object is an item of a dict | +| [`CADGeometry.is_list_item`](compolyx.CADGeometry.is_list_item.md#compolyx.CADGeometry.is_list_item) | Specifies whether the object is an item of a list | | [`CADGeometry.link_path`](compolyx.CADGeometry.link_path.md#compolyx.CADGeometry.link_path) | Root path of the current node in the tree for links to this object | -| [`CADGeometry.locked`](compolyx.CADGeometry.locked.md#compolyx.CADGeometry.locked) | CAD geometry is generated from an imported geometry and cannot be changed. | +| [`CADGeometry.locked`](compolyx.CADGeometry.locked.md#compolyx.CADGeometry.locked) | CAD geometry is generated from an imported geometry and cannot be changed | | [`CADGeometry.name`](compolyx.CADGeometry.name.md#compolyx.CADGeometry.name) | Name of object | | [`CADGeometry.normals_display_data`](compolyx.CADGeometry.normals_display_data.md#compolyx.CADGeometry.normals_display_data) | CAD geometry normals visualization | -| [`CADGeometry.offset`](compolyx.CADGeometry.offset.md#compolyx.CADGeometry.offset) | Offset value used to analyze the surface's coverage regarding the mesh. | +| [`CADGeometry.offset`](compolyx.CADGeometry.offset.md#compolyx.CADGeometry.offset) | Offset value used to analyze the surface's coverage regarding the mesh | | [`CADGeometry.parent`](compolyx.CADGeometry.parent.md#compolyx.CADGeometry.parent) | Parent object in tree | -| [`CADGeometry.path`](compolyx.CADGeometry.path.md#compolyx.CADGeometry.path) | The file path where the CAD geometry is loaded from. | -| [`CADGeometry.precision`](compolyx.CADGeometry.precision.md#compolyx.CADGeometry.precision) | Precision of geometrical operations (intersection points, thickness sampling, ...). | +| [`CADGeometry.path`](compolyx.CADGeometry.path.md#compolyx.CADGeometry.path) | The file path where the CAD geometry is loaded from | +| [`CADGeometry.precision`](compolyx.CADGeometry.precision.md#compolyx.CADGeometry.precision) | Precision of geometrical operations (intersection points, thickness sampling, etc.) | | [`CADGeometry.root_path`](compolyx.CADGeometry.root_path.md#compolyx.CADGeometry.root_path) | Root path of the current node in the tree | -| [`CADGeometry.root_shapes`](compolyx.CADGeometry.root_shapes.md#compolyx.CADGeometry.root_shapes) | Dictonary with all free shapes of the CAD Geometry | -| [`CADGeometry.scale_factor`](compolyx.CADGeometry.scale_factor.md#compolyx.CADGeometry.scale_factor) | Geometry is scaled with this factor. | -| [`CADGeometry.shape_type`](compolyx.CADGeometry.shape_type.md#compolyx.CADGeometry.shape_type) | Topological type of the shape. | -| [`CADGeometry.show_normals`](compolyx.CADGeometry.show_normals.md#compolyx.CADGeometry.show_normals) | Visibility of Face Normals. | +| [`CADGeometry.root_shapes`](compolyx.CADGeometry.root_shapes.md#compolyx.CADGeometry.root_shapes) | Dictonary with all free shapes of the CAD geometry | +| [`CADGeometry.scale_factor`](compolyx.CADGeometry.scale_factor.md#compolyx.CADGeometry.scale_factor) | Geometry is scaled with this factor | +| [`CADGeometry.shape_type`](compolyx.CADGeometry.shape_type.md#compolyx.CADGeometry.shape_type) | Topological type of the shape | +| [`CADGeometry.show_normals`](compolyx.CADGeometry.show_normals.md#compolyx.CADGeometry.show_normals) | Visibility of face normals | | [`CADGeometry.status`](compolyx.CADGeometry.status.md#compolyx.CADGeometry.status) | Status of the object | -| [`CADGeometry.status_changed`](compolyx.CADGeometry.status_changed.md#compolyx.CADGeometry.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`CADGeometry.status_changed`](compolyx.CADGeometry.status_changed.md#compolyx.CADGeometry.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`CADGeometry.sub_shape_selection_display_data`](compolyx.CADGeometry.sub_shape_selection_display_data.md#compolyx.CADGeometry.sub_shape_selection_display_data) | CAD face selection plot | -| [`CADGeometry.sub_shapes`](compolyx.CADGeometry.sub_shapes.md#compolyx.CADGeometry.sub_shapes) | Sub faces of the CAD Geometry. | +| [`CADGeometry.sub_shapes`](compolyx.CADGeometry.sub_shapes.md#compolyx.CADGeometry.sub_shapes) | Sub faces of the CAD geometry | | [`CADGeometry.uid`](compolyx.CADGeometry.uid.md#compolyx.CADGeometry.uid) | UID of object | -| [`CADGeometry.use_default_offset`](compolyx.CADGeometry.use_default_offset.md#compolyx.CADGeometry.use_default_offset) | Whether to use the default value or not. | -| [`CADGeometry.use_default_precision`](compolyx.CADGeometry.use_default_precision.md#compolyx.CADGeometry.use_default_precision) | Whether to use default precision value or not. | -| [`CADGeometry.vertex`](compolyx.CADGeometry.vertex.md#compolyx.CADGeometry.vertex) | This will throw an error if the object has been removed from the graph. | -| [`CADGeometry.visible_sub_shapes`](compolyx.CADGeometry.visible_sub_shapes.md#compolyx.CADGeometry.visible_sub_shapes) | Ids of CAD sub shapes to be displayed, stored per-scene id | +| [`CADGeometry.use_default_offset`](compolyx.CADGeometry.use_default_offset.md#compolyx.CADGeometry.use_default_offset) | Whether to use the default value or not | +| [`CADGeometry.use_default_precision`](compolyx.CADGeometry.use_default_precision.md#compolyx.CADGeometry.use_default_precision) | Whether to use default precision value or not | +| [`CADGeometry.vertex`](compolyx.CADGeometry.vertex.md#compolyx.CADGeometry.vertex) | This will throw an error if the object has been removed from the graph | +| [`CADGeometry.visible_sub_shapes`](compolyx.CADGeometry.visible_sub_shapes.md#compolyx.CADGeometry.visible_sub_shapes) | Ids of CAD sub shapes to be displayed, stored per-scene ID | | [`CADGeometry.visualization_mesh`](compolyx.CADGeometry.visualization_mesh.md#compolyx.CADGeometry.visualization_mesh) | Visualization mesh of this geometry | ### Methods @@ -52,17 +52,17 @@ | [`CADGeometry.add_visible_sub_shapes`](compolyx.CADGeometry.add_visible_sub_shapes.md#compolyx.CADGeometry.add_visible_sub_shapes)(...) | | | [`CADGeometry.added_to_active_set`](compolyx.CADGeometry.added_to_active_set.md#compolyx.CADGeometry.added_to_active_set)(scene) | | | [`CADGeometry.clear_visible_sub_shapes`](compolyx.CADGeometry.clear_visible_sub_shapes.md#compolyx.CADGeometry.clear_visible_sub_shapes)(scene) | | -| [`CADGeometry.find_parent`](compolyx.CADGeometry.find_parent.md#compolyx.CADGeometry.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`CADGeometry.find_parent`](compolyx.CADGeometry.find_parent.md#compolyx.CADGeometry.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`CADGeometry.get_face_ids_from_sub_shapes`](compolyx.CADGeometry.get_face_ids_from_sub_shapes.md#compolyx.CADGeometry.get_face_ids_from_sub_shapes)(...) | | | [`CADGeometry.get_faces_from_sub_shapes`](compolyx.CADGeometry.get_faces_from_sub_shapes.md#compolyx.CADGeometry.get_faces_from_sub_shapes)(sub_shapes) | | | [`CADGeometry.get_short_description`](compolyx.CADGeometry.get_short_description.md#compolyx.CADGeometry.get_short_description)() | | -| [`CADGeometry.obj_exists`](compolyx.CADGeometry.obj_exists.md#compolyx.CADGeometry.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. | -| [`CADGeometry.refresh_external_source`](compolyx.CADGeometry.refresh_external_source.md#compolyx.CADGeometry.refresh_external_source)([enforce]) | Reload the geometry from the external source. | +| [`CADGeometry.obj_exists`](compolyx.CADGeometry.obj_exists.md#compolyx.CADGeometry.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 | +| [`CADGeometry.refresh_external_source`](compolyx.CADGeometry.refresh_external_source.md#compolyx.CADGeometry.refresh_external_source)([enforce]) | Reload the geometry from the external source | | [`CADGeometry.remove_visible_sub_shapes`](compolyx.CADGeometry.remove_visible_sub_shapes.md#compolyx.CADGeometry.remove_visible_sub_shapes)(...) | | | [`CADGeometry.removed_from_active_set`](compolyx.CADGeometry.removed_from_active_set.md#compolyx.CADGeometry.removed_from_active_set)(scene) | | -| [`CADGeometry.save_as`](compolyx.CADGeometry.save_as.md#compolyx.CADGeometry.save_as)(path) | Save the initial geometry file to the specified path. | +| [`CADGeometry.save_as`](compolyx.CADGeometry.save_as.md#compolyx.CADGeometry.save_as)(path) | Save the initial geometry file to the specified path | | [`CADGeometry.serialize`](compolyx.CADGeometry.serialize.md#compolyx.CADGeometry.serialize)() | | -| [`CADGeometry.serialize_name_and_id`](compolyx.CADGeometry.serialize_name_and_id.md#compolyx.CADGeometry.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`CADGeometry.serialize_name_and_id`](compolyx.CADGeometry.serialize_name_and_id.md#compolyx.CADGeometry.serialize_name_and_id)() | Helper function to serialize name and ID | | [`CADGeometry.update`](compolyx.CADGeometry.update.md#compolyx.CADGeometry.update)() | | -| [`CADGeometry.visit`](compolyx.CADGeometry.visit.md#compolyx.CADGeometry.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`CADGeometry.visit`](compolyx.CADGeometry.visit.md#compolyx.CADGeometry.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | | [`CADGeometry.visualization_normals`](compolyx.CADGeometry.visualization_normals.md#compolyx.CADGeometry.visualization_normals)(faces) | | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.obj_exists.md index 48a7cc0315..e38390d92c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.obj_exists.md @@ -4,5 +4,5 @@ #### CADGeometry.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.precision.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.precision.md index c8cc882243..0ef1187cf0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.precision.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.precision.md @@ -4,4 +4,4 @@ #### *property* CADGeometry.precision -Precision of geometrical operations (intersection points, thickness sampling, …). +Precision of geometrical operations (intersection points, thickness sampling, etc.). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.visible_sub_shapes.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.visible_sub_shapes.md index 09af6f8faa..70930f43ae 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.visible_sub_shapes.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.visible_sub_shapes.md @@ -4,4 +4,4 @@ #### *property* CADGeometry.visible_sub_shapes -Ids of CAD sub shapes to be displayed, stored per-scene id +IDs of CAD sub shapes to be displayed, stored per-scene ID diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.visit.md index 9ea9a70ae0..d4d28388fc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADGeometry.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.active.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.active.md index 2a52ae81b8..ba45a87683 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.active.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.active.md @@ -4,4 +4,4 @@ #### *property* CADReference.active -active status of object +Active status of object diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.dimension.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.dimension.md index 949f582d44..9167e51593 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.dimension.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.dimension.md @@ -4,4 +4,4 @@ #### *property* CADReference.dimension -Dimension of the linked shape (1 for lines, 2 for surfaces and 3 for solids). +Dimension of the linked shape (1 for lines, 2 for surfaces, and 3 for solids). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.enabled.md index 4f0219ee4a..cad35c6324 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.enabled.md @@ -4,4 +4,4 @@ #### *property* CADReference.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.is_dict_item.md index bd037165dd..afb69b0299 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* CADReference.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.is_list_item.md index 79b4bedb97..f0bd29cd19 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.is_list_item.md @@ -4,4 +4,4 @@ #### *property* CADReference.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.md index dd28574fbf..29d48dbb26 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.md @@ -10,34 +10,34 @@ ComPoLyX Class to represent CAD Reference. | Name | Description | |---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`CADReference.active`](compolyx.CADReference.active.md#compolyx.CADReference.active) | active status of object | -| [`CADReference.bounding_box_max`](compolyx.CADReference.bounding_box_max.md#compolyx.CADReference.bounding_box_max) | Maximum of the bounding box. | -| [`CADReference.bounding_box_min`](compolyx.CADReference.bounding_box_min.md#compolyx.CADReference.bounding_box_min) | Minimum of the bounding box. | +| [`CADReference.active`](compolyx.CADReference.active.md#compolyx.CADReference.active) | Active status of object | +| [`CADReference.bounding_box_max`](compolyx.CADReference.bounding_box_max.md#compolyx.CADReference.bounding_box_max) | Maximum of the bounding box | +| [`CADReference.bounding_box_min`](compolyx.CADReference.bounding_box_min.md#compolyx.CADReference.bounding_box_min) | Minimum of the bounding box | | [`CADReference.cog`](compolyx.CADReference.cog.md#compolyx.CADReference.cog) | Center of gravity of the linked shape | -| [`CADReference.dimension`](compolyx.CADReference.dimension.md#compolyx.CADReference.dimension) | Dimension of the linked shape (1 for lines, 2 for surfaces and 3 for solids). | -| [`CADReference.enabled`](compolyx.CADReference.enabled.md#compolyx.CADReference.enabled) | Whether this object is currently enabled or not. | +| [`CADReference.dimension`](compolyx.CADReference.dimension.md#compolyx.CADReference.dimension) | Dimension of the linked shape (1 for lines, 2 for surfaces and 3 for solids) | +| [`CADReference.enabled`](compolyx.CADReference.enabled.md#compolyx.CADReference.enabled) | Whether this object is currently enabled or not | | [`CADReference.id`](compolyx.CADReference.id.md#compolyx.CADReference.id) | ID of object | -| [`CADReference.is_dict_item`](compolyx.CADReference.is_dict_item.md#compolyx.CADReference.is_dict_item) | Specifies wether the object is an item of a dict | -| [`CADReference.is_list_item`](compolyx.CADReference.is_list_item.md#compolyx.CADReference.is_list_item) | Specifies wether the object is an item of a list | +| [`CADReference.is_dict_item`](compolyx.CADReference.is_dict_item.md#compolyx.CADReference.is_dict_item) | Specifies whether the object is an item of a dict | +| [`CADReference.is_list_item`](compolyx.CADReference.is_list_item.md#compolyx.CADReference.is_list_item) | Specifies whether the object is an item of a list | | [`CADReference.link_path`](compolyx.CADReference.link_path.md#compolyx.CADReference.link_path) | Root path of the current node in the tree for links to this object | | [`CADReference.name`](compolyx.CADReference.name.md#compolyx.CADReference.name) | Name of object | | [`CADReference.parent`](compolyx.CADReference.parent.md#compolyx.CADReference.parent) | Parent object in tree | -| [`CADReference.path`](compolyx.CADReference.path.md#compolyx.CADReference.path) | Path to the linked CAD Component. | +| [`CADReference.path`](compolyx.CADReference.path.md#compolyx.CADReference.path) | Path to the linked CAD component | | [`CADReference.root_path`](compolyx.CADReference.root_path.md#compolyx.CADReference.root_path) | Root path of the current node in the tree | | [`CADReference.size`](compolyx.CADReference.size.md#compolyx.CADReference.size) | Size of the linked cad shape | | [`CADReference.status`](compolyx.CADReference.status.md#compolyx.CADReference.status) | Status of the CADReference | -| [`CADReference.status_changed`](compolyx.CADReference.status_changed.md#compolyx.CADReference.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`CADReference.status_changed`](compolyx.CADReference.status_changed.md#compolyx.CADReference.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`CADReference.uid`](compolyx.CADReference.uid.md#compolyx.CADReference.uid) | UID of object | -| [`CADReference.vertex`](compolyx.CADReference.vertex.md#compolyx.CADReference.vertex) | This will throw an error if the object has been removed from the graph. | +| [`CADReference.vertex`](compolyx.CADReference.vertex.md#compolyx.CADReference.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`CADReference.find_parent`](compolyx.CADReference.find_parent.md#compolyx.CADReference.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`CADReference.find_parent`](compolyx.CADReference.find_parent.md#compolyx.CADReference.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`CADReference.get_short_description`](compolyx.CADReference.get_short_description.md#compolyx.CADReference.get_short_description)() | | -| [`CADReference.obj_exists`](compolyx.CADReference.obj_exists.md#compolyx.CADReference.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. | +| [`CADReference.obj_exists`](compolyx.CADReference.obj_exists.md#compolyx.CADReference.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 | | [`CADReference.serialize`](compolyx.CADReference.serialize.md#compolyx.CADReference.serialize)() | | -| [`CADReference.serialize_name_and_id`](compolyx.CADReference.serialize_name_and_id.md#compolyx.CADReference.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`CADReference.serialize_name_and_id`](compolyx.CADReference.serialize_name_and_id.md#compolyx.CADReference.serialize_name_and_id)() | Helper function to serialize name and ID | | [`CADReference.update`](compolyx.CADReference.update.md#compolyx.CADReference.update)() | | -| [`CADReference.visit`](compolyx.CADReference.visit.md#compolyx.CADReference.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`CADReference.visit`](compolyx.CADReference.visit.md#compolyx.CADReference.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.obj_exists.md index f34f4ff4a1..f80b13972c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.obj_exists.md @@ -4,5 +4,5 @@ #### CADReference.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.path.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.path.md index 281405e379..4838c0ebaa 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.path.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.path.md @@ -4,4 +4,4 @@ #### *property* CADReference.path -Path to the linked CAD Component. For instance ‘CADGeometry.1//top_surface’. Note, ‘/’ was used as separator before 2024 R2. +Path to the linked CAD Component. For instance `CADGeometry.1//top_surface`. Note, ‘/’ was used as separator before 2024 R2. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.visit.md index 5e8d01ecac..8c52addfd1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADReference.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.active.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.active.md index ae44b2ef63..444fa3228e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.active.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.active.md @@ -4,4 +4,4 @@ #### *property* CADShell.active -active status of object +Active status of object diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.enabled.md index fffffb8c10..962deb57d6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.enabled.md @@ -4,4 +4,4 @@ #### *property* CADShell.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.is_dict_item.md index 5ea1f322c7..7efc2010c7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* CADShell.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.is_list_item.md index e765c27612..86f512141d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.is_list_item.md @@ -4,4 +4,4 @@ #### *property* CADShell.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.md index 5f080cd247..e1c7da9f5e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.md @@ -10,32 +10,32 @@ ComPoLyX Class to represent CADShell. | Name | Description | |---------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`CADShell.active`](compolyx.CADShell.active.md#compolyx.CADShell.active) | active status of object | -| [`CADShell.enabled`](compolyx.CADShell.enabled.md#compolyx.CADShell.enabled) | Whether this object is currently enabled or not. | +| [`CADShell.active`](compolyx.CADShell.active.md#compolyx.CADShell.active) | Active status of object | +| [`CADShell.enabled`](compolyx.CADShell.enabled.md#compolyx.CADShell.enabled) | Whether this object is currently enabled or not | | [`CADShell.id`](compolyx.CADShell.id.md#compolyx.CADShell.id) | ID of object | -| [`CADShell.is_dict_item`](compolyx.CADShell.is_dict_item.md#compolyx.CADShell.is_dict_item) | Specifies wether the object is an item of a dict | -| [`CADShell.is_free`](compolyx.CADShell.is_free.md#compolyx.CADShell.is_free) | Boolean whether the shape is free or not. | -| [`CADShell.is_list_item`](compolyx.CADShell.is_list_item.md#compolyx.CADShell.is_list_item) | Specifies wether the object is an item of a list | +| [`CADShell.is_dict_item`](compolyx.CADShell.is_dict_item.md#compolyx.CADShell.is_dict_item) | Specifies whether the object is an item of a dict | +| [`CADShell.is_free`](compolyx.CADShell.is_free.md#compolyx.CADShell.is_free) | Boolean whether the shape is free or not | +| [`CADShell.is_list_item`](compolyx.CADShell.is_list_item.md#compolyx.CADShell.is_list_item) | Specifies whether the object is an item of a list | | [`CADShell.link_path`](compolyx.CADShell.link_path.md#compolyx.CADShell.link_path) | Root path of the current node in the tree for links to this object | -| [`CADShell.locked`](compolyx.CADShell.locked.md#compolyx.CADShell.locked) | Locked status of the CAD Component | +| [`CADShell.locked`](compolyx.CADShell.locked.md#compolyx.CADShell.locked) | Locked status of the CAD component | | [`CADShell.map_index`](compolyx.CADShell.map_index.md#compolyx.CADShell.map_index) | Map index of the shape | | [`CADShell.name`](compolyx.CADShell.name.md#compolyx.CADShell.name) | Name of object | | [`CADShell.parent`](compolyx.CADShell.parent.md#compolyx.CADShell.parent) | Parent object in tree | -| [`CADShell.path`](compolyx.CADShell.path.md#compolyx.CADShell.path) | Returns topology path of the CADComponent. | +| [`CADShell.path`](compolyx.CADShell.path.md#compolyx.CADShell.path) | Returns topology path of the CADComponent | | [`CADShell.root_path`](compolyx.CADShell.root_path.md#compolyx.CADShell.root_path) | Root path of the current node in the tree | | [`CADShell.status`](compolyx.CADShell.status.md#compolyx.CADShell.status) | Status of the object | -| [`CADShell.status_changed`](compolyx.CADShell.status_changed.md#compolyx.CADShell.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`CADShell.sub_shapes`](compolyx.CADShell.sub_shapes.md#compolyx.CADShell.sub_shapes) | Sub faces of the CAD Shell. | +| [`CADShell.status_changed`](compolyx.CADShell.status_changed.md#compolyx.CADShell.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`CADShell.sub_shapes`](compolyx.CADShell.sub_shapes.md#compolyx.CADShell.sub_shapes) | Sub faces of the CAD shell | | [`CADShell.uid`](compolyx.CADShell.uid.md#compolyx.CADShell.uid) | UID of object | -| [`CADShell.vertex`](compolyx.CADShell.vertex.md#compolyx.CADShell.vertex) | This will throw an error if the object has been removed from the graph. | +| [`CADShell.vertex`](compolyx.CADShell.vertex.md#compolyx.CADShell.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`CADShell.find_parent`](compolyx.CADShell.find_parent.md#compolyx.CADShell.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`CADShell.find_parent`](compolyx.CADShell.find_parent.md#compolyx.CADShell.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`CADShell.get_short_description`](compolyx.CADShell.get_short_description.md#compolyx.CADShell.get_short_description)() | | -| [`CADShell.obj_exists`](compolyx.CADShell.obj_exists.md#compolyx.CADShell.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. | -| [`CADShell.serialize_name_and_id`](compolyx.CADShell.serialize_name_and_id.md#compolyx.CADShell.serialize_name_and_id)() | Helper function to serialize name and ID. | -| [`CADShell.update`](compolyx.CADShell.update.md#compolyx.CADShell.update)() | Update the CadComponent. | -| [`CADShell.visit`](compolyx.CADShell.visit.md#compolyx.CADShell.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`CADShell.obj_exists`](compolyx.CADShell.obj_exists.md#compolyx.CADShell.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 | +| [`CADShell.serialize_name_and_id`](compolyx.CADShell.serialize_name_and_id.md#compolyx.CADShell.serialize_name_and_id)() | Helper function to serialize name and ID | +| [`CADShell.update`](compolyx.CADShell.update.md#compolyx.CADShell.update)() | Update the CadComponent | +| [`CADShell.visit`](compolyx.CADShell.visit.md#compolyx.CADShell.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.obj_exists.md index c50fe7fbc9..2d9c881b8c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.obj_exists.md @@ -4,5 +4,5 @@ #### CADShell.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.visit.md index 036201a3eb..da7bfe92aa 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADShell.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.active.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.active.md index 0e201aa89e..2c266b9934 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.active.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.active.md @@ -4,4 +4,4 @@ #### *property* CADSolid.active -active status of object +Active status of object diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.enabled.md index 1f01ea3374..f1ab26784a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.enabled.md @@ -4,4 +4,4 @@ #### *property* CADSolid.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.is_dict_item.md index 9f4b6e0f0b..9f213d22cf 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* CADSolid.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.is_list_item.md index bab738c8b4..6a67a78b40 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.is_list_item.md @@ -4,4 +4,4 @@ #### *property* CADSolid.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.md index d90c1cca26..c1ce80e607 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.md @@ -10,32 +10,32 @@ ComPoLyX Class to represent CADSolid. | Name | Description | |---------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`CADSolid.active`](compolyx.CADSolid.active.md#compolyx.CADSolid.active) | active status of object | -| [`CADSolid.enabled`](compolyx.CADSolid.enabled.md#compolyx.CADSolid.enabled) | Whether this object is currently enabled or not. | +| [`CADSolid.active`](compolyx.CADSolid.active.md#compolyx.CADSolid.active) | Active status of object | +| [`CADSolid.enabled`](compolyx.CADSolid.enabled.md#compolyx.CADSolid.enabled) | Whether this object is currently enabled or not | | [`CADSolid.id`](compolyx.CADSolid.id.md#compolyx.CADSolid.id) | ID of object | -| [`CADSolid.is_dict_item`](compolyx.CADSolid.is_dict_item.md#compolyx.CADSolid.is_dict_item) | Specifies wether the object is an item of a dict | -| [`CADSolid.is_free`](compolyx.CADSolid.is_free.md#compolyx.CADSolid.is_free) | Boolean whether the shape is free or not. | -| [`CADSolid.is_list_item`](compolyx.CADSolid.is_list_item.md#compolyx.CADSolid.is_list_item) | Specifies wether the object is an item of a list | +| [`CADSolid.is_dict_item`](compolyx.CADSolid.is_dict_item.md#compolyx.CADSolid.is_dict_item) | Specifies whether the object is an item of a dict | +| [`CADSolid.is_free`](compolyx.CADSolid.is_free.md#compolyx.CADSolid.is_free) | Boolean whether the shape is free or not | +| [`CADSolid.is_list_item`](compolyx.CADSolid.is_list_item.md#compolyx.CADSolid.is_list_item) | Specifies whether the object is an item of a list | | [`CADSolid.link_path`](compolyx.CADSolid.link_path.md#compolyx.CADSolid.link_path) | Root path of the current node in the tree for links to this object | | [`CADSolid.locked`](compolyx.CADSolid.locked.md#compolyx.CADSolid.locked) | Locked status of the CAD Component | | [`CADSolid.map_index`](compolyx.CADSolid.map_index.md#compolyx.CADSolid.map_index) | Map index of the shape | | [`CADSolid.name`](compolyx.CADSolid.name.md#compolyx.CADSolid.name) | Name of object | | [`CADSolid.parent`](compolyx.CADSolid.parent.md#compolyx.CADSolid.parent) | Parent object in tree | -| [`CADSolid.path`](compolyx.CADSolid.path.md#compolyx.CADSolid.path) | Returns topology path of the CADComponent. | +| [`CADSolid.path`](compolyx.CADSolid.path.md#compolyx.CADSolid.path) | Returns topology path of the CADComponent | | [`CADSolid.root_path`](compolyx.CADSolid.root_path.md#compolyx.CADSolid.root_path) | Root path of the current node in the tree | | [`CADSolid.status`](compolyx.CADSolid.status.md#compolyx.CADSolid.status) | Status of the object | -| [`CADSolid.status_changed`](compolyx.CADSolid.status_changed.md#compolyx.CADSolid.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`CADSolid.sub_shapes`](compolyx.CADSolid.sub_shapes.md#compolyx.CADSolid.sub_shapes) | Sub faces of the CAD Solid. | +| [`CADSolid.status_changed`](compolyx.CADSolid.status_changed.md#compolyx.CADSolid.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`CADSolid.sub_shapes`](compolyx.CADSolid.sub_shapes.md#compolyx.CADSolid.sub_shapes) | Sub faces of the CAD Solid | | [`CADSolid.uid`](compolyx.CADSolid.uid.md#compolyx.CADSolid.uid) | UID of object | -| [`CADSolid.vertex`](compolyx.CADSolid.vertex.md#compolyx.CADSolid.vertex) | This will throw an error if the object has been removed from the graph. | +| [`CADSolid.vertex`](compolyx.CADSolid.vertex.md#compolyx.CADSolid.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`CADSolid.find_parent`](compolyx.CADSolid.find_parent.md#compolyx.CADSolid.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`CADSolid.find_parent`](compolyx.CADSolid.find_parent.md#compolyx.CADSolid.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`CADSolid.get_short_description`](compolyx.CADSolid.get_short_description.md#compolyx.CADSolid.get_short_description)() | | -| [`CADSolid.obj_exists`](compolyx.CADSolid.obj_exists.md#compolyx.CADSolid.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. | -| [`CADSolid.serialize_name_and_id`](compolyx.CADSolid.serialize_name_and_id.md#compolyx.CADSolid.serialize_name_and_id)() | Helper function to serialize name and ID. | -| [`CADSolid.update`](compolyx.CADSolid.update.md#compolyx.CADSolid.update)() | Update the CadComponent. | -| [`CADSolid.visit`](compolyx.CADSolid.visit.md#compolyx.CADSolid.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`CADSolid.obj_exists`](compolyx.CADSolid.obj_exists.md#compolyx.CADSolid.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 | +| [`CADSolid.serialize_name_and_id`](compolyx.CADSolid.serialize_name_and_id.md#compolyx.CADSolid.serialize_name_and_id)() | Helper function to serialize name and ID | +| [`CADSolid.update`](compolyx.CADSolid.update.md#compolyx.CADSolid.update)() | Update the CadComponent | +| [`CADSolid.visit`](compolyx.CADSolid.visit.md#compolyx.CADSolid.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.obj_exists.md index 1a45d1aed3..f9bc23230c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.obj_exists.md @@ -4,5 +4,5 @@ #### CADSolid.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.visit.md index b0689abcd8..b5f2c7d7ae 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CADSolid.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.is_dict_item.md index 245915a49e..dc2e88df6c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* Chapter.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.is_list_item.md index 0badffd6b0..32e27fb283 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.is_list_item.md @@ -4,4 +4,4 @@ #### *property* Chapter.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.md index 89162e4f47..1ca51814b6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.md @@ -10,8 +10,8 @@ Class to represent plybook chapter. | Name | Description | |---------------------------------------------------------------------------------------------|--------------------------------------------------------------------| -| [`Chapter.is_dict_item`](compolyx.Chapter.is_dict_item.md#compolyx.Chapter.is_dict_item) | Specifies wether the object is an item of a dict | -| [`Chapter.is_list_item`](compolyx.Chapter.is_list_item.md#compolyx.Chapter.is_list_item) | Specifies wether the object is an item of a list | +| [`Chapter.is_dict_item`](compolyx.Chapter.is_dict_item.md#compolyx.Chapter.is_dict_item) | Specifies whether the object is an item of a dict | +| [`Chapter.is_list_item`](compolyx.Chapter.is_list_item.md#compolyx.Chapter.is_list_item) | Specifies whether the object is an item of a list | | [`Chapter.link_path`](compolyx.Chapter.link_path.md#compolyx.Chapter.link_path) | Root path of the current node in the tree for links to this object | | [`Chapter.name`](compolyx.Chapter.name.md#compolyx.Chapter.name) | Name of object | | [`Chapter.parent`](compolyx.Chapter.parent.md#compolyx.Chapter.parent) | Parent object in tree | @@ -24,9 +24,9 @@ Class to represent plybook chapter. | Name | Description | |-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`Chapter.find_parent`](compolyx.Chapter.find_parent.md#compolyx.Chapter.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`Chapter.generate_reST`](compolyx.Chapter.generate_reST.md#compolyx.Chapter.generate_reST)(reST_chapter_template, ...) | Get the interpolated reST string for the chapter. | -| [`Chapter.get_production_plies`](compolyx.Chapter.get_production_plies.md#compolyx.Chapter.get_production_plies)() | Return a list of production plies which are associated with this chapter. | +| [`Chapter.find_parent`](compolyx.Chapter.find_parent.md#compolyx.Chapter.find_parent)(type) | Steps up the tree and returns the first parent with given type | +| [`Chapter.generate_reST`](compolyx.Chapter.generate_reST.md#compolyx.Chapter.generate_reST)(reST_chapter_template, ...) | Get the interpolated reST string for the chapter | +| [`Chapter.get_production_plies`](compolyx.Chapter.get_production_plies.md#compolyx.Chapter.get_production_plies)() | Return a list of production plies which are associated with this chapter | | [`Chapter.serialize`](compolyx.Chapter.serialize.md#compolyx.Chapter.serialize)() | | | [`Chapter.update`](compolyx.Chapter.update.md#compolyx.Chapter.update)() | | -| [`Chapter.visit`](compolyx.Chapter.visit.md#compolyx.Chapter.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`Chapter.visit`](compolyx.Chapter.visit.md#compolyx.Chapter.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.visit.md index 451b1ee324..849f0b1b48 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Chapter.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.is_dict_item.md index d8cd052ba0..dc72abda5f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* CutOffGeometry.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.is_list_item.md index b315d6f95a..e42e9ef071 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.is_list_item.md @@ -4,4 +4,4 @@ #### *property* CutOffGeometry.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.md index dcc2c8a968..1198fc6fe1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.md @@ -11,30 +11,30 @@ CutOffGeometry guide class | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| | [`CutOffGeometry.active`](compolyx.CutOffGeometry.active.md#compolyx.CutOffGeometry.active) | Cut-Off Geometry active | -| [`CutOffGeometry.cad_geometry`](compolyx.CutOffGeometry.cad_geometry.md#compolyx.CutOffGeometry.cad_geometry) | Associated CADGeometry. | -| [`CutOffGeometry.enabled`](compolyx.CutOffGeometry.enabled.md#compolyx.CutOffGeometry.enabled) | Whether this object is currently enabled or not. | +| [`CutOffGeometry.cad_geometry`](compolyx.CutOffGeometry.cad_geometry.md#compolyx.CutOffGeometry.cad_geometry) | Associated CADGeometry | +| [`CutOffGeometry.enabled`](compolyx.CutOffGeometry.enabled.md#compolyx.CutOffGeometry.enabled) | Whether this object is currently enabled or not | | [`CutOffGeometry.id`](compolyx.CutOffGeometry.id.md#compolyx.CutOffGeometry.id) | ID of object | -| [`CutOffGeometry.is_dict_item`](compolyx.CutOffGeometry.is_dict_item.md#compolyx.CutOffGeometry.is_dict_item) | Specifies wether the object is an item of a dict | -| [`CutOffGeometry.is_list_item`](compolyx.CutOffGeometry.is_list_item.md#compolyx.CutOffGeometry.is_list_item) | Specifies wether the object is an item of a list | +| [`CutOffGeometry.is_dict_item`](compolyx.CutOffGeometry.is_dict_item.md#compolyx.CutOffGeometry.is_dict_item) | Specifies whether the object is an item of a dict | +| [`CutOffGeometry.is_list_item`](compolyx.CutOffGeometry.is_list_item.md#compolyx.CutOffGeometry.is_list_item) | Specifies whether the object is an item of a list | | [`CutOffGeometry.link_path`](compolyx.CutOffGeometry.link_path.md#compolyx.CutOffGeometry.link_path) | Root path of the current node in the tree for links to this object | | [`CutOffGeometry.name`](compolyx.CutOffGeometry.name.md#compolyx.CutOffGeometry.name) | Name of object | -| [`CutOffGeometry.orientation`](compolyx.CutOffGeometry.orientation.md#compolyx.CutOffGeometry.orientation) | Orientation. | +| [`CutOffGeometry.orientation`](compolyx.CutOffGeometry.orientation.md#compolyx.CutOffGeometry.orientation) | Orientation | | [`CutOffGeometry.parent`](compolyx.CutOffGeometry.parent.md#compolyx.CutOffGeometry.parent) | Parent object in tree | | [`CutOffGeometry.rel_merge_tolerance`](compolyx.CutOffGeometry.rel_merge_tolerance.md#compolyx.CutOffGeometry.rel_merge_tolerance) | Relative Merge Tolerance | | [`CutOffGeometry.root_path`](compolyx.CutOffGeometry.root_path.md#compolyx.CutOffGeometry.root_path) | Root path of the current node in the tree | | [`CutOffGeometry.status`](compolyx.CutOffGeometry.status.md#compolyx.CutOffGeometry.status) | Status of the object | | [`CutOffGeometry.status_changed`](compolyx.CutOffGeometry.status_changed.md#compolyx.CutOffGeometry.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | | [`CutOffGeometry.uid`](compolyx.CutOffGeometry.uid.md#compolyx.CutOffGeometry.uid) | UID of object | -| [`CutOffGeometry.vertex`](compolyx.CutOffGeometry.vertex.md#compolyx.CutOffGeometry.vertex) | This will throw an error if the object has been removed from the graph. | +| [`CutOffGeometry.vertex`](compolyx.CutOffGeometry.vertex.md#compolyx.CutOffGeometry.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`CutOffGeometry.find_parent`](compolyx.CutOffGeometry.find_parent.md#compolyx.CutOffGeometry.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`CutOffGeometry.find_parent`](compolyx.CutOffGeometry.find_parent.md#compolyx.CutOffGeometry.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`CutOffGeometry.from_obj`](compolyx.CutOffGeometry.from_obj.md#compolyx.CutOffGeometry.from_obj)(obj, org_obj) | | -| [`CutOffGeometry.obj_exists`](compolyx.CutOffGeometry.obj_exists.md#compolyx.CutOffGeometry.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. | +| [`CutOffGeometry.obj_exists`](compolyx.CutOffGeometry.obj_exists.md#compolyx.CutOffGeometry.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 | | [`CutOffGeometry.serialize`](compolyx.CutOffGeometry.serialize.md#compolyx.CutOffGeometry.serialize)() | | -| [`CutOffGeometry.serialize_name_and_id`](compolyx.CutOffGeometry.serialize_name_and_id.md#compolyx.CutOffGeometry.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`CutOffGeometry.serialize_name_and_id`](compolyx.CutOffGeometry.serialize_name_and_id.md#compolyx.CutOffGeometry.serialize_name_and_id)() | Helper function to serialize name and ID | | [`CutOffGeometry.update`](compolyx.CutOffGeometry.update.md#compolyx.CutOffGeometry.update)() | | -| [`CutOffGeometry.visit`](compolyx.CutOffGeometry.visit.md#compolyx.CutOffGeometry.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`CutOffGeometry.visit`](compolyx.CutOffGeometry.visit.md#compolyx.CutOffGeometry.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.obj_exists.md index 246f77e757..9f2050d772 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.obj_exists.md @@ -4,5 +4,5 @@ #### CutOffGeometry.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.orientation.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.orientation.md index c08acce286..aab22953ce 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.orientation.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.orientation.md @@ -4,4 +4,4 @@ #### *property* CutOffGeometry.orientation -Orientation. Allowed string values: [‘up’, ‘down’] +Orientation. Available string values: [`up`, `down`] diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.visit.md index 85df59c6e6..6dd6c74a18 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutOffGeometry.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.active.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.active.md index 79b4eb15aa..e8ea954e46 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.active.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.active.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.active -active status of object +Active status of object diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.cutoff_rule_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.cutoff_rule_type.md index 6948f2c057..c4817e6d39 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.cutoff_rule_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.cutoff_rule_type.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.cutoff_rule_type -Cutoff rule type, valid values geometry,taper,variable_taper +Cutoff rule type. Available options: `geometry`, `taper`, `variable_taper` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.direction.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.direction.md index 81e8370168..fa37c25f30 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.direction.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.direction.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.direction -Direction of the offset and angle interpolation for ‘variable_taper’ +Direction of the offset and angle interpolation for `variable_taper` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.distance_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.distance_type.md index c22507bb5f..6c41b6daf8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.distance_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.distance_type.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.distance_type -Distance type for offset and angle interpolation for ‘variable_taper’ +Distance type for offset and angle interpolation for `variable_taper` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.edge_set.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.edge_set.md index 98a8b931a6..803d607c4e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.edge_set.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.edge_set.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.edge_set -Edge Set for cutoff_rule_type=\`taper\` or variable_taper +Edge Set for cutoff_rule_type= `taper` or `variable_taper` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.enabled.md index ed0a5a5157..2997c33651 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.enabled.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.extent.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.extent.md index 08bfa5afb2..c02a666a74 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.extent.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.extent.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.extent -extent of the rule +Extent of the rule diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.include_rule_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.include_rule_type.md index 9b3144e6ea..3541a9b33f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.include_rule_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.include_rule_type.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.include_rule_type -include type +Include type diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.is_dict_item.md index f84185b625..3c04a36a55 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.is_list_item.md index 83e154e450..52b30f8154 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.is_list_item.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.md index 0ffe291170..159ad2f9f8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.md @@ -8,45 +8,45 @@ | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| -| [`CutoffSelectionRule.active`](compolyx.CutoffSelectionRule.active.md#compolyx.CutoffSelectionRule.active) | active status of object | +| [`CutoffSelectionRule.active`](compolyx.CutoffSelectionRule.active.md#compolyx.CutoffSelectionRule.active) | Active status of object | | [`CutoffSelectionRule.angle`](compolyx.CutoffSelectionRule.angle.md#compolyx.CutoffSelectionRule.angle) | Cut-Off angle | | [`CutoffSelectionRule.changed`](compolyx.CutoffSelectionRule.changed.md#compolyx.CutoffSelectionRule.changed) | Triggers Observable to dispatch changed message | | [`CutoffSelectionRule.cutoff_geometry`](compolyx.CutoffSelectionRule.cutoff_geometry.md#compolyx.CutoffSelectionRule.cutoff_geometry) | Cut-Off Geometry for the Cut-Off Rule | -| [`CutoffSelectionRule.cutoff_rule_type`](compolyx.CutoffSelectionRule.cutoff_rule_type.md#compolyx.CutoffSelectionRule.cutoff_rule_type) | Cutoff rule type, valid values geometry,taper,variable_taper | +| [`CutoffSelectionRule.cutoff_rule_type`](compolyx.CutoffSelectionRule.cutoff_rule_type.md#compolyx.CutoffSelectionRule.cutoff_rule_type) | Cutoff rule type. Available options: geometry, taper, variable_taper | | [`CutoffSelectionRule.direction`](compolyx.CutoffSelectionRule.direction.md#compolyx.CutoffSelectionRule.direction) | Direction of the offset and angle interpolation for 'variable_taper' | | [`CutoffSelectionRule.distance_type`](compolyx.CutoffSelectionRule.distance_type.md#compolyx.CutoffSelectionRule.distance_type) | Distance type for offset and angle interpolation for 'variable_taper' | | [`CutoffSelectionRule.edge_set`](compolyx.CutoffSelectionRule.edge_set.md#compolyx.CutoffSelectionRule.edge_set) | Edge Set for cutoff_rule_type=\`taper\` or variable_taper | -| [`CutoffSelectionRule.enabled`](compolyx.CutoffSelectionRule.enabled.md#compolyx.CutoffSelectionRule.enabled) | Whether this object is currently enabled or not. | -| [`CutoffSelectionRule.extent`](compolyx.CutoffSelectionRule.extent.md#compolyx.CutoffSelectionRule.extent) | extent of the rule | +| [`CutoffSelectionRule.enabled`](compolyx.CutoffSelectionRule.enabled.md#compolyx.CutoffSelectionRule.enabled) | Whether this object is currently enabled or not | +| [`CutoffSelectionRule.extent`](compolyx.CutoffSelectionRule.extent.md#compolyx.CutoffSelectionRule.extent) | Extent of the rule | | [`CutoffSelectionRule.id`](compolyx.CutoffSelectionRule.id.md#compolyx.CutoffSelectionRule.id) | ID of object | -| [`CutoffSelectionRule.include_rule_type`](compolyx.CutoffSelectionRule.include_rule_type.md#compolyx.CutoffSelectionRule.include_rule_type) | include type | -| [`CutoffSelectionRule.is_dict_item`](compolyx.CutoffSelectionRule.is_dict_item.md#compolyx.CutoffSelectionRule.is_dict_item) | Specifies wether the object is an item of a dict | -| [`CutoffSelectionRule.is_list_item`](compolyx.CutoffSelectionRule.is_list_item.md#compolyx.CutoffSelectionRule.is_list_item) | Specifies wether the object is an item of a list | +| [`CutoffSelectionRule.include_rule_type`](compolyx.CutoffSelectionRule.include_rule_type.md#compolyx.CutoffSelectionRule.include_rule_type) | Include type | +| [`CutoffSelectionRule.is_dict_item`](compolyx.CutoffSelectionRule.is_dict_item.md#compolyx.CutoffSelectionRule.is_dict_item) | Specifies whether the object is an item of a dict | +| [`CutoffSelectionRule.is_list_item`](compolyx.CutoffSelectionRule.is_list_item.md#compolyx.CutoffSelectionRule.is_list_item) | Specifies whether the object is an item of a list | | [`CutoffSelectionRule.link_path`](compolyx.CutoffSelectionRule.link_path.md#compolyx.CutoffSelectionRule.link_path) | Root path of the current node in the tree for links to this object | | [`CutoffSelectionRule.name`](compolyx.CutoffSelectionRule.name.md#compolyx.CutoffSelectionRule.name) | Name of object | | [`CutoffSelectionRule.offset`](compolyx.CutoffSelectionRule.offset.md#compolyx.CutoffSelectionRule.offset) | Cut-Off offset | -| [`CutoffSelectionRule.offset_method`](compolyx.CutoffSelectionRule.offset_method.md#compolyx.CutoffSelectionRule.offset_method) | Method to compute the offset of a ply. | +| [`CutoffSelectionRule.offset_method`](compolyx.CutoffSelectionRule.offset_method.md#compolyx.CutoffSelectionRule.offset_method) | Method to compute the offset of a ply | | [`CutoffSelectionRule.offset_type`](compolyx.CutoffSelectionRule.offset_type.md#compolyx.CutoffSelectionRule.offset_type) | Take offset from edge set perpendicular to element reference surface (out_of_plane) or in element reference surface (in_plane) | | [`CutoffSelectionRule.origin`](compolyx.CutoffSelectionRule.origin.md#compolyx.CutoffSelectionRule.origin) | Origin of the offset and angle interpolation for 'variable_taper' cutoff rules | | [`CutoffSelectionRule.parent`](compolyx.CutoffSelectionRule.parent.md#compolyx.CutoffSelectionRule.parent) | Parent object in tree | -| [`CutoffSelectionRule.ply_cutoff_type`](compolyx.CutoffSelectionRule.ply_cutoff_type.md#compolyx.CutoffSelectionRule.ply_cutoff_type) | Cutoff Types can be: production_ply_cutoff,analysis_ply_cutoff | +| [`CutoffSelectionRule.ply_cutoff_type`](compolyx.CutoffSelectionRule.ply_cutoff_type.md#compolyx.CutoffSelectionRule.ply_cutoff_type) | Cutoff Types. Available options: production_ply_cutoff,analysis_ply_cutoff | | [`CutoffSelectionRule.ply_tapering`](compolyx.CutoffSelectionRule.ply_tapering.md#compolyx.CutoffSelectionRule.ply_tapering) | Use Ply Tapering Orientation | -| [`CutoffSelectionRule.relative_rule_type`](compolyx.CutoffSelectionRule.relative_rule_type.md#compolyx.CutoffSelectionRule.relative_rule_type) | relative type | +| [`CutoffSelectionRule.relative_rule_type`](compolyx.CutoffSelectionRule.relative_rule_type.md#compolyx.CutoffSelectionRule.relative_rule_type) | Relative type | | [`CutoffSelectionRule.root_path`](compolyx.CutoffSelectionRule.root_path.md#compolyx.CutoffSelectionRule.root_path) | Root path of the current node in the tree | | [`CutoffSelectionRule.status`](compolyx.CutoffSelectionRule.status.md#compolyx.CutoffSelectionRule.status) | Status of the object | -| [`CutoffSelectionRule.status_changed`](compolyx.CutoffSelectionRule.status_changed.md#compolyx.CutoffSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`CutoffSelectionRule.status_changed`](compolyx.CutoffSelectionRule.status_changed.md#compolyx.CutoffSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`CutoffSelectionRule.uid`](compolyx.CutoffSelectionRule.uid.md#compolyx.CutoffSelectionRule.uid) | UID of object | -| [`CutoffSelectionRule.vertex`](compolyx.CutoffSelectionRule.vertex.md#compolyx.CutoffSelectionRule.vertex) | This will throw an error if the object has been removed from the graph. | +| [`CutoffSelectionRule.vertex`](compolyx.CutoffSelectionRule.vertex.md#compolyx.CutoffSelectionRule.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`CutoffSelectionRule.find_parent`](compolyx.CutoffSelectionRule.find_parent.md#compolyx.CutoffSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`CutoffSelectionRule.find_parent`](compolyx.CutoffSelectionRule.find_parent.md#compolyx.CutoffSelectionRule.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`CutoffSelectionRule.get_short_description`](compolyx.CutoffSelectionRule.get_short_description.md#compolyx.CutoffSelectionRule.get_short_description)() | | -| [`CutoffSelectionRule.obj_exists`](compolyx.CutoffSelectionRule.obj_exists.md#compolyx.CutoffSelectionRule.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. | +| [`CutoffSelectionRule.obj_exists`](compolyx.CutoffSelectionRule.obj_exists.md#compolyx.CutoffSelectionRule.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 | | [`CutoffSelectionRule.serialize`](compolyx.CutoffSelectionRule.serialize.md#compolyx.CutoffSelectionRule.serialize)() | | -| [`CutoffSelectionRule.serialize_name_and_id`](compolyx.CutoffSelectionRule.serialize_name_and_id.md#compolyx.CutoffSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`CutoffSelectionRule.serialize_name_and_id`](compolyx.CutoffSelectionRule.serialize_name_and_id.md#compolyx.CutoffSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID | | [`CutoffSelectionRule.serialize_rule_types`](compolyx.CutoffSelectionRule.serialize_rule_types.md#compolyx.CutoffSelectionRule.serialize_rule_types)() | | | [`CutoffSelectionRule.update`](compolyx.CutoffSelectionRule.update.md#compolyx.CutoffSelectionRule.update)() | | -| [`CutoffSelectionRule.visit`](compolyx.CutoffSelectionRule.visit.md#compolyx.CutoffSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`CutoffSelectionRule.visit`](compolyx.CutoffSelectionRule.visit.md#compolyx.CutoffSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.obj_exists.md index fb39322e82..e040ba1fe2 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.obj_exists.md @@ -4,5 +4,5 @@ #### CutoffSelectionRule.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.origin.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.origin.md index 65682f6ba9..0f80c8029e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.origin.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.origin.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.origin -Origin of the offset and angle interpolation for ‘variable_taper’ cutoff rules +Origin of the offset and angle interpolation for `variable_taper` cutoff rules diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.ply_cutoff_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.ply_cutoff_type.md index e1d987bda9..c53c13390f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.ply_cutoff_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.ply_cutoff_type.md @@ -4,4 +4,4 @@ #### *property* CutoffSelectionRule.ply_cutoff_type -Cutoff Types can be: production_ply_cutoff,analysis_ply_cutoff +Cutoff Types. Available options: `production_ply_cutoff`, `analysis_ply_cutoff` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.visit.md index d2ed81e177..e050544301 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CutoffSelectionRule.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.active.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.active.md index 8b9b3425ad..30bc8fd0f9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.active.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.active.md @@ -4,4 +4,4 @@ #### *property* CylindricalSelectionRule.active -active status of object +Active status of object diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.enabled.md index 80901125e7..278c609a2b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.enabled.md @@ -4,4 +4,4 @@ #### *property* CylindricalSelectionRule.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.is_dict_item.md index b9bfaea580..0f0d502a24 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* CylindricalSelectionRule.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.is_list_item.md index 6dd1e5d7ee..bb7d95715d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.is_list_item.md @@ -4,4 +4,4 @@ #### *property* CylindricalSelectionRule.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.md index 3db76c3930..36bf5ebed9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.md @@ -10,41 +10,41 @@ Cylindrical selection rule. | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`CylindricalSelectionRule.active`](compolyx.CylindricalSelectionRule.active.md#compolyx.CylindricalSelectionRule.active) | active status of object | +| [`CylindricalSelectionRule.active`](compolyx.CylindricalSelectionRule.active.md#compolyx.CylindricalSelectionRule.active) | Active status of object | | [`CylindricalSelectionRule.changed`](compolyx.CylindricalSelectionRule.changed.md#compolyx.CylindricalSelectionRule.changed) | Triggers Observable to dispatch changed message | -| [`CylindricalSelectionRule.direction`](compolyx.CylindricalSelectionRule.direction.md#compolyx.CylindricalSelectionRule.direction) | Direction of the Cylinder. | +| [`CylindricalSelectionRule.direction`](compolyx.CylindricalSelectionRule.direction.md#compolyx.CylindricalSelectionRule.direction) | Direction of the cylinder | | [`CylindricalSelectionRule.direction_in_global_coordinates`](compolyx.CylindricalSelectionRule.direction_in_global_coordinates.md#compolyx.CylindricalSelectionRule.direction_in_global_coordinates) | Direction of the rule in global coordinates | -| [`CylindricalSelectionRule.enabled`](compolyx.CylindricalSelectionRule.enabled.md#compolyx.CylindricalSelectionRule.enabled) | Whether this object is currently enabled or not. | -| [`CylindricalSelectionRule.extent`](compolyx.CylindricalSelectionRule.extent.md#compolyx.CylindricalSelectionRule.extent) | extent of the rule | +| [`CylindricalSelectionRule.enabled`](compolyx.CylindricalSelectionRule.enabled.md#compolyx.CylindricalSelectionRule.enabled) | Whether this object is currently enabled or not | +| [`CylindricalSelectionRule.extent`](compolyx.CylindricalSelectionRule.extent.md#compolyx.CylindricalSelectionRule.extent) | Extent of the rule | | [`CylindricalSelectionRule.id`](compolyx.CylindricalSelectionRule.id.md#compolyx.CylindricalSelectionRule.id) | ID of object | -| [`CylindricalSelectionRule.include_rule_type`](compolyx.CylindricalSelectionRule.include_rule_type.md#compolyx.CylindricalSelectionRule.include_rule_type) | include type | -| [`CylindricalSelectionRule.is_dict_item`](compolyx.CylindricalSelectionRule.is_dict_item.md#compolyx.CylindricalSelectionRule.is_dict_item) | Specifies wether the object is an item of a dict | -| [`CylindricalSelectionRule.is_list_item`](compolyx.CylindricalSelectionRule.is_list_item.md#compolyx.CylindricalSelectionRule.is_list_item) | Specifies wether the object is an item of a list | +| [`CylindricalSelectionRule.include_rule_type`](compolyx.CylindricalSelectionRule.include_rule_type.md#compolyx.CylindricalSelectionRule.include_rule_type) | Include type | +| [`CylindricalSelectionRule.is_dict_item`](compolyx.CylindricalSelectionRule.is_dict_item.md#compolyx.CylindricalSelectionRule.is_dict_item) | Specifies whether the object is an item of a dict | +| [`CylindricalSelectionRule.is_list_item`](compolyx.CylindricalSelectionRule.is_list_item.md#compolyx.CylindricalSelectionRule.is_list_item) | Specifies whether the object is an item of a list | | [`CylindricalSelectionRule.link_path`](compolyx.CylindricalSelectionRule.link_path.md#compolyx.CylindricalSelectionRule.link_path) | Root path of the current node in the tree for links to this object | | [`CylindricalSelectionRule.mesh`](compolyx.CylindricalSelectionRule.mesh.md#compolyx.CylindricalSelectionRule.mesh) | | | [`CylindricalSelectionRule.name`](compolyx.CylindricalSelectionRule.name.md#compolyx.CylindricalSelectionRule.name) | Name of object | -| [`CylindricalSelectionRule.origin`](compolyx.CylindricalSelectionRule.origin.md#compolyx.CylindricalSelectionRule.origin) | Origin of the Cylinder. | +| [`CylindricalSelectionRule.origin`](compolyx.CylindricalSelectionRule.origin.md#compolyx.CylindricalSelectionRule.origin) | Origin of the Cylinder | | [`CylindricalSelectionRule.origin_in_global_coordinates`](compolyx.CylindricalSelectionRule.origin_in_global_coordinates.md#compolyx.CylindricalSelectionRule.origin_in_global_coordinates) | Origin of the rule in global coordinates | | [`CylindricalSelectionRule.parent`](compolyx.CylindricalSelectionRule.parent.md#compolyx.CylindricalSelectionRule.parent) | Parent object in tree | | [`CylindricalSelectionRule.radius`](compolyx.CylindricalSelectionRule.radius.md#compolyx.CylindricalSelectionRule.radius) | Radius of the Cylinder | -| [`CylindricalSelectionRule.relative_rule_type`](compolyx.CylindricalSelectionRule.relative_rule_type.md#compolyx.CylindricalSelectionRule.relative_rule_type) | relative type | +| [`CylindricalSelectionRule.relative_rule_type`](compolyx.CylindricalSelectionRule.relative_rule_type.md#compolyx.CylindricalSelectionRule.relative_rule_type) | Relative type | | [`CylindricalSelectionRule.root_path`](compolyx.CylindricalSelectionRule.root_path.md#compolyx.CylindricalSelectionRule.root_path) | Root path of the current node in the tree | | [`CylindricalSelectionRule.rosette`](compolyx.CylindricalSelectionRule.rosette.md#compolyx.CylindricalSelectionRule.rosette) | Rosette of the used for origin and direction | | [`CylindricalSelectionRule.status`](compolyx.CylindricalSelectionRule.status.md#compolyx.CylindricalSelectionRule.status) | Status of the object | -| [`CylindricalSelectionRule.status_changed`](compolyx.CylindricalSelectionRule.status_changed.md#compolyx.CylindricalSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`CylindricalSelectionRule.status_changed`](compolyx.CylindricalSelectionRule.status_changed.md#compolyx.CylindricalSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`CylindricalSelectionRule.uid`](compolyx.CylindricalSelectionRule.uid.md#compolyx.CylindricalSelectionRule.uid) | UID of object | | [`CylindricalSelectionRule.use_global_coordinate_system`](compolyx.CylindricalSelectionRule.use_global_coordinate_system.md#compolyx.CylindricalSelectionRule.use_global_coordinate_system) | Use global coordinate system for origin and direction | -| [`CylindricalSelectionRule.vertex`](compolyx.CylindricalSelectionRule.vertex.md#compolyx.CylindricalSelectionRule.vertex) | This will throw an error if the object has been removed from the graph. | +| [`CylindricalSelectionRule.vertex`](compolyx.CylindricalSelectionRule.vertex.md#compolyx.CylindricalSelectionRule.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`CylindricalSelectionRule.find_parent`](compolyx.CylindricalSelectionRule.find_parent.md#compolyx.CylindricalSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`CylindricalSelectionRule.find_parent`](compolyx.CylindricalSelectionRule.find_parent.md#compolyx.CylindricalSelectionRule.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`CylindricalSelectionRule.get_short_description`](compolyx.CylindricalSelectionRule.get_short_description.md#compolyx.CylindricalSelectionRule.get_short_description)() | | -| [`CylindricalSelectionRule.obj_exists`](compolyx.CylindricalSelectionRule.obj_exists.md#compolyx.CylindricalSelectionRule.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. | -| [`CylindricalSelectionRule.serialize`](compolyx.CylindricalSelectionRule.serialize.md#compolyx.CylindricalSelectionRule.serialize)() | Serialize to Python string. | -| [`CylindricalSelectionRule.serialize_name_and_id`](compolyx.CylindricalSelectionRule.serialize_name_and_id.md#compolyx.CylindricalSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`CylindricalSelectionRule.obj_exists`](compolyx.CylindricalSelectionRule.obj_exists.md#compolyx.CylindricalSelectionRule.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 +| [`CylindricalSelectionRule.serialize`](compolyx.CylindricalSelectionRule.serialize.md#compolyx.CylindricalSelectionRule.serialize)() | Serialize to Python string | +| [`CylindricalSelectionRule.serialize_name_and_id`](compolyx.CylindricalSelectionRule.serialize_name_and_id.md#compolyx.CylindricalSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID | | [`CylindricalSelectionRule.serialize_rule_types`](compolyx.CylindricalSelectionRule.serialize_rule_types.md#compolyx.CylindricalSelectionRule.serialize_rule_types)() | | | [`CylindricalSelectionRule.update`](compolyx.CylindricalSelectionRule.update.md#compolyx.CylindricalSelectionRule.update)() | | -| [`CylindricalSelectionRule.visit`](compolyx.CylindricalSelectionRule.visit.md#compolyx.CylindricalSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`CylindricalSelectionRule.visit`](compolyx.CylindricalSelectionRule.visit.md#compolyx.CylindricalSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.obj_exists.md index 5eb776de1f..e248ce64f0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.obj_exists.md @@ -4,5 +4,5 @@ #### CylindricalSelectionRule.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.visit.md index add78ec23e..f3b8e6eacc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.CylindricalSelectionRule.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.clear_generated_data.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.clear_generated_data.md index b3a24c2694..cca163f75f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.clear_generated_data.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.clear_generated_data.md @@ -8,4 +8,4 @@ Function clears the eventually stored update results and deletes the generated d Production and Analysis Plies, Solid Models, etc. * **Parameters:** - -model: The ACP model to be cleared. + - model: The ACP model to be cleared. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.import_model.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.import_model.md index d59610d184..403e50d271 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.import_model.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.import_model.md @@ -9,8 +9,8 @@ Create a model from file. * **Parameters:** - name: Custom name of the model. - path: Path to the data file. - - format: File format string. Valid options: ‘abaqus:inp’,’ansys:cdb’, ‘ansys:dat’, ‘nastran:bdf’, and ‘ansys:h5’. - - ignored_entities: Entities to ignore. Can be a subset of the following list: [‘mesh’, ‘element_sets’, ‘materials’, ‘coordinate_systems’, ‘shell_sections’]. - - convert_section_data: Whether to import and convert the shell section data into ACP composite definitions. Default is ‘False’. + - format: File format string. Available options: `abaqus:inp`, `ansys:cdb`, `ansys:dat`, `nastran:bdf`, and `ansys:h5`. + - ignored_entities: Entities to ignore. Can be a subset of the following list: [`mesh`, `element_sets`, `materials`, `coordinate_systems`, `shell_sections`]. + - convert_section_data: Whether to import and convert the shell section data into ACP composite definitions. Default is `False`. - unit_system_type: Set the unit system of the model to this type. Ignored if a unit system was already defined in the data file. - reference_surface_input_unit_system_type: Set the unit system of the reference surface if the unit system cannot be read from the input. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.is_dict_item.md index 0c55e4fec3..4e93065c4d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* DB.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.is_list_item.md index ded3cd0df3..a3ef0e549b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.is_list_item.md @@ -4,4 +4,4 @@ #### *property* DB.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.md index 04ded696b6..ec770ce49b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.md @@ -18,10 +18,10 @@ Access: | Name | Description | |------------------------------------------------------------------------------|--------------------------------------------------------------------| | [`DB.active_model`](compolyx.DB.active_model.md#compolyx.DB.active_model) | Active model | -| [`DB.is_dict_item`](compolyx.DB.is_dict_item.md#compolyx.DB.is_dict_item) | Specifies wether the object is an item of a dict | -| [`DB.is_list_item`](compolyx.DB.is_list_item.md#compolyx.DB.is_list_item) | Specifies wether the object is an item of a list | +| [`DB.is_dict_item`](compolyx.DB.is_dict_item.md#compolyx.DB.is_dict_item) | Specifies whether the object is an item of a dict | +| [`DB.is_list_item`](compolyx.DB.is_list_item.md#compolyx.DB.is_list_item) | Specifies whether the object is an item of a list | | [`DB.link_path`](compolyx.DB.link_path.md#compolyx.DB.link_path) | Root path of the current node in the tree for links to this object | -| [`DB.material_data`](compolyx.DB.material_data.md#compolyx.DB.material_data) | Material Data Base | +| [`DB.material_data`](compolyx.DB.material_data.md#compolyx.DB.material_data) | Material database | | [`DB.models`](compolyx.DB.models.md#compolyx.DB.models) | Models | | [`DB.name`](compolyx.DB.name.md#compolyx.DB.name) | Name of object | | [`DB.parent`](compolyx.DB.parent.md#compolyx.DB.parent) | Parent object in tree | @@ -31,16 +31,16 @@ Access: | Name | Description | |-------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| -| [`DB.clear`](compolyx.DB.clear.md#compolyx.DB.clear)() | Clear database. | -| [`DB.clear_generated_data`](compolyx.DB.clear_generated_data.md#compolyx.DB.clear_generated_data)([model]) | Function clears the eventually stored update results and deletes the generated data such as Production and Analysis Plies, Solid Models, etc. | -| [`DB.close`](compolyx.DB.close.md#compolyx.DB.close)([model]) | Close model. | -| [`DB.find_parent`](compolyx.DB.find_parent.md#compolyx.DB.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`DB.import_model`](compolyx.DB.import_model.md#compolyx.DB.import_model)(name, path, format[, ...]) | Create a model from file. | -| [`DB.open`](compolyx.DB.open.md#compolyx.DB.open)(path[, replace_workbench_inputs, ...]) | Open ACP file and append the model to models container. | -| [`DB.open_h5`](compolyx.DB.open_h5.md#compolyx.DB.open_h5)(path[, cache_data, ...]) | Load a model from an .acph5 database. | -| [`DB.refresh_acph5`](compolyx.DB.refresh_acph5.md#compolyx.DB.refresh_acph5)(path, external_sources[, ...]) | Refresh an .acph5 database (Workbench application mode only). | -| [`DB.reload`](compolyx.DB.reload.md#compolyx.DB.reload)(model) | Reloads the reference surface (mesh) of the model. | +| [`DB.clear`](compolyx.DB.clear.md#compolyx.DB.clear)() | Clear database | +| [`DB.clear_generated_data`](compolyx.DB.clear_generated_data.md#compolyx.DB.clear_generated_data)([model]) | Function clears the eventually stored update results and deletes the generated data such as production and analysis plies, solid models, etc. | +| [`DB.close`](compolyx.DB.close.md#compolyx.DB.close)([model]) | Close model | +| [`DB.find_parent`](compolyx.DB.find_parent.md#compolyx.DB.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`DB.import_model`](compolyx.DB.import_model.md#compolyx.DB.import_model)(name, path, format[, ...]) | Create a model from file | +| [`DB.open`](compolyx.DB.open.md#compolyx.DB.open)(path[, replace_workbench_inputs, ...]) | Open ACP file and append the model to models container | +| [`DB.open_h5`](compolyx.DB.open_h5.md#compolyx.DB.open_h5)(path[, cache_data, ...]) | Load a model from an .acph5 database | +| [`DB.refresh_acph5`](compolyx.DB.refresh_acph5.md#compolyx.DB.refresh_acph5)(path, external_sources[, ...]) | Refresh an .acph5 database (Workbench application mode only) | +| [`DB.reload`](compolyx.DB.reload.md#compolyx.DB.reload)(model) | Reloads the reference surface (mesh) of the model | | [`DB.run_script`](compolyx.DB.run_script.md#compolyx.DB.run_script)(path[, locals]) | | -| [`DB.save`](compolyx.DB.save.md#compolyx.DB.save)([path, model, cache_data]) | Save active model. | -| [`DB.set_unit_system`](compolyx.DB.set_unit_system.md#compolyx.DB.set_unit_system)(unit_system_type) | Set the unit system of all models opened in the database. | -| [`DB.visit`](compolyx.DB.visit.md#compolyx.DB.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`DB.save`](compolyx.DB.save.md#compolyx.DB.save)([path, model, cache_data]) | Save active model | +| [`DB.set_unit_system`](compolyx.DB.set_unit_system.md#compolyx.DB.set_unit_system)(unit_system_type) | Set the unit system of all models opened in the database | +| [`DB.visit`](compolyx.DB.visit.md#compolyx.DB.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.open.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.open.md index e3fb0eeca1..ca725314e6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.open.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.open.md @@ -5,7 +5,8 @@ #### DB.open(path, replace_workbench_inputs=None, pre_db=None, unit_system_type=None, load_cached_data=False, apply_shared_commands=False) Open ACP file and append the model to models container. -:Parameters: + +* **Parameters:** - path: Path to ACP file. - replace_mesh_kwargs: Optional keyword arguments to replace the mesh to load in db.import_model(…) upfront. - replace_workbench_inputs: Optional dictionary with Workbench application inputs to replace before executing the .acp file. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.refresh_acph5.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.refresh_acph5.md index 1bb30fe1d8..9bf0403448 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.refresh_acph5.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.refresh_acph5.md @@ -10,13 +10,13 @@ Refresh an .acph5 database (Workbench application mode only). - path: File path to the .acph5 file. - external_sources: Nested dict provided by the ACP Workbench application add-in containing all the : external source’s information (the file path, whether the source was modified, its ID, etc.). - - The dict keys are: [‘model’, ‘materials’, ‘cad_geometries’, ‘imported_solid_models’, ‘pre_db’, ‘solutions’]. - > - Values for ‘model’ and ‘materials’ are dicts with the following fields [‘path’, ‘external_id’, ‘modified’]. - > - Values for ‘cad_geometries’, ‘imported_solid_models’ and ‘pre_db’ are list + - The dict keys are: [`model`, `materials`, `cad_geometries`, `imported_solid_models`, `pre_db`, `solutions`]. + > - Values for `model` and `materials` are dicts with the following fields [`path`, `external_id`, `modified`]. + > - Values for `cad_geometries`, `imported_solid_models` and `pre_db` are list
- > of dicts with fields [‘name’, ‘path’, ‘external_id’, ‘modified’]. - > - Values for ‘solutions’ are dicts with fields [‘name’, ‘path’, ‘external_id’, ‘modified’, ‘renumbering_mapping_paths’] where - > renumbering_mapping_paths is a list of file paths. + > of dicts with fields [`name`, `path`, `external_id`, `modified`]. + > - Values for `solutions` are dicts with fields [`name`, `path`, `external_id`, `modified`, `renumbering_mapping_paths`] where + > `renumbering_mapping_paths` is a list of file paths. - input_parameters: A dict of pairs (name, value) of the Workbench application input parameters. - initialize: Specifies whether the .acph5 database needs to be initialized (for example if the file does not : yet exist). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.visit.md index f7e8ad71ab..9349e589a4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.DB.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.edge_set_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.edge_set_type.md index 080671acf5..8bab212c03 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.edge_set_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.edge_set_type.md @@ -4,4 +4,4 @@ #### *property* EdgeSet.edge_set_type -Edge Set Types can be: “By Reference”, “By Nodes” +Edge Set Types. Available options: `By Reference` or `By Nodes` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.enabled.md index 304aa4eefd..fe13df1c60 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.enabled.md @@ -4,4 +4,4 @@ #### *property* EdgeSet.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.is_dict_item.md index 4ec0211f6f..bf80d89287 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* EdgeSet.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.is_list_item.md index 676a355b47..b2138557b9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.is_list_item.md @@ -4,4 +4,4 @@ #### *property* EdgeSet.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.md index fd1d5a31b6..aa4e1b3f56 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.md @@ -10,19 +10,19 @@ Edge Set class. | Name | Description | |------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`EdgeSet.active`](compolyx.EdgeSet.active.md#compolyx.EdgeSet.active) | active status of object | -| [`EdgeSet.changed`](compolyx.EdgeSet.changed.md#compolyx.EdgeSet.changed) | Status boolean. | +| [`EdgeSet.active`](compolyx.EdgeSet.active.md#compolyx.EdgeSet.active) | Active status of object | +| [`EdgeSet.changed`](compolyx.EdgeSet.changed.md#compolyx.EdgeSet.changed) | Status boolean | | [`EdgeSet.display_data`](compolyx.EdgeSet.display_data.md#compolyx.EdgeSet.display_data) | The edge set mesh plot | -| [`EdgeSet.edge_set_type`](compolyx.EdgeSet.edge_set_type.md#compolyx.EdgeSet.edge_set_type) | Edge Set Types can be: "By Reference", "By Nodes" | +| [`EdgeSet.edge_set_type`](compolyx.EdgeSet.edge_set_type.md#compolyx.EdgeSet.edge_set_type) | Edge Set Types. Available options: "By Reference", "By Nodes" | | [`EdgeSet.element_set`](compolyx.EdgeSet.element_set.md#compolyx.EdgeSet.element_set) | | -| [`EdgeSet.enabled`](compolyx.EdgeSet.enabled.md#compolyx.EdgeSet.enabled) | Whether this object is currently enabled or not. | +| [`EdgeSet.enabled`](compolyx.EdgeSet.enabled.md#compolyx.EdgeSet.enabled) | Whether this object is currently enabled or not | | [`EdgeSet.id`](compolyx.EdgeSet.id.md#compolyx.EdgeSet.id) | ID of object | -| [`EdgeSet.is_closed`](compolyx.EdgeSet.is_closed.md#compolyx.EdgeSet.is_closed) | Edge Set is closed. | -| [`EdgeSet.is_dict_item`](compolyx.EdgeSet.is_dict_item.md#compolyx.EdgeSet.is_dict_item) | Specifies wether the object is an item of a dict | -| [`EdgeSet.is_list_item`](compolyx.EdgeSet.is_list_item.md#compolyx.EdgeSet.is_list_item) | Specifies wether the object is an item of a list | +| [`EdgeSet.is_closed`](compolyx.EdgeSet.is_closed.md#compolyx.EdgeSet.is_closed) | Edge Set is closed | +| [`EdgeSet.is_dict_item`](compolyx.EdgeSet.is_dict_item.md#compolyx.EdgeSet.is_dict_item) | Specifies whether the object is an item of a dict | +| [`EdgeSet.is_list_item`](compolyx.EdgeSet.is_list_item.md#compolyx.EdgeSet.is_list_item) | Specifies whether the object is an item of a list | | [`EdgeSet.limit_angle`](compolyx.EdgeSet.limit_angle.md#compolyx.EdgeSet.limit_angle) | Edge Set limit angle for creation of edge set by reference | | [`EdgeSet.link_path`](compolyx.EdgeSet.link_path.md#compolyx.EdgeSet.link_path) | Root path of the current node in the tree for links to this object | -| [`EdgeSet.locked`](compolyx.EdgeSet.locked.md#compolyx.EdgeSet.locked) | Edge Set is imported and cannot be changed. | +| [`EdgeSet.locked`](compolyx.EdgeSet.locked.md#compolyx.EdgeSet.locked) | Edge Set is imported and cannot be changed | | [`EdgeSet.mesh`](compolyx.EdgeSet.mesh.md#compolyx.EdgeSet.mesh) | The edge set mesh | | [`EdgeSet.name`](compolyx.EdgeSet.name.md#compolyx.EdgeSet.name) | Name of object | | [`EdgeSet.node_labels`](compolyx.EdgeSet.node_labels.md#compolyx.EdgeSet.node_labels) | Node labels defining the NodeSet (only if type='By Nodes') | @@ -31,9 +31,9 @@ Edge Set class. | [`EdgeSet.parent`](compolyx.EdgeSet.parent.md#compolyx.EdgeSet.parent) | Parent object in tree | | [`EdgeSet.root_path`](compolyx.EdgeSet.root_path.md#compolyx.EdgeSet.root_path) | Root path of the current node in the tree | | [`EdgeSet.status`](compolyx.EdgeSet.status.md#compolyx.EdgeSet.status) | Status of the object | -| [`EdgeSet.status_changed`](compolyx.EdgeSet.status_changed.md#compolyx.EdgeSet.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`EdgeSet.status_changed`](compolyx.EdgeSet.status_changed.md#compolyx.EdgeSet.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`EdgeSet.uid`](compolyx.EdgeSet.uid.md#compolyx.EdgeSet.uid) | UID of object | -| [`EdgeSet.vertex`](compolyx.EdgeSet.vertex.md#compolyx.EdgeSet.vertex) | This will throw an error if the object has been removed from the graph. | +| [`EdgeSet.vertex`](compolyx.EdgeSet.vertex.md#compolyx.EdgeSet.vertex) | Throws an error if the object has been removed from the graph. | ### Methods @@ -41,11 +41,11 @@ Edge Set class. |----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| | [`EdgeSet.average_normal_direction`](compolyx.EdgeSet.average_normal_direction.md#compolyx.EdgeSet.average_normal_direction)() | | | [`EdgeSet.center`](compolyx.EdgeSet.center.md#compolyx.EdgeSet.center)() | | -| [`EdgeSet.find_parent`](compolyx.EdgeSet.find_parent.md#compolyx.EdgeSet.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`EdgeSet.get_nodes`](compolyx.EdgeSet.get_nodes.md#compolyx.EdgeSet.get_nodes)() | Return Python list with nodes as objects. | +| [`EdgeSet.find_parent`](compolyx.EdgeSet.find_parent.md#compolyx.EdgeSet.find_parent)(type) | Steps up the tree and returns the first parent with given type | +| [`EdgeSet.get_nodes`](compolyx.EdgeSet.get_nodes.md#compolyx.EdgeSet.get_nodes)() | Return Python list with nodes as objects | | [`EdgeSet.get_short_description`](compolyx.EdgeSet.get_short_description.md#compolyx.EdgeSet.get_short_description)() | | -| [`EdgeSet.obj_exists`](compolyx.EdgeSet.obj_exists.md#compolyx.EdgeSet.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. | -| [`EdgeSet.serialize`](compolyx.EdgeSet.serialize.md#compolyx.EdgeSet.serialize)() | Serialize to Python string. | -| [`EdgeSet.serialize_name_and_id`](compolyx.EdgeSet.serialize_name_and_id.md#compolyx.EdgeSet.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`EdgeSet.obj_exists`](compolyx.EdgeSet.obj_exists.md#compolyx.EdgeSet.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 | +| [`EdgeSet.serialize`](compolyx.EdgeSet.serialize.md#compolyx.EdgeSet.serialize)() | Serialize to Python string | +| [`EdgeSet.serialize_name_and_id`](compolyx.EdgeSet.serialize_name_and_id.md#compolyx.EdgeSet.serialize_name_and_id)() | Helper function to serialize name and ID | | [`EdgeSet.update`](compolyx.EdgeSet.update.md#compolyx.EdgeSet.update)() | | -| [`EdgeSet.visit`](compolyx.EdgeSet.visit.md#compolyx.EdgeSet.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`EdgeSet.visit`](compolyx.EdgeSet.visit.md#compolyx.EdgeSet.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.node_labels.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.node_labels.md index dbf4df5329..5ea52c053c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.node_labels.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.node_labels.md @@ -4,4 +4,4 @@ #### *property* EdgeSet.node_labels -Node labels defining the NodeSet (only if type=’By Nodes’) +Node labels defining the NodeSet (only if type = `By Nodes`) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.obj_exists.md index cdbbcb9808..4160e98d26 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.obj_exists.md @@ -4,5 +4,5 @@ #### EdgeSet.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.visit.md index 9a8aa684c1..3bdfc1d8e4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EdgeSet.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.enabled.md index e73613bcdf..ff3667b226 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.enabled.md @@ -4,4 +4,4 @@ #### *property* ElementSelectionRule.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.is_dict_item.md index a9e7c62c45..fd9bd2eb53 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ElementSelectionRule.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.is_list_item.md index 3e836c450c..a3d4379e85 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ElementSelectionRule.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.md index 2c401b4458..7b1a8cdc12 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.md @@ -6,45 +6,45 @@ Base class for rules. This acts as an interface to the cpp object of the rules. -The base class implements \_py_update which is called after the cpp update. It sets the changed flag. -Since NameGraph derives from Observable, observers can listen on ‘changed’. +The base class implements `\_py_update` which is called after the cpp update. It sets the changed flag. +Since NameGraph derives from Observable, observers can listen on `changed`. -In order to support csv_serialization, the classes have to implement a ‘_dict’ method -and a list named ‘_csv_parameters’. -The \_dict method specifies which properties are written and \_csv_parameters specifies which parameters are read and -how they are parsed. The keys in \_dict and the elements in \_parameters_csv have to be consistent. +In order to support csv_serialization, the classes have to implement a `_dict` method +and a list named `_csv_parameters`. +The `\_dict` method specifies which properties are written and `\_csv_parameters` specifies which parameters are read and +how they are parsed. The keys in `\_dict` and the elements in `\_parameters_csv` have to be consistent. If the conversion from the string to an object is more than simple type conversion, -it can be implemented in \_update_rule_from_csv. +it can be implemented in `\_update_rule_from_csv`. ### Attributes | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`ElementSelectionRule.active`](compolyx.ElementSelectionRule.active.md#compolyx.ElementSelectionRule.active) | active status of object | +| [`ElementSelectionRule.active`](compolyx.ElementSelectionRule.active.md#compolyx.ElementSelectionRule.active) | Active status of object | | [`ElementSelectionRule.changed`](compolyx.ElementSelectionRule.changed.md#compolyx.ElementSelectionRule.changed) | Triggers Observable to dispatch changed message | -| [`ElementSelectionRule.enabled`](compolyx.ElementSelectionRule.enabled.md#compolyx.ElementSelectionRule.enabled) | Whether this object is currently enabled or not. | +| [`ElementSelectionRule.enabled`](compolyx.ElementSelectionRule.enabled.md#compolyx.ElementSelectionRule.enabled) | Whether this object is currently enabled or not | | [`ElementSelectionRule.extent`](compolyx.ElementSelectionRule.extent.md#compolyx.ElementSelectionRule.extent) | extent of the rule | | [`ElementSelectionRule.id`](compolyx.ElementSelectionRule.id.md#compolyx.ElementSelectionRule.id) | ID of object | -| [`ElementSelectionRule.include_rule_type`](compolyx.ElementSelectionRule.include_rule_type.md#compolyx.ElementSelectionRule.include_rule_type) | include type | -| [`ElementSelectionRule.is_dict_item`](compolyx.ElementSelectionRule.is_dict_item.md#compolyx.ElementSelectionRule.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ElementSelectionRule.is_list_item`](compolyx.ElementSelectionRule.is_list_item.md#compolyx.ElementSelectionRule.is_list_item) | Specifies wether the object is an item of a list | +| [`ElementSelectionRule.include_rule_type`](compolyx.ElementSelectionRule.include_rule_type.md#compolyx.ElementSelectionRule.include_rule_type) | Include type | +| [`ElementSelectionRule.is_dict_item`](compolyx.ElementSelectionRule.is_dict_item.md#compolyx.ElementSelectionRule.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ElementSelectionRule.is_list_item`](compolyx.ElementSelectionRule.is_list_item.md#compolyx.ElementSelectionRule.is_list_item) | Specifies whether the object is an item of a list | | [`ElementSelectionRule.link_path`](compolyx.ElementSelectionRule.link_path.md#compolyx.ElementSelectionRule.link_path) | Root path of the current node in the tree for links to this object | | [`ElementSelectionRule.name`](compolyx.ElementSelectionRule.name.md#compolyx.ElementSelectionRule.name) | Name of object | | [`ElementSelectionRule.parent`](compolyx.ElementSelectionRule.parent.md#compolyx.ElementSelectionRule.parent) | Parent object in tree | -| [`ElementSelectionRule.relative_rule_type`](compolyx.ElementSelectionRule.relative_rule_type.md#compolyx.ElementSelectionRule.relative_rule_type) | relative type | +| [`ElementSelectionRule.relative_rule_type`](compolyx.ElementSelectionRule.relative_rule_type.md#compolyx.ElementSelectionRule.relative_rule_type) | Relative type | | [`ElementSelectionRule.root_path`](compolyx.ElementSelectionRule.root_path.md#compolyx.ElementSelectionRule.root_path) | Root path of the current node in the tree | | [`ElementSelectionRule.status`](compolyx.ElementSelectionRule.status.md#compolyx.ElementSelectionRule.status) | Status of the object | -| [`ElementSelectionRule.status_changed`](compolyx.ElementSelectionRule.status_changed.md#compolyx.ElementSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`ElementSelectionRule.status_changed`](compolyx.ElementSelectionRule.status_changed.md#compolyx.ElementSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`ElementSelectionRule.uid`](compolyx.ElementSelectionRule.uid.md#compolyx.ElementSelectionRule.uid) | UID of object | -| [`ElementSelectionRule.vertex`](compolyx.ElementSelectionRule.vertex.md#compolyx.ElementSelectionRule.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ElementSelectionRule.vertex`](compolyx.ElementSelectionRule.vertex.md#compolyx.ElementSelectionRule.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ElementSelectionRule.find_parent`](compolyx.ElementSelectionRule.find_parent.md#compolyx.ElementSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`ElementSelectionRule.obj_exists`](compolyx.ElementSelectionRule.obj_exists.md#compolyx.ElementSelectionRule.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. | -| [`ElementSelectionRule.serialize_name_and_id`](compolyx.ElementSelectionRule.serialize_name_and_id.md#compolyx.ElementSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ElementSelectionRule.find_parent`](compolyx.ElementSelectionRule.find_parent.md#compolyx.ElementSelectionRule.find_parent)(type) | Steps up the tree and returns the first parent with given type | +| [`ElementSelectionRule.obj_exists`](compolyx.ElementSelectionRule.obj_exists.md#compolyx.ElementSelectionRule.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 | +| [`ElementSelectionRule.serialize_name_and_id`](compolyx.ElementSelectionRule.serialize_name_and_id.md#compolyx.ElementSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ElementSelectionRule.serialize_rule_types`](compolyx.ElementSelectionRule.serialize_rule_types.md#compolyx.ElementSelectionRule.serialize_rule_types)() | | | [`ElementSelectionRule.update`](compolyx.ElementSelectionRule.update.md#compolyx.ElementSelectionRule.update)() | | -| [`ElementSelectionRule.visit`](compolyx.ElementSelectionRule.visit.md#compolyx.ElementSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ElementSelectionRule.visit`](compolyx.ElementSelectionRule.visit.md#compolyx.ElementSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.obj_exists.md index 2f68108056..88a5d7461e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.obj_exists.md @@ -4,5 +4,5 @@ #### ElementSelectionRule.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.visit.md index 5d4ddc6355..cee95aad62 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSelectionRule.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.enabled.md index 72e10f9978..32d60e6134 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.enabled.md @@ -4,4 +4,4 @@ #### *property* ElementSet.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.is_dict_item.md index c4a4f30e21..1af9852843 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ElementSet.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.is_list_item.md index 203bbbbd6a..2456509a4a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ElementSet.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.md index 86f86ea079..6851503cbf 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.md @@ -20,42 +20,42 @@ Element set class. | Name | Description | |---------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`ElementSet.active`](compolyx.ElementSet.active.md#compolyx.ElementSet.active) | active status of object | -| [`ElementSet.boundaries`](compolyx.ElementSet.boundaries.md#compolyx.ElementSet.boundaries) | Get the boundaries of the Element Set | +| [`ElementSet.active`](compolyx.ElementSet.active.md#compolyx.ElementSet.active) | Active status of object | +| [`ElementSet.boundaries`](compolyx.ElementSet.boundaries.md#compolyx.ElementSet.boundaries) | Get the boundaries of the element set | | [`ElementSet.element_labels`](compolyx.ElementSet.element_labels.md#compolyx.ElementSet.element_labels) | | -| [`ElementSet.enabled`](compolyx.ElementSet.enabled.md#compolyx.ElementSet.enabled) | Whether this object is currently enabled or not. | +| [`ElementSet.enabled`](compolyx.ElementSet.enabled.md#compolyx.ElementSet.enabled) | Whether this object is currently enabled or not | | [`ElementSet.id`](compolyx.ElementSet.id.md#compolyx.ElementSet.id) | ID of object | -| [`ElementSet.is_dict_item`](compolyx.ElementSet.is_dict_item.md#compolyx.ElementSet.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ElementSet.is_list_item`](compolyx.ElementSet.is_list_item.md#compolyx.ElementSet.is_list_item) | Specifies wether the object is an item of a list | +| [`ElementSet.is_dict_item`](compolyx.ElementSet.is_dict_item.md#compolyx.ElementSet.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ElementSet.is_list_item`](compolyx.ElementSet.is_list_item.md#compolyx.ElementSet.is_list_item) | Specifies whether the object is an item of a list | | [`ElementSet.link_path`](compolyx.ElementSet.link_path.md#compolyx.ElementSet.link_path) | Root path of the current node in the tree for links to this object | -| [`ElementSet.locked`](compolyx.ElementSet.locked.md#compolyx.ElementSet.locked) | Element Set is imported and cannot be changed. | +| [`ElementSet.locked`](compolyx.ElementSet.locked.md#compolyx.ElementSet.locked) | Element Set is imported and cannot be changed | | [`ElementSet.middle_offset`](compolyx.ElementSet.middle_offset.md#compolyx.ElementSet.middle_offset) | Middle offset flag | | [`ElementSet.name`](compolyx.ElementSet.name.md#compolyx.ElementSet.name) | Name of object | -| [`ElementSet.normals`](compolyx.ElementSet.normals.md#compolyx.ElementSet.normals) | Get the Normals of the Element Set | -| [`ElementSet.orientable`](compolyx.ElementSet.orientable.md#compolyx.ElementSet.orientable) | True if the Element Set has an orientable topology | +| [`ElementSet.normals`](compolyx.ElementSet.normals.md#compolyx.ElementSet.normals) | Get the normals of the element set | +| [`ElementSet.orientable`](compolyx.ElementSet.orientable.md#compolyx.ElementSet.orientable) | True if the element set has an orientable topology | | [`ElementSet.parent`](compolyx.ElementSet.parent.md#compolyx.ElementSet.parent) | Parent object in tree | -| [`ElementSet.planar`](compolyx.ElementSet.planar.md#compolyx.ElementSet.planar) | True if the Element Set has a planar topology | +| [`ElementSet.planar`](compolyx.ElementSet.planar.md#compolyx.ElementSet.planar) | True if the element set has a planar topology | | [`ElementSet.root_path`](compolyx.ElementSet.root_path.md#compolyx.ElementSet.root_path) | Root path of the current node in the tree | | [`ElementSet.size`](compolyx.ElementSet.size.md#compolyx.ElementSet.size) | Number of entities | | [`ElementSet.status`](compolyx.ElementSet.status.md#compolyx.ElementSet.status) | Status of the object | -| [`ElementSet.status_changed`](compolyx.ElementSet.status_changed.md#compolyx.ElementSet.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`ElementSet.status_changed`](compolyx.ElementSet.status_changed.md#compolyx.ElementSet.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`ElementSet.uid`](compolyx.ElementSet.uid.md#compolyx.ElementSet.uid) | UID of object | -| [`ElementSet.vertex`](compolyx.ElementSet.vertex.md#compolyx.ElementSet.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ElementSet.vertex`](compolyx.ElementSet.vertex.md#compolyx.ElementSet.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ElementSet.add`](compolyx.ElementSet.add.md#compolyx.ElementSet.add)(entity) | Add entity to the set. | +| [`ElementSet.add`](compolyx.ElementSet.add.md#compolyx.ElementSet.add)(entity) | Add entity to the set | | [`ElementSet.clear`](compolyx.ElementSet.clear.md#compolyx.ElementSet.clear)() | | -| [`ElementSet.find_parent`](compolyx.ElementSet.find_parent.md#compolyx.ElementSet.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`ElementSet.find_parent`](compolyx.ElementSet.find_parent.md#compolyx.ElementSet.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`ElementSet.get_short_description`](compolyx.ElementSet.get_short_description.md#compolyx.ElementSet.get_short_description)() | | -| [`ElementSet.modify`](compolyx.ElementSet.modify.md#compolyx.ElementSet.modify)([op, element_labels, ...]) | General method to modify the elements in an element set. | -| [`ElementSet.obj_exists`](compolyx.ElementSet.obj_exists.md#compolyx.ElementSet.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. | -| [`ElementSet.partition`](compolyx.ElementSet.partition.md#compolyx.ElementSet.partition)() | Partitions this ElementSet into new ElementSets with an orientable topology. | -| [`ElementSet.remove`](compolyx.ElementSet.remove.md#compolyx.ElementSet.remove)(entity) | Remove entity from the set. | -| [`ElementSet.serialize`](compolyx.ElementSet.serialize.md#compolyx.ElementSet.serialize)() | Serialize to Python string. | -| [`ElementSet.serialize_name_and_id`](compolyx.ElementSet.serialize_name_and_id.md#compolyx.ElementSet.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ElementSet.modify`](compolyx.ElementSet.modify.md#compolyx.ElementSet.modify)([op, element_labels, ...]) | General method to modify the elements in an element set | +| [`ElementSet.obj_exists`](compolyx.ElementSet.obj_exists.md#compolyx.ElementSet.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 | +| [`ElementSet.partition`](compolyx.ElementSet.partition.md#compolyx.ElementSet.partition)() | Partitions this ElementSet into new ElementSets with an orientable topology | +| [`ElementSet.remove`](compolyx.ElementSet.remove.md#compolyx.ElementSet.remove)(entity) | Remove entity from the set | +| [`ElementSet.serialize`](compolyx.ElementSet.serialize.md#compolyx.ElementSet.serialize)() | Serialize to Python string | +| [`ElementSet.serialize_name_and_id`](compolyx.ElementSet.serialize_name_and_id.md#compolyx.ElementSet.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ElementSet.update`](compolyx.ElementSet.update.md#compolyx.ElementSet.update)() | | -| [`ElementSet.visit`](compolyx.ElementSet.visit.md#compolyx.ElementSet.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | -| [`ElementSet.write_boundaries`](compolyx.ElementSet.write_boundaries.md#compolyx.ElementSet.write_boundaries)(filename[, format]) | Write boundaries in .iges/.step format. | +| [`ElementSet.visit`](compolyx.ElementSet.visit.md#compolyx.ElementSet.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | +| [`ElementSet.write_boundaries`](compolyx.ElementSet.write_boundaries.md#compolyx.ElementSet.write_boundaries)(filename[, format]) | Write boundaries in .iges/.step format | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.modify.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.modify.md index ba77e935c8..9f0c8c91b0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.modify.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.modify.md @@ -7,7 +7,7 @@ General method to modify the elements in an element set. * **Parameters:** - - op: Selection method. Valid options: new, add, remove, intersect, and inverse. + - op: Selection method. Available options: `new`, `add`, `remove`, `intersect`, and `inverse`. - element_labels: List of element IDs. - element_sets: List of element sets. - x: Min and max of x location. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.obj_exists.md index 2563026f58..08cb0666ca 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.obj_exists.md @@ -4,5 +4,5 @@ #### ElementSet.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.visit.md index b8b0f491cf..fbd58061a3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.write_boundaries.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.write_boundaries.md index 6d2ff23fe5..837896c3e5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.write_boundaries.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ElementSet.write_boundaries.md @@ -5,6 +5,7 @@ #### ElementSet.write_boundaries(filename, format=None) Write boundaries in .iges/.step format. -:Parameters: -- filename: Output file. -- format: ‘iges’, ‘step’, None (automatic format recognition). + +* **Parameters:** + - filename: Output file. + - format: `iges`, `step`, `None` (automatic format recognition). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.md index ef0ce732e6..8a85672852 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.md @@ -10,11 +10,11 @@ Base class for entity sets. | Name | Description | |------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`EntitySet.active`](compolyx.EntitySet.active.md#compolyx.EntitySet.active) | active status of object | -| [`EntitySet.enabled`](compolyx.EntitySet.enabled.md#compolyx.EntitySet.enabled) | Whether this object is currently enabled or not. | +| [`EntitySet.active`](compolyx.EntitySet.active.md#compolyx.EntitySet.active) | Active status of object | +| [`EntitySet.enabled`](compolyx.EntitySet.enabled.md#compolyx.EntitySet.enabled) | Whether this object is currently enabled or not | | [`EntitySet.id`](compolyx.EntitySet.id.md#compolyx.EntitySet.id) | ID of object | -| [`EntitySet.is_dict_item`](compolyx.EntitySet.is_dict_item.md#compolyx.EntitySet.is_dict_item) | Specifies wether the object is an item of a dict | -| [`EntitySet.is_list_item`](compolyx.EntitySet.is_list_item.md#compolyx.EntitySet.is_list_item) | Specifies wether the object is an item of a list | +| [`EntitySet.is_dict_item`](compolyx.EntitySet.is_dict_item.md#compolyx.EntitySet.is_dict_item) | Specifies whether the object is an item of a dict | +| [`EntitySet.is_list_item`](compolyx.EntitySet.is_list_item.md#compolyx.EntitySet.is_list_item) | Specifies whether the object is an item of a list | | [`EntitySet.link_path`](compolyx.EntitySet.link_path.md#compolyx.EntitySet.link_path) | Root path of the current node in the tree for links to this object | | [`EntitySet.name`](compolyx.EntitySet.name.md#compolyx.EntitySet.name) | Name of object | | [`EntitySet.parent`](compolyx.EntitySet.parent.md#compolyx.EntitySet.parent) | Parent object in tree | @@ -23,17 +23,17 @@ Base class for entity sets. | [`EntitySet.status`](compolyx.EntitySet.status.md#compolyx.EntitySet.status) | Status of the object | | [`EntitySet.status_changed`](compolyx.EntitySet.status_changed.md#compolyx.EntitySet.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | | [`EntitySet.uid`](compolyx.EntitySet.uid.md#compolyx.EntitySet.uid) | UID of object | -| [`EntitySet.vertex`](compolyx.EntitySet.vertex.md#compolyx.EntitySet.vertex) | This will throw an error if the object has been removed from the graph. | +| [`EntitySet.vertex`](compolyx.EntitySet.vertex.md#compolyx.EntitySet.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`EntitySet.add`](compolyx.EntitySet.add.md#compolyx.EntitySet.add)(entity) | Add entity to the set. | +| [`EntitySet.add`](compolyx.EntitySet.add.md#compolyx.EntitySet.add)(entity) | Add entity to the set | | [`EntitySet.clear`](compolyx.EntitySet.clear.md#compolyx.EntitySet.clear)() | | -| [`EntitySet.find_parent`](compolyx.EntitySet.find_parent.md#compolyx.EntitySet.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`EntitySet.obj_exists`](compolyx.EntitySet.obj_exists.md#compolyx.EntitySet.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. | -| [`EntitySet.remove`](compolyx.EntitySet.remove.md#compolyx.EntitySet.remove)(entity) | Remove entity from the set. | -| [`EntitySet.serialize_name_and_id`](compolyx.EntitySet.serialize_name_and_id.md#compolyx.EntitySet.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`EntitySet.find_parent`](compolyx.EntitySet.find_parent.md#compolyx.EntitySet.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`EntitySet.obj_exists`](compolyx.EntitySet.obj_exists.md#compolyx.EntitySet.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 | +| [`EntitySet.remove`](compolyx.EntitySet.remove.md#compolyx.EntitySet.remove)(entity) | Remove entity from the set | +| [`EntitySet.serialize_name_and_id`](compolyx.EntitySet.serialize_name_and_id.md#compolyx.EntitySet.serialize_name_and_id)() | Helper function to serialize name and ID | | [`EntitySet.update`](compolyx.EntitySet.update.md#compolyx.EntitySet.update)() | | -| [`EntitySet.visit`](compolyx.EntitySet.visit.md#compolyx.EntitySet.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`EntitySet.visit`](compolyx.EntitySet.visit.md#compolyx.EntitySet.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.obj_exists.md index 5cfe0b6551..2043dc652b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.obj_exists.md @@ -4,5 +4,5 @@ #### EntitySet.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.visit.md index 4eff13a0d9..36c3e98467 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.EntitySet.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.depth.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.depth.md index 7c11cb3cc8..7bea53dbf0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.depth.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.depth.md @@ -4,4 +4,4 @@ #### *property* ExtrusionGuide.depth -intensity for the propagation of mesh corrections, depth=1 leads to a linear decay from the guide to the radius, depth<1 leads to more local corrections +Intensity for the propagation of mesh corrections, depth=1 leads to a linear decay from the guide to the radius, depth<1 leads to more local corrections diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.is_dict_item.md index 3ff212d0a1..bc07f425e3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ExtrusionGuide.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.is_list_item.md index a16c4be7f0..3f4fc21388 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ExtrusionGuide.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.md index 57d0fe6a1b..8907b459f0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.md @@ -11,33 +11,33 @@ Extrusion guide class | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | [`ExtrusionGuide.active`](compolyx.ExtrusionGuide.active.md#compolyx.ExtrusionGuide.active) | Extrusion Guide active | -| [`ExtrusionGuide.cad_geometry`](compolyx.ExtrusionGuide.cad_geometry.md#compolyx.ExtrusionGuide.cad_geometry) | Associated CADGeometry. | -| [`ExtrusionGuide.depth`](compolyx.ExtrusionGuide.depth.md#compolyx.ExtrusionGuide.depth) | intensity for the propagation of mesh corrections, depth=1 leads to a linear decay from the guide to the radius, depth<1 leads to more local corrections | -| [`ExtrusionGuide.direction`](compolyx.ExtrusionGuide.direction.md#compolyx.ExtrusionGuide.direction) | extrusion direction | -| [`ExtrusionGuide.edge_set`](compolyx.ExtrusionGuide.edge_set.md#compolyx.ExtrusionGuide.edge_set) | Associated EdgeSet. | -| [`ExtrusionGuide.enabled`](compolyx.ExtrusionGuide.enabled.md#compolyx.ExtrusionGuide.enabled) | Whether this object is currently enabled or not. | +| [`ExtrusionGuide.cad_geometry`](compolyx.ExtrusionGuide.cad_geometry.md#compolyx.ExtrusionGuide.cad_geometry) | Associated CADGeometry | +| [`ExtrusionGuide.depth`](compolyx.ExtrusionGuide.depth.md#compolyx.ExtrusionGuide.depth) | Intensity for the propagation of mesh corrections, depth=1 leads to a linear decay from the guide to the radius, depth<1 leads to more local corrections | +| [`ExtrusionGuide.direction`](compolyx.ExtrusionGuide.direction.md#compolyx.ExtrusionGuide.direction) | Extrusion direction | +| [`ExtrusionGuide.edge_set`](compolyx.ExtrusionGuide.edge_set.md#compolyx.ExtrusionGuide.edge_set) | Associated EdgeSet | +| [`ExtrusionGuide.enabled`](compolyx.ExtrusionGuide.enabled.md#compolyx.ExtrusionGuide.enabled) | Whether this object is currently enabled or not | | [`ExtrusionGuide.id`](compolyx.ExtrusionGuide.id.md#compolyx.ExtrusionGuide.id) | ID of object | -| [`ExtrusionGuide.is_dict_item`](compolyx.ExtrusionGuide.is_dict_item.md#compolyx.ExtrusionGuide.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ExtrusionGuide.is_list_item`](compolyx.ExtrusionGuide.is_list_item.md#compolyx.ExtrusionGuide.is_list_item) | Specifies wether the object is an item of a list | +| [`ExtrusionGuide.is_dict_item`](compolyx.ExtrusionGuide.is_dict_item.md#compolyx.ExtrusionGuide.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ExtrusionGuide.is_list_item`](compolyx.ExtrusionGuide.is_list_item.md#compolyx.ExtrusionGuide.is_list_item) | Specifies whether the object is an item of a list | | [`ExtrusionGuide.link_path`](compolyx.ExtrusionGuide.link_path.md#compolyx.ExtrusionGuide.link_path) | Root path of the current node in the tree for links to this object | | [`ExtrusionGuide.name`](compolyx.ExtrusionGuide.name.md#compolyx.ExtrusionGuide.name) | Name of object | | [`ExtrusionGuide.parent`](compolyx.ExtrusionGuide.parent.md#compolyx.ExtrusionGuide.parent) | Parent object in tree | -| [`ExtrusionGuide.radius`](compolyx.ExtrusionGuide.radius.md#compolyx.ExtrusionGuide.radius) | radius up to which nodal guide translations are propagated through the mesh | +| [`ExtrusionGuide.radius`](compolyx.ExtrusionGuide.radius.md#compolyx.ExtrusionGuide.radius) | Radius up to which nodal guide translations are propagated through the mesh | | [`ExtrusionGuide.root_path`](compolyx.ExtrusionGuide.root_path.md#compolyx.ExtrusionGuide.root_path) | Root path of the current node in the tree | | [`ExtrusionGuide.status`](compolyx.ExtrusionGuide.status.md#compolyx.ExtrusionGuide.status) | Status of the object | -| [`ExtrusionGuide.status_changed`](compolyx.ExtrusionGuide.status_changed.md#compolyx.ExtrusionGuide.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`ExtrusionGuide.status_changed`](compolyx.ExtrusionGuide.status_changed.md#compolyx.ExtrusionGuide.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`ExtrusionGuide.uid`](compolyx.ExtrusionGuide.uid.md#compolyx.ExtrusionGuide.uid) | UID of object | -| [`ExtrusionGuide.use_curvature_correction`](compolyx.ExtrusionGuide.use_curvature_correction.md#compolyx.ExtrusionGuide.use_curvature_correction) | whether to use curvature correction algorithm to smooth mesh adapted to extrusion guide. | -| [`ExtrusionGuide.vertex`](compolyx.ExtrusionGuide.vertex.md#compolyx.ExtrusionGuide.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ExtrusionGuide.use_curvature_correction`](compolyx.ExtrusionGuide.use_curvature_correction.md#compolyx.ExtrusionGuide.use_curvature_correction) | Whether to use curvature correction algorithm to smooth mesh adapted to extrusion guide | +| [`ExtrusionGuide.vertex`](compolyx.ExtrusionGuide.vertex.md#compolyx.ExtrusionGuide.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ExtrusionGuide.find_parent`](compolyx.ExtrusionGuide.find_parent.md#compolyx.ExtrusionGuide.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`ExtrusionGuide.find_parent`](compolyx.ExtrusionGuide.find_parent.md#compolyx.ExtrusionGuide.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`ExtrusionGuide.from_obj`](compolyx.ExtrusionGuide.from_obj.md#compolyx.ExtrusionGuide.from_obj)(obj, org_obj) | | -| [`ExtrusionGuide.obj_exists`](compolyx.ExtrusionGuide.obj_exists.md#compolyx.ExtrusionGuide.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. | +| [`ExtrusionGuide.obj_exists`](compolyx.ExtrusionGuide.obj_exists.md#compolyx.ExtrusionGuide.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 | | [`ExtrusionGuide.serialize`](compolyx.ExtrusionGuide.serialize.md#compolyx.ExtrusionGuide.serialize)() | | -| [`ExtrusionGuide.serialize_name_and_id`](compolyx.ExtrusionGuide.serialize_name_and_id.md#compolyx.ExtrusionGuide.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ExtrusionGuide.serialize_name_and_id`](compolyx.ExtrusionGuide.serialize_name_and_id.md#compolyx.ExtrusionGuide.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ExtrusionGuide.update`](compolyx.ExtrusionGuide.update.md#compolyx.ExtrusionGuide.update)() | | -| [`ExtrusionGuide.visit`](compolyx.ExtrusionGuide.visit.md#compolyx.ExtrusionGuide.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ExtrusionGuide.visit`](compolyx.ExtrusionGuide.visit.md#compolyx.ExtrusionGuide.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.obj_exists.md index 22c5f089d2..d83d170609 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.obj_exists.md @@ -4,5 +4,5 @@ #### ExtrusionGuide.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.use_curvature_correction.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.use_curvature_correction.md index abaf53ba65..7a40be1aab 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.use_curvature_correction.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.use_curvature_correction.md @@ -4,4 +4,4 @@ #### *property* ExtrusionGuide.use_curvature_correction -whether to use curvature correction algorithm to smooth mesh adapted to extrusion guide. Default is False +whether to use curvature correction algorithm to smooth mesh adapted to extrusion guide. Default is False. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.visit.md index 31b5b1ac34..b08192f6f9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ExtrusionGuide.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.clt_query.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.clt_query.md index 6b78e6920e..9b40abe13e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.clt_query.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.clt_query.md @@ -4,7 +4,7 @@ #### Fabric.clt_query(query='laminate_properties') -Returns the properties of the classical laminate theory: +Returns the properties of the classical laminate theory. * **Parameters:** - query: Result type. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.create_plot.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.create_plot.md index 90d3c525b8..faef708ad7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.create_plot.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.create_plot.md @@ -11,7 +11,7 @@ Generates 2D plots with the results of interest. * **Options:** - layup: [‘pp’] Production plies. - polar_properties: [‘E1’,’E2’,’G12’] Polar plot of laminate stiffess. - - text_plot: [‘materials’, ‘angles’, ‘thicknesses’]. + - text_plot: [`materials`, `angles`, `thicknesses`]. * **Examples:** ```pycon >>> query={'polar_properties':['E1', 'G12'], layup:['pp'], text_plot:['materials', 'angles', 'thicknesses']} diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.cut_off_material_handling.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.cut_off_material_handling.md index 0b7c87bba2..540889c880 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.cut_off_material_handling.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.cut_off_material_handling.md @@ -4,4 +4,4 @@ #### *property* Fabric.cut_off_material_handling -Type defining how cut-off material is used in cut-off areas of this fabric. Types: [‘Computed’, ‘Global’, ‘Custom’] +Type defining how cut-off material is used in cut-off areas of this fabric. Types: [`Computed`, `Global`, `Custom`] diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.drop_off_material_handling.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.drop_off_material_handling.md index dd942d97ba..c8df896cc8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.drop_off_material_handling.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.drop_off_material_handling.md @@ -4,4 +4,4 @@ #### *property* Fabric.drop_off_material_handling -Type defining how drop-off material is used in drop-off areas of this fabric. Types: [‘Global’, ‘Custom’] +Type defining how drop-off material is used in drop-off areas of this fabric. Types: [`Global`, `Custom`] diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.enabled.md index 195227a1f4..0fd099a192 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.enabled.md @@ -4,4 +4,4 @@ #### *property* Fabric.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.ignore_for_postprocessing.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.ignore_for_postprocessing.md index 5bf4567637..b853cb17bc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.ignore_for_postprocessing.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.ignore_for_postprocessing.md @@ -4,4 +4,4 @@ #### *property* Fabric.ignore_for_postprocessing -Flag if this material is NOT post-processed. +Flag if this material is not postprocessed. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.is_dict_item.md index ab182ed2ce..a81ca8337a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* Fabric.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.is_list_item.md index ec9ab147bd..493a3e913b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.is_list_item.md @@ -4,4 +4,4 @@ #### *property* Fabric.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.md index c0f36d0c10..59c32781d6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.md @@ -10,44 +10,44 @@ Class to represent fabric. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`Fabric.active`](compolyx.Fabric.active.md#compolyx.Fabric.active) | active status of object | +| [`Fabric.active`](compolyx.Fabric.active.md#compolyx.Fabric.active) | Active status of object | | [`Fabric.area_price`](compolyx.Fabric.area_price.md#compolyx.Fabric.area_price) | Area price of fabric | | [`Fabric.area_weight`](compolyx.Fabric.area_weight.md#compolyx.Fabric.area_weight) | Area weight of fabric | -| [`Fabric.cut_off_material`](compolyx.Fabric.cut_off_material.md#compolyx.Fabric.cut_off_material) | Cut-off material used in cut-off areas of this fabric. | -| [`Fabric.cut_off_material_handling`](compolyx.Fabric.cut_off_material_handling.md#compolyx.Fabric.cut_off_material_handling) | Type defining how cut-off material is used in cut-off areas of this fabric. | -| [`Fabric.draping_material_model`](compolyx.Fabric.draping_material_model.md#compolyx.Fabric.draping_material_model) | Draping material model. | +| [`Fabric.cut_off_material`](compolyx.Fabric.cut_off_material.md#compolyx.Fabric.cut_off_material) | Cut-off material used in cut-off areas of this fabric | +| [`Fabric.cut_off_material_handling`](compolyx.Fabric.cut_off_material_handling.md#compolyx.Fabric.cut_off_material_handling) | Type defining how cut-off material is used in cut-off areas of this fabric | +| [`Fabric.draping_material_model`](compolyx.Fabric.draping_material_model.md#compolyx.Fabric.draping_material_model) | Draping material model | | [`Fabric.draping_ud_coefficient`](compolyx.Fabric.draping_ud_coefficient.md#compolyx.Fabric.draping_ud_coefficient) | UD draping coefficient | -| [`Fabric.drop_off_material`](compolyx.Fabric.drop_off_material.md#compolyx.Fabric.drop_off_material) | Drop-off material used in drop-off areas of this fabric. | -| [`Fabric.drop_off_material_handling`](compolyx.Fabric.drop_off_material_handling.md#compolyx.Fabric.drop_off_material_handling) | Type defining how drop-off material is used in drop-off areas of this fabric. | -| [`Fabric.enabled`](compolyx.Fabric.enabled.md#compolyx.Fabric.enabled) | Whether this object is currently enabled or not. | -| [`Fabric.graph_plot`](compolyx.Fabric.graph_plot.md#compolyx.Fabric.graph_plot) | Graph Plot object used to configure 2D plots. | +| [`Fabric.drop_off_material`](compolyx.Fabric.drop_off_material.md#compolyx.Fabric.drop_off_material) | Drop-off material used in drop-off areas of this fabric | +| [`Fabric.drop_off_material_handling`](compolyx.Fabric.drop_off_material_handling.md#compolyx.Fabric.drop_off_material_handling) | Type defining how drop-off material is used in drop-off areas of this fabric | +| [`Fabric.enabled`](compolyx.Fabric.enabled.md#compolyx.Fabric.enabled) | Whether this object is currently enabled or not | +| [`Fabric.graph_plot`](compolyx.Fabric.graph_plot.md#compolyx.Fabric.graph_plot) | Graph Plot object used to configure 2D plots | | [`Fabric.id`](compolyx.Fabric.id.md#compolyx.Fabric.id) | ID of object | -| [`Fabric.ignore_for_postprocessing`](compolyx.Fabric.ignore_for_postprocessing.md#compolyx.Fabric.ignore_for_postprocessing) | Flag if this material is NOT post-processed. | -| [`Fabric.is_dict_item`](compolyx.Fabric.is_dict_item.md#compolyx.Fabric.is_dict_item) | Specifies wether the object is an item of a dict | -| [`Fabric.is_list_item`](compolyx.Fabric.is_list_item.md#compolyx.Fabric.is_list_item) | Specifies wether the object is an item of a list | +| [`Fabric.ignore_for_postprocessing`](compolyx.Fabric.ignore_for_postprocessing.md#compolyx.Fabric.ignore_for_postprocessing) | Flag if this material is not postprocessed | +| [`Fabric.is_dict_item`](compolyx.Fabric.is_dict_item.md#compolyx.Fabric.is_dict_item) | Specifies whether the object is an item of a dict | +| [`Fabric.is_list_item`](compolyx.Fabric.is_list_item.md#compolyx.Fabric.is_list_item) | Specifies whether the object is an item of a list | | [`Fabric.link_path`](compolyx.Fabric.link_path.md#compolyx.Fabric.link_path) | Root path of the current node in the tree for links to this object | | [`Fabric.material`](compolyx.Fabric.material.md#compolyx.Fabric.material) | Material of the fabric | | [`Fabric.name`](compolyx.Fabric.name.md#compolyx.Fabric.name) | Name of object | | [`Fabric.parent`](compolyx.Fabric.parent.md#compolyx.Fabric.parent) | Parent object in tree | | [`Fabric.root_path`](compolyx.Fabric.root_path.md#compolyx.Fabric.root_path) | Root path of the current node in the tree | | [`Fabric.status`](compolyx.Fabric.status.md#compolyx.Fabric.status) | Status of the object | -| [`Fabric.status_changed`](compolyx.Fabric.status_changed.md#compolyx.Fabric.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`Fabric.status_changed`](compolyx.Fabric.status_changed.md#compolyx.Fabric.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`Fabric.thickness`](compolyx.Fabric.thickness.md#compolyx.Fabric.thickness) | Thickness of fabric | | [`Fabric.uid`](compolyx.Fabric.uid.md#compolyx.Fabric.uid) | UID of object | -| [`Fabric.vertex`](compolyx.Fabric.vertex.md#compolyx.Fabric.vertex) | This will throw an error if the object has been removed from the graph. | +| [`Fabric.vertex`](compolyx.Fabric.vertex.md#compolyx.Fabric.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`Fabric.capture_analysis_plot`](compolyx.Fabric.capture_analysis_plot.md#compolyx.Fabric.capture_analysis_plot)([path, size]) | Saves the 2D polar plot to a file. | -| [`Fabric.clt_query`](compolyx.Fabric.clt_query.md#compolyx.Fabric.clt_query)([query]) | Returns the properties of the classical laminate theory: | -| [`Fabric.create_plot`](compolyx.Fabric.create_plot.md#compolyx.Fabric.create_plot)([query]) | Generates 2D plots with the results of interest. | -| [`Fabric.find_parent`](compolyx.Fabric.find_parent.md#compolyx.Fabric.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`Fabric.is_constant`](compolyx.Fabric.is_constant.md#compolyx.Fabric.is_constant)() | Returns true if all engineering constants and strength limits of the assigned material are constant. | -| [`Fabric.obj_exists`](compolyx.Fabric.obj_exists.md#compolyx.Fabric.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. | -| [`Fabric.serialize`](compolyx.Fabric.serialize.md#compolyx.Fabric.serialize)() | Serialize to Python string. | -| [`Fabric.serialize_name_and_id`](compolyx.Fabric.serialize_name_and_id.md#compolyx.Fabric.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`Fabric.capture_analysis_plot`](compolyx.Fabric.capture_analysis_plot.md#compolyx.Fabric.capture_analysis_plot)([path, size]) | Saves the 2D polar plot to a file | +| [`Fabric.clt_query`](compolyx.Fabric.clt_query.md#compolyx.Fabric.clt_query)([query]) | Returns the properties of the classical laminate theory | +| [`Fabric.create_plot`](compolyx.Fabric.create_plot.md#compolyx.Fabric.create_plot)([query]) | Generates 2D plots with the results of interest | +| [`Fabric.find_parent`](compolyx.Fabric.find_parent.md#compolyx.Fabric.find_parent)(type) | Steps up the tree and returns the first parent with given type | +| [`Fabric.is_constant`](compolyx.Fabric.is_constant.md#compolyx.Fabric.is_constant)() | Returns true if all engineering constants and strength limits of the assigned material are constant | +| [`Fabric.obj_exists`](compolyx.Fabric.obj_exists.md#compolyx.Fabric.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 | +| [`Fabric.serialize`](compolyx.Fabric.serialize.md#compolyx.Fabric.serialize)() | Serialize to Python string | +| [`Fabric.serialize_name_and_id`](compolyx.Fabric.serialize_name_and_id.md#compolyx.Fabric.serialize_name_and_id)() | Helper function to serialize name and ID | | [`Fabric.update`](compolyx.Fabric.update.md#compolyx.Fabric.update)() | | -| [`Fabric.update_plot`](compolyx.Fabric.update_plot.md#compolyx.Fabric.update_plot)() | Updates the 2D plot. | -| [`Fabric.visit`](compolyx.Fabric.visit.md#compolyx.Fabric.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`Fabric.update_plot`](compolyx.Fabric.update_plot.md#compolyx.Fabric.update_plot)() | Updates the 2D plot | +| [`Fabric.visit`](compolyx.Fabric.visit.md#compolyx.Fabric.visit)(visitor) | Walk through the tree and let the visitor perform an action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.obj_exists.md index 2a561274ec..d2028ad80e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.obj_exists.md @@ -4,5 +4,5 @@ #### Fabric.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.update_plot.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.update_plot.md index 1f98ba4d61..2112e45b38 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.update_plot.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.update_plot.md @@ -6,4 +6,4 @@ Updates the 2D plot. -Note: The coupling effect is always neglected (which is anyway 0 for a single fabric). +Note that the coupling effect is always neglected (which is anyways 0 for a single fabric). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.visit.md index ae5a5663e9..bc40ac0047 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Fabric.visit.md @@ -9,7 +9,7 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter - -Returns True if the visitor returned True for at least one descendant/linked node. + - visitor: A callable which accepts a TreeNode instance as parameter +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.enabled.md index fc0af1ddf2..69ca15aefa 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.enabled.md @@ -4,4 +4,4 @@ #### *property* FieldDefinition.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.is_dict_item.md index 0b70e8146e..b4f8f7e95f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* FieldDefinition.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.is_list_item.md index c1dd1a2c88..b7f48b61be 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.is_list_item.md @@ -4,4 +4,4 @@ #### *property* FieldDefinition.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.md index 6a6c9eb231..0117fb967c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.md @@ -11,9 +11,9 @@ Class to represent field definition. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`FieldDefinition.active`](compolyx.FieldDefinition.active.md#compolyx.FieldDefinition.active) | Field Definition is active | -| [`FieldDefinition.enabled`](compolyx.FieldDefinition.enabled.md#compolyx.FieldDefinition.enabled) | Whether this object is currently enabled or not. | -| [`FieldDefinition.field_variable_name`](compolyx.FieldDefinition.field_variable_name.md#compolyx.FieldDefinition.field_variable_name) | The name of the field variable defined. | -| [`FieldDefinition.full_mapping`](compolyx.FieldDefinition.full_mapping.md#compolyx.FieldDefinition.full_mapping) | Whether the field is interpolated to the shell reference surface or to the actual ply-position by taking into account the shell offset; in solid models the interpolation takes always place at the actual ply position. | +| [`FieldDefinition.enabled`](compolyx.FieldDefinition.enabled.md#compolyx.FieldDefinition.enabled) | Whether this object is currently enabled or not | +| [`FieldDefinition.field_variable_name`](compolyx.FieldDefinition.field_variable_name.md#compolyx.FieldDefinition.field_variable_name) | The name of the field variable defined | +| [`FieldDefinition.full_mapping`](compolyx.FieldDefinition.full_mapping.md#compolyx.FieldDefinition.full_mapping) | Whether the field is interpolated to the shell reference surface or to the actual ply-position by taking into account the shell offset; in solid models the interpolation takes always place at the actual ply position | | [`FieldDefinition.id`](compolyx.FieldDefinition.id.md#compolyx.FieldDefinition.id) | ID of object | | [`FieldDefinition.is_dict_item`](compolyx.FieldDefinition.is_dict_item.md#compolyx.FieldDefinition.is_dict_item) | Specifies wether the object is an item of a dict | | [`FieldDefinition.is_list_item`](compolyx.FieldDefinition.is_list_item.md#compolyx.FieldDefinition.is_list_item) | Specifies wether the object is an item of a list | @@ -22,12 +22,12 @@ Class to represent field definition. | [`FieldDefinition.name`](compolyx.FieldDefinition.name.md#compolyx.FieldDefinition.name) | Name of object | | [`FieldDefinition.parent`](compolyx.FieldDefinition.parent.md#compolyx.FieldDefinition.parent) | Parent object in tree | | [`FieldDefinition.root_path`](compolyx.FieldDefinition.root_path.md#compolyx.FieldDefinition.root_path) | Root path of the current node in the tree | -| [`FieldDefinition.scalar_field`](compolyx.FieldDefinition.scalar_field.md#compolyx.FieldDefinition.scalar_field) | Look-up table column used with this field definition. | -| [`FieldDefinition.scope_entities`](compolyx.FieldDefinition.scope_entities.md#compolyx.FieldDefinition.scope_entities) | The entities defining the scope of the field definition. | +| [`FieldDefinition.scalar_field`](compolyx.FieldDefinition.scalar_field.md#compolyx.FieldDefinition.scalar_field) | Look-up table column used with this field definition | +| [`FieldDefinition.scope_entities`](compolyx.FieldDefinition.scope_entities.md#compolyx.FieldDefinition.scope_entities) | The entities defining the scope of the field definition | | [`FieldDefinition.status`](compolyx.FieldDefinition.status.md#compolyx.FieldDefinition.status) | Status of the object | -| [`FieldDefinition.status_changed`](compolyx.FieldDefinition.status_changed.md#compolyx.FieldDefinition.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`FieldDefinition.status_changed`](compolyx.FieldDefinition.status_changed.md#compolyx.FieldDefinition.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`FieldDefinition.uid`](compolyx.FieldDefinition.uid.md#compolyx.FieldDefinition.uid) | UID of object | -| [`FieldDefinition.vertex`](compolyx.FieldDefinition.vertex.md#compolyx.FieldDefinition.vertex) | This will throw an error if the object has been removed from the graph. | +| [`FieldDefinition.vertex`](compolyx.FieldDefinition.vertex.md#compolyx.FieldDefinition.vertex) | Throws an error if the object has been removed from the graph | ### Methods @@ -35,10 +35,10 @@ Class to represent field definition. |----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| | [`FieldDefinition.clear_field_definition`](compolyx.FieldDefinition.clear_field_definition.md#compolyx.FieldDefinition.clear_field_definition)() | | | [`FieldDefinition.clear_scope_entities`](compolyx.FieldDefinition.clear_scope_entities.md#compolyx.FieldDefinition.clear_scope_entities)() | | -| [`FieldDefinition.find_parent`](compolyx.FieldDefinition.find_parent.md#compolyx.FieldDefinition.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`FieldDefinition.find_parent`](compolyx.FieldDefinition.find_parent.md#compolyx.FieldDefinition.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`FieldDefinition.get_short_description`](compolyx.FieldDefinition.get_short_description.md#compolyx.FieldDefinition.get_short_description)() | | -| [`FieldDefinition.obj_exists`](compolyx.FieldDefinition.obj_exists.md#compolyx.FieldDefinition.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. | +| [`FieldDefinition.obj_exists`](compolyx.FieldDefinition.obj_exists.md#compolyx.FieldDefinition.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 | | [`FieldDefinition.serialize`](compolyx.FieldDefinition.serialize.md#compolyx.FieldDefinition.serialize)() | Serialize to Python string | -| [`FieldDefinition.serialize_name_and_id`](compolyx.FieldDefinition.serialize_name_and_id.md#compolyx.FieldDefinition.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`FieldDefinition.serialize_name_and_id`](compolyx.FieldDefinition.serialize_name_and_id.md#compolyx.FieldDefinition.serialize_name_and_id)() | Helper function to serialize name and ID | | [`FieldDefinition.update`](compolyx.FieldDefinition.update.md#compolyx.FieldDefinition.update)() | | -| [`FieldDefinition.visit`](compolyx.FieldDefinition.visit.md#compolyx.FieldDefinition.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`FieldDefinition.visit`](compolyx.FieldDefinition.visit.md#compolyx.FieldDefinition.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.obj_exists.md index d7ce35c161..03cc2e9551 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.obj_exists.md @@ -4,5 +4,5 @@ #### FieldDefinition.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.scope_entities.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.scope_entities.md index defb547eac..0e60abb7b9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.scope_entities.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.scope_entities.md @@ -4,4 +4,4 @@ #### *property* FieldDefinition.scope_entities -The entities defining the scope of the field definition. Allowed are Element Sets, Modeling Plies and Oriented Selection Sets. +The entities defining the scope of the field definition. Available options are Element Sets, Modeling Plies, and Oriented Selection Sets. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.visit.md index 0d68ef25b7..fbdb5e1c05 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.FieldDefinition.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.enabled.md index 0d8b312fb0..b12430aaab 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.enabled.md @@ -4,4 +4,4 @@ #### *property* GeometricalSelectionRule.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.geometrical_rule_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.geometrical_rule_type.md index b0edbfff5d..29bc5a2847 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.geometrical_rule_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.geometrical_rule_type.md @@ -4,4 +4,4 @@ #### *property* GeometricalSelectionRule.geometrical_rule_type -Geometrical rule type, valid values geometry,element_sets +Geometrical rule type. Available options: `geometry`, `element_sets` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.is_dict_item.md index 3a88465e67..3a9e241f8f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* GeometricalSelectionRule.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.is_list_item.md index 938a118309..56e43f6cdd 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.is_list_item.md @@ -4,4 +4,4 @@ #### *property* GeometricalSelectionRule.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.md index fad8ffb97f..4d648d6e1c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.md @@ -10,44 +10,44 @@ Geometrical selection rule. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`GeometricalSelectionRule.active`](compolyx.GeometricalSelectionRule.active.md#compolyx.GeometricalSelectionRule.active) | active status of object | +| [`GeometricalSelectionRule.active`](compolyx.GeometricalSelectionRule.active.md#compolyx.GeometricalSelectionRule.active) | Active status of object | | [`GeometricalSelectionRule.changed`](compolyx.GeometricalSelectionRule.changed.md#compolyx.GeometricalSelectionRule.changed) | Triggers Observable to dispatch changed message | -| [`GeometricalSelectionRule.element_sets`](compolyx.GeometricalSelectionRule.element_sets.md#compolyx.GeometricalSelectionRule.element_sets) | Element Sets for the Geometrical Selection Rule. | -| [`GeometricalSelectionRule.enabled`](compolyx.GeometricalSelectionRule.enabled.md#compolyx.GeometricalSelectionRule.enabled) | Whether this object is currently enabled or not. | -| [`GeometricalSelectionRule.extent`](compolyx.GeometricalSelectionRule.extent.md#compolyx.GeometricalSelectionRule.extent) | extent of the rule | -| [`GeometricalSelectionRule.geometrical_rule_type`](compolyx.GeometricalSelectionRule.geometrical_rule_type.md#compolyx.GeometricalSelectionRule.geometrical_rule_type) | Geometrical rule type, valid values geometry,element_sets | -| [`GeometricalSelectionRule.geometry`](compolyx.GeometricalSelectionRule.geometry.md#compolyx.GeometricalSelectionRule.geometry) | Virtual Geometry for the Geometrical Selection Rule. | +| [`GeometricalSelectionRule.element_sets`](compolyx.GeometricalSelectionRule.element_sets.md#compolyx.GeometricalSelectionRule.element_sets) | Element Sets for the Geometrical Selection Rule | +| [`GeometricalSelectionRule.enabled`](compolyx.GeometricalSelectionRule.enabled.md#compolyx.GeometricalSelectionRule.enabled) | Whether this object is currently enabled or not | +| [`GeometricalSelectionRule.extent`](compolyx.GeometricalSelectionRule.extent.md#compolyx.GeometricalSelectionRule.extent) | Extent of the rule | +| [`GeometricalSelectionRule.geometrical_rule_type`](compolyx.GeometricalSelectionRule.geometrical_rule_type.md#compolyx.GeometricalSelectionRule.geometrical_rule_type) | Geometrical rule type. Available options: geometry, element_sets | +| [`GeometricalSelectionRule.geometry`](compolyx.GeometricalSelectionRule.geometry.md#compolyx.GeometricalSelectionRule.geometry) | Virtual Geometry for the Geometrical Selection Rule | | [`GeometricalSelectionRule.id`](compolyx.GeometricalSelectionRule.id.md#compolyx.GeometricalSelectionRule.id) | ID of object | | [`GeometricalSelectionRule.in_plane_capture_tolerance`](compolyx.GeometricalSelectionRule.in_plane_capture_tolerance.md#compolyx.GeometricalSelectionRule.in_plane_capture_tolerance) | In-plane capture tolerance | -| [`GeometricalSelectionRule.include_rule_type`](compolyx.GeometricalSelectionRule.include_rule_type.md#compolyx.GeometricalSelectionRule.include_rule_type) | include type | -| [`GeometricalSelectionRule.is_dict_item`](compolyx.GeometricalSelectionRule.is_dict_item.md#compolyx.GeometricalSelectionRule.is_dict_item) | Specifies wether the object is an item of a dict | -| [`GeometricalSelectionRule.is_list_item`](compolyx.GeometricalSelectionRule.is_list_item.md#compolyx.GeometricalSelectionRule.is_list_item) | Specifies wether the object is an item of a list | +| [`GeometricalSelectionRule.include_rule_type`](compolyx.GeometricalSelectionRule.include_rule_type.md#compolyx.GeometricalSelectionRule.include_rule_type) | Include type | +| [`GeometricalSelectionRule.is_dict_item`](compolyx.GeometricalSelectionRule.is_dict_item.md#compolyx.GeometricalSelectionRule.is_dict_item) | Specifies whether the object is an item of a dict | +| [`GeometricalSelectionRule.is_list_item`](compolyx.GeometricalSelectionRule.is_list_item.md#compolyx.GeometricalSelectionRule.is_list_item) | Specifies whether the object is an item of a list | | [`GeometricalSelectionRule.link_path`](compolyx.GeometricalSelectionRule.link_path.md#compolyx.GeometricalSelectionRule.link_path) | Root path of the current node in the tree for links to this object | | [`GeometricalSelectionRule.name`](compolyx.GeometricalSelectionRule.name.md#compolyx.GeometricalSelectionRule.name) | Name of object | -| [`GeometricalSelectionRule.neg_capture_tolerance`](compolyx.GeometricalSelectionRule.neg_capture_tolerance.md#compolyx.GeometricalSelectionRule.neg_capture_tolerance) | Capture tolerance in the negative direction of the CAD surface. | +| [`GeometricalSelectionRule.neg_capture_tolerance`](compolyx.GeometricalSelectionRule.neg_capture_tolerance.md#compolyx.GeometricalSelectionRule.neg_capture_tolerance) | Capture tolerance in the negative direction of the CAD surface | | [`GeometricalSelectionRule.parent`](compolyx.GeometricalSelectionRule.parent.md#compolyx.GeometricalSelectionRule.parent) | Parent object in tree | -| [`GeometricalSelectionRule.pos_capture_tolerance`](compolyx.GeometricalSelectionRule.pos_capture_tolerance.md#compolyx.GeometricalSelectionRule.pos_capture_tolerance) | Capture tolerance in the positive direction of the CAD surface. | -| [`GeometricalSelectionRule.projection_normal`](compolyx.GeometricalSelectionRule.projection_normal.md#compolyx.GeometricalSelectionRule.projection_normal) | Projection direction used to map curves onto the shell mesh. | -| [`GeometricalSelectionRule.relative_rule_type`](compolyx.GeometricalSelectionRule.relative_rule_type.md#compolyx.GeometricalSelectionRule.relative_rule_type) | relative type | +| [`GeometricalSelectionRule.pos_capture_tolerance`](compolyx.GeometricalSelectionRule.pos_capture_tolerance.md#compolyx.GeometricalSelectionRule.pos_capture_tolerance) | Capture tolerance in the positive direction of the CAD surface | +| [`GeometricalSelectionRule.projection_normal`](compolyx.GeometricalSelectionRule.projection_normal.md#compolyx.GeometricalSelectionRule.projection_normal) | Projection direction used to map curves onto the shell mesh | +| [`GeometricalSelectionRule.relative_rule_type`](compolyx.GeometricalSelectionRule.relative_rule_type.md#compolyx.GeometricalSelectionRule.relative_rule_type) | Relative type | | [`GeometricalSelectionRule.root_path`](compolyx.GeometricalSelectionRule.root_path.md#compolyx.GeometricalSelectionRule.root_path) | Root path of the current node in the tree | | [`GeometricalSelectionRule.status`](compolyx.GeometricalSelectionRule.status.md#compolyx.GeometricalSelectionRule.status) | Status of the object | -| [`GeometricalSelectionRule.status_changed`](compolyx.GeometricalSelectionRule.status_changed.md#compolyx.GeometricalSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`GeometricalSelectionRule.status_changed`](compolyx.GeometricalSelectionRule.status_changed.md#compolyx.GeometricalSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`GeometricalSelectionRule.uid`](compolyx.GeometricalSelectionRule.uid.md#compolyx.GeometricalSelectionRule.uid) | UID of object | -| [`GeometricalSelectionRule.use_defaults`](compolyx.GeometricalSelectionRule.use_defaults.md#compolyx.GeometricalSelectionRule.use_defaults) | Whether to use the offset value of the CAD Geometry or not. | -| [`GeometricalSelectionRule.use_projection_normal`](compolyx.GeometricalSelectionRule.use_projection_normal.md#compolyx.GeometricalSelectionRule.use_projection_normal) | Whether to use a projection normal for outlines or not. | -| [`GeometricalSelectionRule.vertex`](compolyx.GeometricalSelectionRule.vertex.md#compolyx.GeometricalSelectionRule.vertex) | This will throw an error if the object has been removed from the graph. | +| [`GeometricalSelectionRule.use_defaults`](compolyx.GeometricalSelectionRule.use_defaults.md#compolyx.GeometricalSelectionRule.use_defaults) | Whether to use the offset value of the CAD Geometry or not | +| [`GeometricalSelectionRule.use_projection_normal`](compolyx.GeometricalSelectionRule.use_projection_normal.md#compolyx.GeometricalSelectionRule.use_projection_normal) | Whether to use a projection normal for outlines or not | +| [`GeometricalSelectionRule.vertex`](compolyx.GeometricalSelectionRule.vertex.md#compolyx.GeometricalSelectionRule.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`GeometricalSelectionRule.add_element_set`](compolyx.GeometricalSelectionRule.add_element_set.md#compolyx.GeometricalSelectionRule.add_element_set)(...) | Add element set to GeometricalSelection rule. | -| [`GeometricalSelectionRule.clear_element_sets`](compolyx.GeometricalSelectionRule.clear_element_sets.md#compolyx.GeometricalSelectionRule.clear_element_sets)() | Clear element sets of oriented selection set. | -| [`GeometricalSelectionRule.find_parent`](compolyx.GeometricalSelectionRule.find_parent.md#compolyx.GeometricalSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`GeometricalSelectionRule.add_element_set`](compolyx.GeometricalSelectionRule.add_element_set.md#compolyx.GeometricalSelectionRule.add_element_set)(...) | Add element set to GeometricalSelection rule | +| [`GeometricalSelectionRule.clear_element_sets`](compolyx.GeometricalSelectionRule.clear_element_sets.md#compolyx.GeometricalSelectionRule.clear_element_sets)() | Clear element sets of oriented selection set | +| [`GeometricalSelectionRule.find_parent`](compolyx.GeometricalSelectionRule.find_parent.md#compolyx.GeometricalSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`GeometricalSelectionRule.get_short_description`](compolyx.GeometricalSelectionRule.get_short_description.md#compolyx.GeometricalSelectionRule.get_short_description)() | | -| [`GeometricalSelectionRule.obj_exists`](compolyx.GeometricalSelectionRule.obj_exists.md#compolyx.GeometricalSelectionRule.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. | -| [`GeometricalSelectionRule.serialize`](compolyx.GeometricalSelectionRule.serialize.md#compolyx.GeometricalSelectionRule.serialize)() | Serialize to Python string. | -| [`GeometricalSelectionRule.serialize_name_and_id`](compolyx.GeometricalSelectionRule.serialize_name_and_id.md#compolyx.GeometricalSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`GeometricalSelectionRule.obj_exists`](compolyx.GeometricalSelectionRule.obj_exists.md#compolyx.GeometricalSelectionRule.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 | +| [`GeometricalSelectionRule.serialize`](compolyx.GeometricalSelectionRule.serialize.md#compolyx.GeometricalSelectionRule.serialize)() | Serialize to Python string | +| [`GeometricalSelectionRule.serialize_name_and_id`](compolyx.GeometricalSelectionRule.serialize_name_and_id.md#compolyx.GeometricalSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID | | [`GeometricalSelectionRule.serialize_rule_types`](compolyx.GeometricalSelectionRule.serialize_rule_types.md#compolyx.GeometricalSelectionRule.serialize_rule_types)() | | | [`GeometricalSelectionRule.update`](compolyx.GeometricalSelectionRule.update.md#compolyx.GeometricalSelectionRule.update)() | | -| [`GeometricalSelectionRule.visit`](compolyx.GeometricalSelectionRule.visit.md#compolyx.GeometricalSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`GeometricalSelectionRule.visit`](compolyx.GeometricalSelectionRule.visit.md#compolyx.GeometricalSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.obj_exists.md index 5ed005efde..7d7fd23c64 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.obj_exists.md @@ -4,5 +4,5 @@ #### GeometricalSelectionRule.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.visit.md index e770dc3b93..c8293b6bd6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.GeometricalSelectionRule.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.enabled.md index fc9c8480f4..472571ae7d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.enabled.md @@ -4,4 +4,4 @@ #### *property* ImportedAnalysisPly.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.is_dict_item.md index 89dede818c..d2ba57f456 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ImportedAnalysisPly.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.is_list_item.md index 8443616561..1c20e0d961 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ImportedAnalysisPly.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.md index 70ff617fea..2d1cf3751f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.md @@ -10,13 +10,13 @@ Class to represent an imported modeling ply. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`ImportedAnalysisPly.active`](compolyx.ImportedAnalysisPly.active.md#compolyx.ImportedAnalysisPly.active) | active status of object | +| [`ImportedAnalysisPly.active`](compolyx.ImportedAnalysisPly.active.md#compolyx.ImportedAnalysisPly.active) | Active status of object | | [`ImportedAnalysisPly.active_in_post_mode`](compolyx.ImportedAnalysisPly.active_in_post_mode.md#compolyx.ImportedAnalysisPly.active_in_post_mode) | Whether ply is active in ACP Post | | [`ImportedAnalysisPly.angle`](compolyx.ImportedAnalysisPly.angle.md#compolyx.ImportedAnalysisPly.angle) | Ply Angle | -| [`ImportedAnalysisPly.enabled`](compolyx.ImportedAnalysisPly.enabled.md#compolyx.ImportedAnalysisPly.enabled) | Whether this object is currently enabled or not. | +| [`ImportedAnalysisPly.enabled`](compolyx.ImportedAnalysisPly.enabled.md#compolyx.ImportedAnalysisPly.enabled) | Whether this object is currently enabled or not | | [`ImportedAnalysisPly.id`](compolyx.ImportedAnalysisPly.id.md#compolyx.ImportedAnalysisPly.id) | ID of object | -| [`ImportedAnalysisPly.is_dict_item`](compolyx.ImportedAnalysisPly.is_dict_item.md#compolyx.ImportedAnalysisPly.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ImportedAnalysisPly.is_list_item`](compolyx.ImportedAnalysisPly.is_list_item.md#compolyx.ImportedAnalysisPly.is_list_item) | Specifies wether the object is an item of a list | +| [`ImportedAnalysisPly.is_dict_item`](compolyx.ImportedAnalysisPly.is_dict_item.md#compolyx.ImportedAnalysisPly.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ImportedAnalysisPly.is_list_item`](compolyx.ImportedAnalysisPly.is_list_item.md#compolyx.ImportedAnalysisPly.is_list_item) | Specifies whether the object is an item of a list | | [`ImportedAnalysisPly.link_path`](compolyx.ImportedAnalysisPly.link_path.md#compolyx.ImportedAnalysisPly.link_path) | Root path of the current node in the tree for links to this object | | [`ImportedAnalysisPly.material`](compolyx.ImportedAnalysisPly.material.md#compolyx.ImportedAnalysisPly.material) | Ply material | | [`ImportedAnalysisPly.mesh`](compolyx.ImportedAnalysisPly.mesh.md#compolyx.ImportedAnalysisPly.mesh) | | @@ -27,15 +27,15 @@ Class to represent an imported modeling ply. | [`ImportedAnalysisPly.status_changed`](compolyx.ImportedAnalysisPly.status_changed.md#compolyx.ImportedAnalysisPly.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | | [`ImportedAnalysisPly.thickness`](compolyx.ImportedAnalysisPly.thickness.md#compolyx.ImportedAnalysisPly.thickness) | Average ply thickness | | [`ImportedAnalysisPly.uid`](compolyx.ImportedAnalysisPly.uid.md#compolyx.ImportedAnalysisPly.uid) | UID of object | -| [`ImportedAnalysisPly.vertex`](compolyx.ImportedAnalysisPly.vertex.md#compolyx.ImportedAnalysisPly.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ImportedAnalysisPly.vertex`](compolyx.ImportedAnalysisPly.vertex.md#compolyx.ImportedAnalysisPly.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ImportedAnalysisPly.find_parent`](compolyx.ImportedAnalysisPly.find_parent.md#compolyx.ImportedAnalysisPly.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`ImportedAnalysisPly.is_reinforcing`](compolyx.ImportedAnalysisPly.is_reinforcing.md#compolyx.ImportedAnalysisPly.is_reinforcing)() | True if the AnalysisPly is a reinforcing ply. | -| [`ImportedAnalysisPly.obj_exists`](compolyx.ImportedAnalysisPly.obj_exists.md#compolyx.ImportedAnalysisPly.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. | -| [`ImportedAnalysisPly.serialize_name_and_id`](compolyx.ImportedAnalysisPly.serialize_name_and_id.md#compolyx.ImportedAnalysisPly.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ImportedAnalysisPly.find_parent`](compolyx.ImportedAnalysisPly.find_parent.md#compolyx.ImportedAnalysisPly.find_parent)(type) | Steps up the tree and returns the first parent with given type | +| [`ImportedAnalysisPly.is_reinforcing`](compolyx.ImportedAnalysisPly.is_reinforcing.md#compolyx.ImportedAnalysisPly.is_reinforcing)() | True if the AnalysisPly is a reinforcing ply | +| [`ImportedAnalysisPly.obj_exists`](compolyx.ImportedAnalysisPly.obj_exists.md#compolyx.ImportedAnalysisPly.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 | +| [`ImportedAnalysisPly.serialize_name_and_id`](compolyx.ImportedAnalysisPly.serialize_name_and_id.md#compolyx.ImportedAnalysisPly.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ImportedAnalysisPly.update`](compolyx.ImportedAnalysisPly.update.md#compolyx.ImportedAnalysisPly.update)() | | -| [`ImportedAnalysisPly.visit`](compolyx.ImportedAnalysisPly.visit.md#compolyx.ImportedAnalysisPly.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ImportedAnalysisPly.visit`](compolyx.ImportedAnalysisPly.visit.md#compolyx.ImportedAnalysisPly.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.obj_exists.md index b604b9bfb3..bd48824704 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.obj_exists.md @@ -4,5 +4,5 @@ #### ImportedAnalysisPly.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.visit.md index 2003d176f3..305d13641e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedAnalysisPly.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.create_imported_modeling_ply.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.create_imported_modeling_ply.md index e0ae755972..27156a7feb 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.create_imported_modeling_ply.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.create_imported_modeling_ply.md @@ -13,20 +13,19 @@ Create modeling ply. - offset: whether the mesh defines the bottom, middle, or top surface of the ply. - ply_material: Ply material (fabric). - ply_angle: Angle of the ply material. - - mesh_import_type: The source of the imported mesh (‘from_h5_composite_cae’ or ‘from_geometry’). + - mesh_import_type: The source of the imported mesh (`from_h5_composite_cae` or `from_geometry`). - mesh_geometry: If mesh_import_type is from_geometry, then this geometry defines the surface of the ply. - - rosette_selection_method: Method to calculate element orientation. Valid options: ‘minimum_angle’, ‘maximum_angle’, ‘minimum_distance’, - : ‘minimum_angle_superposed’, ‘minimum_distance_superposed’, - ‘maximum_angle_superposed’, ‘ansys_classic’, and - ‘tabular_values’. + - rosette_selection_method: Method to calculate element orientation. Available options: `minimum_angle`, `maximum_angle`, `minimum_distance`, `minimum_angle_superposed`, `minimum_distance_superposed`, + `maximum_angle_superposed`, `ansys_classic`, and + `tabular_values`. - rosettes: Rosettes for the imported modeling ply. - - reference_direction_field: Table column used to compute reference directions. Only needed if rosette_selection_method is tabular_values. + - reference_direction_field: Table column used to compute reference directions. Only needed if rosette_selection_method is `tabular_values`. - thickness_definition: Enum that describes the method used for thickness definition (the default is nominal). - - thickness_field: Look-Up table column with scalar values for thickness sampling (optional). - - thickness_field_type: The type of thickness field (‘absolute’ or ‘relative’). - - draping: The type of draping to be used (“no_draping” or “tabular_values”). - - angle_1_field: Look-Up table column with scalar values for angle 1. - - angle_2_field: Look-Up table column with scalar values for angle 2. + - thickness_field: Lookup table column with scalar values for thickness sampling (optional). + - thickness_field_type: The type of thickness field (`absolute` or `relative`). + - draping: The type of draping to be used (`no_draping` or `tabular_values`). + - angle_1_field: Lookup table column with scalar values for angle 1. + - angle_2_field: Lookup table column with scalar values for angle 2. - rotation_angle: Angle to rotate the reference directions (in degree). * **Returns:** The created imported modeling ply. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.md index b897fa6518..04596c919c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.md @@ -8,11 +8,11 @@ | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`ImportedModelingGroup.active`](compolyx.ImportedModelingGroup.active.md#compolyx.ImportedModelingGroup.active) | active status of object | -| [`ImportedModelingGroup.enabled`](compolyx.ImportedModelingGroup.enabled.md#compolyx.ImportedModelingGroup.enabled) | Whether this object is currently enabled or not. | +| [`ImportedModelingGroup.active`](compolyx.ImportedModelingGroup.active.md#compolyx.ImportedModelingGroup.active) | Active status of object | +| [`ImportedModelingGroup.enabled`](compolyx.ImportedModelingGroup.enabled.md#compolyx.ImportedModelingGroup.enabled) | Whether this object is currently enabled or not | | [`ImportedModelingGroup.id`](compolyx.ImportedModelingGroup.id.md#compolyx.ImportedModelingGroup.id) | ID of object | -| [`ImportedModelingGroup.is_dict_item`](compolyx.ImportedModelingGroup.is_dict_item.md#compolyx.ImportedModelingGroup.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ImportedModelingGroup.is_list_item`](compolyx.ImportedModelingGroup.is_list_item.md#compolyx.ImportedModelingGroup.is_list_item) | Specifies wether the object is an item of a list | +| [`ImportedModelingGroup.is_dict_item`](compolyx.ImportedModelingGroup.is_dict_item.md#compolyx.ImportedModelingGroup.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ImportedModelingGroup.is_list_item`](compolyx.ImportedModelingGroup.is_list_item.md#compolyx.ImportedModelingGroup.is_list_item) | Specifies whether the object is an item of a list | | [`ImportedModelingGroup.link_path`](compolyx.ImportedModelingGroup.link_path.md#compolyx.ImportedModelingGroup.link_path) | Root path of the current node in the tree for links to this object | | [`ImportedModelingGroup.name`](compolyx.ImportedModelingGroup.name.md#compolyx.ImportedModelingGroup.name) | Name of object | | [`ImportedModelingGroup.parent`](compolyx.ImportedModelingGroup.parent.md#compolyx.ImportedModelingGroup.parent) | Parent object in tree | @@ -20,23 +20,23 @@ | [`ImportedModelingGroup.root_path`](compolyx.ImportedModelingGroup.root_path.md#compolyx.ImportedModelingGroup.root_path) | Root path of the current node in the tree | | [`ImportedModelingGroup.size`](compolyx.ImportedModelingGroup.size.md#compolyx.ImportedModelingGroup.size) | Number of entities | | [`ImportedModelingGroup.status`](compolyx.ImportedModelingGroup.status.md#compolyx.ImportedModelingGroup.status) | Status of the object | -| [`ImportedModelingGroup.status_changed`](compolyx.ImportedModelingGroup.status_changed.md#compolyx.ImportedModelingGroup.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`ImportedModelingGroup.status_changed`](compolyx.ImportedModelingGroup.status_changed.md#compolyx.ImportedModelingGroup.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`ImportedModelingGroup.uid`](compolyx.ImportedModelingGroup.uid.md#compolyx.ImportedModelingGroup.uid) | UID of object | -| [`ImportedModelingGroup.vertex`](compolyx.ImportedModelingGroup.vertex.md#compolyx.ImportedModelingGroup.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ImportedModelingGroup.vertex`](compolyx.ImportedModelingGroup.vertex.md#compolyx.ImportedModelingGroup.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ImportedModelingGroup.add`](compolyx.ImportedModelingGroup.add.md#compolyx.ImportedModelingGroup.add)(entity) | Add entity to the set. | +| [`ImportedModelingGroup.add`](compolyx.ImportedModelingGroup.add.md#compolyx.ImportedModelingGroup.add)(entity) | Add entity to the set | | [`ImportedModelingGroup.clear`](compolyx.ImportedModelingGroup.clear.md#compolyx.ImportedModelingGroup.clear)() | | -| [`ImportedModelingGroup.copy_imported_modeling_ply`](compolyx.ImportedModelingGroup.copy_imported_modeling_ply.md#compolyx.ImportedModelingGroup.copy_imported_modeling_ply)(source) | Copy an imported modeling ply. | -| [`ImportedModelingGroup.create_imported_modeling_ply`](compolyx.ImportedModelingGroup.create_imported_modeling_ply.md#compolyx.ImportedModelingGroup.create_imported_modeling_ply)([...]) | Create modeling ply. | -| [`ImportedModelingGroup.find_parent`](compolyx.ImportedModelingGroup.find_parent.md#compolyx.ImportedModelingGroup.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`ImportedModelingGroup.copy_imported_modeling_ply`](compolyx.ImportedModelingGroup.copy_imported_modeling_ply.md#compolyx.ImportedModelingGroup.copy_imported_modeling_ply)(source) | Copy an imported modeling ply | +| [`ImportedModelingGroup.create_imported_modeling_ply`](compolyx.ImportedModelingGroup.create_imported_modeling_ply.md#compolyx.ImportedModelingGroup.create_imported_modeling_ply)([...]) | Create modeling ply | +| [`ImportedModelingGroup.find_parent`](compolyx.ImportedModelingGroup.find_parent.md#compolyx.ImportedModelingGroup.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`ImportedModelingGroup.is_imported`](compolyx.ImportedModelingGroup.is_imported.md#compolyx.ImportedModelingGroup.is_imported)() | | -| [`ImportedModelingGroup.obj_exists`](compolyx.ImportedModelingGroup.obj_exists.md#compolyx.ImportedModelingGroup.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. | -| [`ImportedModelingGroup.remove`](compolyx.ImportedModelingGroup.remove.md#compolyx.ImportedModelingGroup.remove)(entity) | Remove entity from the set. | -| [`ImportedModelingGroup.serialize_name_and_id`](compolyx.ImportedModelingGroup.serialize_name_and_id.md#compolyx.ImportedModelingGroup.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ImportedModelingGroup.obj_exists`](compolyx.ImportedModelingGroup.obj_exists.md#compolyx.ImportedModelingGroup.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 | +| [`ImportedModelingGroup.remove`](compolyx.ImportedModelingGroup.remove.md#compolyx.ImportedModelingGroup.remove)(entity) | Remove entity from the set | +| [`ImportedModelingGroup.serialize_name_and_id`](compolyx.ImportedModelingGroup.serialize_name_and_id.md#compolyx.ImportedModelingGroup.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ImportedModelingGroup.sync_plies`](compolyx.ImportedModelingGroup.sync_plies.md#compolyx.ImportedModelingGroup.sync_plies)() | | | [`ImportedModelingGroup.update`](compolyx.ImportedModelingGroup.update.md#compolyx.ImportedModelingGroup.update)() | | -| [`ImportedModelingGroup.visit`](compolyx.ImportedModelingGroup.visit.md#compolyx.ImportedModelingGroup.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ImportedModelingGroup.visit`](compolyx.ImportedModelingGroup.visit.md#compolyx.ImportedModelingGroup.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.obj_exists.md index c4c516457f..9e1d1b2508 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.obj_exists.md @@ -4,5 +4,5 @@ #### ImportedModelingGroup.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.visit.md index a9071bf4cf..be522d693c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingGroup.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.enabled.md index 200b14d174..4086d9c408 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.enabled.md @@ -4,4 +4,4 @@ #### *property* ImportedModelingPly.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.is_dict_item.md index 0a7c2c61ff..44d866d401 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ImportedModelingPly.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.is_list_item.md index 578475e4cb..906e92baa7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ImportedModelingPly.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.md index 02322ed1ac..001636afdf 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.md @@ -8,25 +8,25 @@ | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------| -| [`ImportedModelingPly.active`](compolyx.ImportedModelingPly.active.md#compolyx.ImportedModelingPly.active) | Whether the ply is active or surpressed. | +| [`ImportedModelingPly.active`](compolyx.ImportedModelingPly.active.md#compolyx.ImportedModelingPly.active) | Whether the ply is active or surpressed | | [`ImportedModelingPly.angle_1_field`](compolyx.ImportedModelingPly.angle_1_field.md#compolyx.ImportedModelingPly.angle_1_field) | Angle 1 Correction field | | [`ImportedModelingPly.angle_2_field`](compolyx.ImportedModelingPly.angle_2_field.md#compolyx.ImportedModelingPly.angle_2_field) | Angle 2 Correction field | | [`ImportedModelingPly.draping`](compolyx.ImportedModelingPly.draping.md#compolyx.ImportedModelingPly.draping) | Type of draping to be used | -| [`ImportedModelingPly.enabled`](compolyx.ImportedModelingPly.enabled.md#compolyx.ImportedModelingPly.enabled) | Whether this object is currently enabled or not. | +| [`ImportedModelingPly.enabled`](compolyx.ImportedModelingPly.enabled.md#compolyx.ImportedModelingPly.enabled) | Whether this object is currently enabled or not | | [`ImportedModelingPly.id`](compolyx.ImportedModelingPly.id.md#compolyx.ImportedModelingPly.id) | ID of object | -| [`ImportedModelingPly.is_dict_item`](compolyx.ImportedModelingPly.is_dict_item.md#compolyx.ImportedModelingPly.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ImportedModelingPly.is_list_item`](compolyx.ImportedModelingPly.is_list_item.md#compolyx.ImportedModelingPly.is_list_item) | Specifies wether the object is an item of a list | +| [`ImportedModelingPly.is_dict_item`](compolyx.ImportedModelingPly.is_dict_item.md#compolyx.ImportedModelingPly.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ImportedModelingPly.is_list_item`](compolyx.ImportedModelingPly.is_list_item.md#compolyx.ImportedModelingPly.is_list_item) | Specifies whether the object is an item of a list | | [`ImportedModelingPly.link_path`](compolyx.ImportedModelingPly.link_path.md#compolyx.ImportedModelingPly.link_path) | Root path of the current node in the tree for links to this object | | [`ImportedModelingPly.mesh`](compolyx.ImportedModelingPly.mesh.md#compolyx.ImportedModelingPly.mesh) | | | [`ImportedModelingPly.mesh_geometry`](compolyx.ImportedModelingPly.mesh_geometry.md#compolyx.ImportedModelingPly.mesh_geometry) | Geometry that defines the mesh/surface of this ply | | [`ImportedModelingPly.mesh_import_type`](compolyx.ImportedModelingPly.mesh_import_type.md#compolyx.ImportedModelingPly.mesh_import_type) | Defines the source of the imported mesh | | [`ImportedModelingPly.name`](compolyx.ImportedModelingPly.name.md#compolyx.ImportedModelingPly.name) | Name of object | -| [`ImportedModelingPly.offset`](compolyx.ImportedModelingPly.offset.md#compolyx.ImportedModelingPly.offset) | Defines whether the imported mesh defines the bottom, middle or top surface of the ply. | +| [`ImportedModelingPly.offset`](compolyx.ImportedModelingPly.offset.md#compolyx.ImportedModelingPly.offset) | Defines whether the imported mesh defines the bottom, middle or top surface of the ply | | [`ImportedModelingPly.parent`](compolyx.ImportedModelingPly.parent.md#compolyx.ImportedModelingPly.parent) | Parent object in tree | | [`ImportedModelingPly.ply_angle`](compolyx.ImportedModelingPly.ply_angle.md#compolyx.ImportedModelingPly.ply_angle) | Ply Angle of the Imported Modeling Ply | | [`ImportedModelingPly.ply_material`](compolyx.ImportedModelingPly.ply_material.md#compolyx.ImportedModelingPly.ply_material) | Material of the Modeling Ply | | [`ImportedModelingPly.production_plies`](compolyx.ImportedModelingPly.production_plies.md#compolyx.ImportedModelingPly.production_plies) | Attached imported production plies | -| [`ImportedModelingPly.reference_direction_field`](compolyx.ImportedModelingPly.reference_direction_field.md#compolyx.ImportedModelingPly.reference_direction_field) | a look-up table column or None for external reference directions | +| [`ImportedModelingPly.reference_direction_field`](compolyx.ImportedModelingPly.reference_direction_field.md#compolyx.ImportedModelingPly.reference_direction_field) | A lookup table column or None for external reference directions | | [`ImportedModelingPly.root_path`](compolyx.ImportedModelingPly.root_path.md#compolyx.ImportedModelingPly.root_path) | Root path of the current node in the tree | | [`ImportedModelingPly.rosette_selection_method`](compolyx.ImportedModelingPly.rosette_selection_method.md#compolyx.ImportedModelingPly.rosette_selection_method) | Defines the rosette selection method | | [`ImportedModelingPly.rosettes`](compolyx.ImportedModelingPly.rosettes.md#compolyx.ImportedModelingPly.rosettes) | Rosettes of the Imported Modeling Ply. | @@ -37,15 +37,15 @@ | [`ImportedModelingPly.thickness_field`](compolyx.ImportedModelingPly.thickness_field.md#compolyx.ImportedModelingPly.thickness_field) | LookUpTable Column with tabular thicknesses or None | | [`ImportedModelingPly.thickness_field_type`](compolyx.ImportedModelingPly.thickness_field_type.md#compolyx.ImportedModelingPly.thickness_field_type) | The type of the Thickness field 'absolute' or 'relative' | | [`ImportedModelingPly.uid`](compolyx.ImportedModelingPly.uid.md#compolyx.ImportedModelingPly.uid) | UID of object | -| [`ImportedModelingPly.vertex`](compolyx.ImportedModelingPly.vertex.md#compolyx.ImportedModelingPly.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ImportedModelingPly.vertex`](compolyx.ImportedModelingPly.vertex.md#compolyx.ImportedModelingPly.vertex) | Throws an error if the object has been removed from the graph. | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ImportedModelingPly.clear_rosettes`](compolyx.ImportedModelingPly.clear_rosettes.md#compolyx.ImportedModelingPly.clear_rosettes)() | Clear rosettes of imported modeling ply. | -| [`ImportedModelingPly.find_parent`](compolyx.ImportedModelingPly.find_parent.md#compolyx.ImportedModelingPly.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`ImportedModelingPly.obj_exists`](compolyx.ImportedModelingPly.obj_exists.md#compolyx.ImportedModelingPly.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. | -| [`ImportedModelingPly.serialize_name_and_id`](compolyx.ImportedModelingPly.serialize_name_and_id.md#compolyx.ImportedModelingPly.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ImportedModelingPly.clear_rosettes`](compolyx.ImportedModelingPly.clear_rosettes.md#compolyx.ImportedModelingPly.clear_rosettes)() | Clear rosettes of imported modeling ply | +| [`ImportedModelingPly.find_parent`](compolyx.ImportedModelingPly.find_parent.md#compolyx.ImportedModelingPly.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`ImportedModelingPly.obj_exists`](compolyx.ImportedModelingPly.obj_exists.md#compolyx.ImportedModelingPly.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 | +| [`ImportedModelingPly.serialize_name_and_id`](compolyx.ImportedModelingPly.serialize_name_and_id.md#compolyx.ImportedModelingPly.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ImportedModelingPly.update`](compolyx.ImportedModelingPly.update.md#compolyx.ImportedModelingPly.update)() | | -| [`ImportedModelingPly.visit`](compolyx.ImportedModelingPly.visit.md#compolyx.ImportedModelingPly.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ImportedModelingPly.visit`](compolyx.ImportedModelingPly.visit.md#compolyx.ImportedModelingPly.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.obj_exists.md index c29f2944d1..7b3aeaa816 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.obj_exists.md @@ -4,5 +4,5 @@ #### ImportedModelingPly.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.offset.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.offset.md index d8142dd7e3..47213eadc0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.offset.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.offset.md @@ -4,4 +4,4 @@ #### *property* ImportedModelingPly.offset -Defines whether the imported mesh defines the bottom, middle or top surface of the ply. +Defines whether the imported mesh defines the bottom, middle, or top surface of the ply. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.thickness_field_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.thickness_field_type.md index 10a6508697..88bd2545f6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.thickness_field_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.thickness_field_type.md @@ -4,4 +4,4 @@ #### *property* ImportedModelingPly.thickness_field_type -The type of the Thickness field ‘absolute’ or ‘relative’ +The type of the Thickness field. Available options are `absolute` and `relative`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.visit.md index 48f537eedd..b280de0cc5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedModelingPly.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.enabled.md index 06e5a32fed..da092ecc6a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.enabled.md @@ -4,4 +4,4 @@ #### *property* ImportedProductionPly.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.is_dict_item.md index f44aa96736..9a6b934bf8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ImportedProductionPly.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.is_list_item.md index d977cef090..7928d8edc7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ImportedProductionPly.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.md index 94a3456abf..a1c62f76ab 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.md @@ -8,13 +8,13 @@ | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`ImportedProductionPly.active`](compolyx.ImportedProductionPly.active.md#compolyx.ImportedProductionPly.active) | active status of object | +| [`ImportedProductionPly.active`](compolyx.ImportedProductionPly.active.md#compolyx.ImportedProductionPly.active) | Active status of object | | [`ImportedProductionPly.analysis_plies`](compolyx.ImportedProductionPly.analysis_plies.md#compolyx.ImportedProductionPly.analysis_plies) | Analysis Plies of the Production Ply | | [`ImportedProductionPly.angle`](compolyx.ImportedProductionPly.angle.md#compolyx.ImportedProductionPly.angle) | Ply Angle of the Production Ply | -| [`ImportedProductionPly.enabled`](compolyx.ImportedProductionPly.enabled.md#compolyx.ImportedProductionPly.enabled) | Whether this object is currently enabled or not. | +| [`ImportedProductionPly.enabled`](compolyx.ImportedProductionPly.enabled.md#compolyx.ImportedProductionPly.enabled) | Whether this object is currently enabled or not | | [`ImportedProductionPly.id`](compolyx.ImportedProductionPly.id.md#compolyx.ImportedProductionPly.id) | ID of object | -| [`ImportedProductionPly.is_dict_item`](compolyx.ImportedProductionPly.is_dict_item.md#compolyx.ImportedProductionPly.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ImportedProductionPly.is_list_item`](compolyx.ImportedProductionPly.is_list_item.md#compolyx.ImportedProductionPly.is_list_item) | Specifies wether the object is an item of a list | +| [`ImportedProductionPly.is_dict_item`](compolyx.ImportedProductionPly.is_dict_item.md#compolyx.ImportedProductionPly.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ImportedProductionPly.is_list_item`](compolyx.ImportedProductionPly.is_list_item.md#compolyx.ImportedProductionPly.is_list_item) | Specifies whether the object is an item of a list | | [`ImportedProductionPly.link_path`](compolyx.ImportedProductionPly.link_path.md#compolyx.ImportedProductionPly.link_path) | Root path of the current node in the tree for links to this object | | [`ImportedProductionPly.mesh`](compolyx.ImportedProductionPly.mesh.md#compolyx.ImportedProductionPly.mesh) | | | [`ImportedProductionPly.name`](compolyx.ImportedProductionPly.name.md#compolyx.ImportedProductionPly.name) | Name of object | @@ -25,14 +25,14 @@ | [`ImportedProductionPly.status_changed`](compolyx.ImportedProductionPly.status_changed.md#compolyx.ImportedProductionPly.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | | [`ImportedProductionPly.thickness`](compolyx.ImportedProductionPly.thickness.md#compolyx.ImportedProductionPly.thickness) | Thickness of the Production Ply | | [`ImportedProductionPly.uid`](compolyx.ImportedProductionPly.uid.md#compolyx.ImportedProductionPly.uid) | UID of object | -| [`ImportedProductionPly.vertex`](compolyx.ImportedProductionPly.vertex.md#compolyx.ImportedProductionPly.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ImportedProductionPly.vertex`](compolyx.ImportedProductionPly.vertex.md#compolyx.ImportedProductionPly.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ImportedProductionPly.find_parent`](compolyx.ImportedProductionPly.find_parent.md#compolyx.ImportedProductionPly.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`ImportedProductionPly.obj_exists`](compolyx.ImportedProductionPly.obj_exists.md#compolyx.ImportedProductionPly.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. | -| [`ImportedProductionPly.serialize_name_and_id`](compolyx.ImportedProductionPly.serialize_name_and_id.md#compolyx.ImportedProductionPly.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ImportedProductionPly.find_parent`](compolyx.ImportedProductionPly.find_parent.md#compolyx.ImportedProductionPly.find_parent)(type) | Steps up the tree and returns the first parent with given type | +| [`ImportedProductionPly.obj_exists`](compolyx.ImportedProductionPly.obj_exists.md#compolyx.ImportedProductionPly.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 | +| [`ImportedProductionPly.serialize_name_and_id`](compolyx.ImportedProductionPly.serialize_name_and_id.md#compolyx.ImportedProductionPly.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ImportedProductionPly.update`](compolyx.ImportedProductionPly.update.md#compolyx.ImportedProductionPly.update)() | | -| [`ImportedProductionPly.visit`](compolyx.ImportedProductionPly.visit.md#compolyx.ImportedProductionPly.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ImportedProductionPly.visit`](compolyx.ImportedProductionPly.visit.md#compolyx.ImportedProductionPly.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.obj_exists.md index ffa470ab14..61ad3e61b1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedProductionPly.obj_exists.md @@ -4,5 +4,5 @@ #### ImportedProductionPly.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.changed.md index d859b65b9d..ac742f6eca 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.changed.md @@ -4,4 +4,4 @@ #### *property* ImportedSolidModel.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.create_layup_mapping_object.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.create_layup_mapping_object.md index 9cbae27e6c..fe488357d6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.create_layup_mapping_object.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.create_layup_mapping_object.md @@ -9,23 +9,23 @@ Create a new layup mapping object. * **Parameters:** - name: The name of the solid model. - id: The ID of the solid model. - - active : Active status of layup mapping object. - - entire_solid_mesh : If true, then the scope is all solid elements. - - solid_element_sets: Defines the scope of solid elements if entire_solid_mesh is ‘False’. + - active: Active status of layup mapping object. + - entire_solid_mesh: If true, then the scope is all solid elements. + - solid_element_sets: Defines the scope of solid elements if entire_solid_mesh is `False`. - element_sets: a list of Element Sets of the reference surface. Used to extract the plies. - - filler_material : Global filler material which is assigned to the elements without any layers. - - delete_lost_elements : If enabled, then all elements which do not intersect with the layup are deleted. - - rosette_selection_method_type : Defines how the coordinate systems are applied to the filler/lost elements. Used if the element technology is layered_element. - - base_element_rosette_selection_method_type : Defines how the coordinate systems are applied to the base solid elements. Used if the element technology is reinforcing. + - filler_material: Global filler material which is assigned to the elements without any layers. + - delete_lost_elements: If enabled, then all elements which do not intersect with the layup are deleted. + - rosette_selection_method_type: Defines how the coordinate systems are applied to the filler/lost elements. Used if the element technology is layered_element. + - base_element_rosette_selection_method_type: Defines how the coordinate systems are applied to the base solid elements. Used if the element technology is reinforcing. - element_technology: Specifies the element technology of this mapping (layered elements or reinforcings). - - scale_ply_thicknesses : Scale plies within layered solid element if they do not fill the entire element, else add void layers. - - all_plies : Whether all plies of the selected scope (element_sets) should be mapped or only specific sequences. + - scale_ply_thicknesses: Scale plies within layered solid element if they do not fill the entire element, else add void layers. + - all_plies: Whether all plies of the selected scope (element_sets) should be mapped or only specific sequences. - use_imported_plies: If selected, Imported Ply objects can be used for the mapping. Else standard Modeling Plies. - - sequences : List of Modeling Groups and/or Modeling Plies which are mapped onto the element scope. - - rosettes : List of rosettes used to orient the lost elements. Used if the element technology is layered_element. - - base_element_rosettes : List of coordinate systems used to orient the base solid elements. Used if the element technology is reinforcing. - - minimum_void_material_thickness : Specifies the minimum thickness of void layers. Default is equal to the minimum analysis ply thickness of the model. - - void_material : Global void material which is assigned to layered elements that are not fully filled with ply material. + - sequences: List of Modeling Groups and/or Modeling Plies which are mapped onto the element scope. + - rosettes: List of rosettes used to orient the lost elements. Used if the element technology is layered_element. + - base_element_rosettes: List of coordinate systems used to orient the base solid elements. Used if the element technology is reinforcing. + - minimum_void_material_thickness: Specifies the minimum thickness of void layers. Default is equal to the minimum analysis ply thickness of the model. + - void_material: Global void material which is assigned to layered elements that are not fully filled with ply material. - base_material: Specify the base material of the solids if reinforcing are used. - base_element_material_handling: Whether to remove the base material of the solids where the reinforcing intersect, or keep it. - reinforcing_stress_state: Specify the stress state of the reinforcing. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.export_skin.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.export_skin.md index b154380e36..e2ded63f4c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.export_skin.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.export_skin.md @@ -7,5 +7,5 @@ Creates a geometry file (STP or IGES) of the solid model based on the tessellated FE mesh * **Parameters:** - - path: Out file path (supported formates are: stp, step, igs and iges) - - midside_nodes: Whether to export create the tessellation based on the quadratic mesh or not, + - path: Out file path. Available formats: `stp`, `step`, `igs`, and `iges` + - midside_nodes: Whether to export create the tessellation based on the quadratic mesh. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.ext_id.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.ext_id.md index b640d08223..eaea3ca764 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.ext_id.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.ext_id.md @@ -4,4 +4,4 @@ #### *property* ImportedSolidModel.ext_id -Id of corresponding Mechanical Model within WB arhcive (ComponentID). +ID of corresponding Mechanical Model within WB arhcive (ComponentID). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.import_initial_mesh.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.import_initial_mesh.md index ea7bbd2f39..ef279de51b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.import_initial_mesh.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.import_initial_mesh.md @@ -8,4 +8,4 @@ Load the solid mesh without updating the layup mapping. The mesh is not refreshed if the solid model is already up-to-date. * **Parameters:** - - unit_system_type: the mesh is converted to the specified unit system. For instance, “mpa” or “bin” + - unit_system_type: the mesh is converted to the specified unit system. For instance, `mpa` or `bin`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.mapping_statistics.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.mapping_statistics.md index 989dd88a4d..3770d227aa 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.mapping_statistics.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.mapping_statistics.md @@ -4,4 +4,4 @@ #### ImportedSolidModel.mapping_statistics() -Returns the statistics of the layup mapping (number of elements, volumes, mass etc.) +Returns the statistics of the layup mapping (number of elements, volumes, mass, etc.) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.md index d801e0cec4..ce4cb7fe5f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.md @@ -12,29 +12,29 @@ Imported Solid Model class |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| | [`ImportedSolidModel.active`](compolyx.ImportedSolidModel.active.md#compolyx.ImportedSolidModel.active) | Solid Model is active | | [`ImportedSolidModel.analysis_plies`](compolyx.ImportedSolidModel.analysis_plies.md#compolyx.ImportedSolidModel.analysis_plies) | Analysis Plies of the Solid Model | -| [`ImportedSolidModel.changed`](compolyx.ImportedSolidModel.changed.md#compolyx.ImportedSolidModel.changed) | Status boolean. | +| [`ImportedSolidModel.changed`](compolyx.ImportedSolidModel.changed.md#compolyx.ImportedSolidModel.changed) | Status boolean | | [`ImportedSolidModel.coordinate_system_index`](compolyx.ImportedSolidModel.coordinate_system_index.md#compolyx.ImportedSolidModel.coordinate_system_index) | Coordinate System index | | [`ImportedSolidModel.cut_off_geometry_objs`](compolyx.ImportedSolidModel.cut_off_geometry_objs.md#compolyx.ImportedSolidModel.cut_off_geometry_objs) | Cut-Off Geometry objects | -| [`ImportedSolidModel.delete_bad_elements`](compolyx.ImportedSolidModel.delete_bad_elements.md#compolyx.ImportedSolidModel.delete_bad_elements) | Boolean whether to delete the erroneous elements. | -| [`ImportedSolidModel.disable_numbering_updates`](compolyx.ImportedSolidModel.disable_numbering_updates.md#compolyx.ImportedSolidModel.disable_numbering_updates) | Debug option to disable all numbering updates. | +| [`ImportedSolidModel.delete_bad_elements`](compolyx.ImportedSolidModel.delete_bad_elements.md#compolyx.ImportedSolidModel.delete_bad_elements) | Boolean whether to delete the erroneous elements | +| [`ImportedSolidModel.disable_numbering_updates`](compolyx.ImportedSolidModel.disable_numbering_updates.md#compolyx.ImportedSolidModel.disable_numbering_updates) | Debug option to disable all numbering updates | | [`ImportedSolidModel.disable_skin_components`](compolyx.ImportedSolidModel.disable_skin_components.md#compolyx.ImportedSolidModel.disable_skin_components) | Debug option to disable the creation of skin components. | | [`ImportedSolidModel.drop_hanging_nodes`](compolyx.ImportedSolidModel.drop_hanging_nodes.md#compolyx.ImportedSolidModel.drop_hanging_nodes) | If the hanging nodes are exported or dropped | | [`ImportedSolidModel.element_index`](compolyx.ImportedSolidModel.element_index.md#compolyx.ImportedSolidModel.element_index) | Element offset index | -| [`ImportedSolidModel.enabled`](compolyx.ImportedSolidModel.enabled.md#compolyx.ImportedSolidModel.enabled) | Whether this object is currently enabled or not. | -| [`ImportedSolidModel.ext_id`](compolyx.ImportedSolidModel.ext_id.md#compolyx.ImportedSolidModel.ext_id) | Id of corresponding Mechanical Model within WB arhcive (ComponentID). | -| [`ImportedSolidModel.external_file_path`](compolyx.ImportedSolidModel.external_file_path.md#compolyx.ImportedSolidModel.external_file_path) | The file path where the CAD geometry is loaded from. | +| [`ImportedSolidModel.enabled`](compolyx.ImportedSolidModel.enabled.md#compolyx.ImportedSolidModel.enabled) | Whether this object is currently enabled or not | +| [`ImportedSolidModel.ext_id`](compolyx.ImportedSolidModel.ext_id.md#compolyx.ImportedSolidModel.ext_id) | ID of corresponding Mechanical Model within WB arhcive (ComponentID) | +| [`ImportedSolidModel.external_file_path`](compolyx.ImportedSolidModel.external_file_path.md#compolyx.ImportedSolidModel.external_file_path) | The file path where the CAD geometry is loaded from | | [`ImportedSolidModel.format`](compolyx.ImportedSolidModel.format.md#compolyx.ImportedSolidModel.format) | File format of the imported mesh | -| [`ImportedSolidModel.global_cut_off_material`](compolyx.ImportedSolidModel.global_cut_off_material.md#compolyx.ImportedSolidModel.global_cut_off_material) | Global material of the cut-off elements. | +| [`ImportedSolidModel.global_cut_off_material`](compolyx.ImportedSolidModel.global_cut_off_material.md#compolyx.ImportedSolidModel.global_cut_off_material) | Global material of the cut-off elements | | [`ImportedSolidModel.id`](compolyx.ImportedSolidModel.id.md#compolyx.ImportedSolidModel.id) | ID of object | -| [`ImportedSolidModel.is_dict_item`](compolyx.ImportedSolidModel.is_dict_item.md#compolyx.ImportedSolidModel.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ImportedSolidModel.is_list_item`](compolyx.ImportedSolidModel.is_list_item.md#compolyx.ImportedSolidModel.is_list_item) | Specifies wether the object is an item of a list | +| [`ImportedSolidModel.is_dict_item`](compolyx.ImportedSolidModel.is_dict_item.md#compolyx.ImportedSolidModel.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ImportedSolidModel.is_list_item`](compolyx.ImportedSolidModel.is_list_item.md#compolyx.ImportedSolidModel.is_list_item) | Specifies whether the object is an item of a list | | [`ImportedSolidModel.is_uptodate`](compolyx.ImportedSolidModel.is_uptodate.md#compolyx.ImportedSolidModel.is_uptodate) | Update status of the object | | [`ImportedSolidModel.layup_mapping_objects`](compolyx.ImportedSolidModel.layup_mapping_objects.md#compolyx.ImportedSolidModel.layup_mapping_objects) | Objects which define the scoping and details of each mapping step. | | [`ImportedSolidModel.link_path`](compolyx.ImportedSolidModel.link_path.md#compolyx.ImportedSolidModel.link_path) | Root path of the current node in the tree for links to this object | -| [`ImportedSolidModel.locked`](compolyx.ImportedSolidModel.locked.md#compolyx.ImportedSolidModel.locked) | Solid Model is generated from an imported source and cannot be changed. | +| [`ImportedSolidModel.locked`](compolyx.ImportedSolidModel.locked.md#compolyx.ImportedSolidModel.locked) | Solid Model is generated from an imported source and cannot be changed | | [`ImportedSolidModel.material_index`](compolyx.ImportedSolidModel.material_index.md#compolyx.ImportedSolidModel.material_index) | Material index | | [`ImportedSolidModel.mesh_components`](compolyx.ImportedSolidModel.mesh_components.md#compolyx.ImportedSolidModel.mesh_components) | Element Sets of the solid mesh | -| [`ImportedSolidModel.minimum_volume`](compolyx.ImportedSolidModel.minimum_volume.md#compolyx.ImportedSolidModel.minimum_volume) | Defines the minimum volume of each solid element. | +| [`ImportedSolidModel.minimum_volume`](compolyx.ImportedSolidModel.minimum_volume.md#compolyx.ImportedSolidModel.minimum_volume) | Defines the minimum volume of each solid element | | [`ImportedSolidModel.name`](compolyx.ImportedSolidModel.name.md#compolyx.ImportedSolidModel.name) | Name of object | | [`ImportedSolidModel.node_index`](compolyx.ImportedSolidModel.node_index.md#compolyx.ImportedSolidModel.node_index) | Node offset index | | [`ImportedSolidModel.num_coordinate_systems`](compolyx.ImportedSolidModel.num_coordinate_systems.md#compolyx.ImportedSolidModel.num_coordinate_systems) | | @@ -46,12 +46,12 @@ Imported Solid Model class | [`ImportedSolidModel.root_path`](compolyx.ImportedSolidModel.root_path.md#compolyx.ImportedSolidModel.root_path) | Root path of the current node in the tree | | [`ImportedSolidModel.section_index`](compolyx.ImportedSolidModel.section_index.md#compolyx.ImportedSolidModel.section_index) | Section offset index | | [`ImportedSolidModel.status`](compolyx.ImportedSolidModel.status.md#compolyx.ImportedSolidModel.status) | Status of the object | -| [`ImportedSolidModel.status_changed`](compolyx.ImportedSolidModel.status_changed.md#compolyx.ImportedSolidModel.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`ImportedSolidModel.transfer_all_sets`](compolyx.ImportedSolidModel.transfer_all_sets.md#compolyx.ImportedSolidModel.transfer_all_sets) | Whether to transfer all edge and element sets to the solid model or not. | -| [`ImportedSolidModel.transferred_edge_sets`](compolyx.ImportedSolidModel.transferred_edge_sets.md#compolyx.ImportedSolidModel.transferred_edge_sets) | Edge sets to transfer to solid model. | -| [`ImportedSolidModel.transferred_element_sets`](compolyx.ImportedSolidModel.transferred_element_sets.md#compolyx.ImportedSolidModel.transferred_element_sets) | Element sets to transfer to solid model. | +| [`ImportedSolidModel.status_changed`](compolyx.ImportedSolidModel.status_changed.md#compolyx.ImportedSolidModel.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`ImportedSolidModel.transfer_all_sets`](compolyx.ImportedSolidModel.transfer_all_sets.md#compolyx.ImportedSolidModel.transfer_all_sets) | Whether to transfer all edge and element sets to the solid model or not | +| [`ImportedSolidModel.transferred_edge_sets`](compolyx.ImportedSolidModel.transferred_edge_sets.md#compolyx.ImportedSolidModel.transferred_edge_sets) | Edge sets to transfer to solid model | +| [`ImportedSolidModel.transferred_element_sets`](compolyx.ImportedSolidModel.transferred_element_sets.md#compolyx.ImportedSolidModel.transferred_element_sets) | Element sets to transfer to solid model | | [`ImportedSolidModel.uid`](compolyx.ImportedSolidModel.uid.md#compolyx.ImportedSolidModel.uid) | UID of object | -| [`ImportedSolidModel.unit_system`](compolyx.ImportedSolidModel.unit_system.md#compolyx.ImportedSolidModel.unit_system) | Unit system type of the imported mesh. | +| [`ImportedSolidModel.unit_system`](compolyx.ImportedSolidModel.unit_system.md#compolyx.ImportedSolidModel.unit_system) | Unit system type of the imported mesh | | [`ImportedSolidModel.use_default_coordinate_system_index`](compolyx.ImportedSolidModel.use_default_coordinate_system_index.md#compolyx.ImportedSolidModel.use_default_coordinate_system_index) | Use consecutive coordinate system numbering | | [`ImportedSolidModel.use_default_element_index`](compolyx.ImportedSolidModel.use_default_element_index.md#compolyx.ImportedSolidModel.use_default_element_index) | Use consecutive element numbering | | [`ImportedSolidModel.use_default_material_index`](compolyx.ImportedSolidModel.use_default_material_index.md#compolyx.ImportedSolidModel.use_default_material_index) | Use consecutive material numbering | @@ -59,37 +59,37 @@ Imported Solid Model class | [`ImportedSolidModel.use_default_section_index`](compolyx.ImportedSolidModel.use_default_section_index.md#compolyx.ImportedSolidModel.use_default_section_index) | Use consecutive section numbering | | [`ImportedSolidModel.use_solid_model_prefix`](compolyx.ImportedSolidModel.use_solid_model_prefix.md#compolyx.ImportedSolidModel.use_solid_model_prefix) | If the solid model name is used as a prefix for all components exported to the \*cdb file | | [`ImportedSolidModel.use_solsh_elements`](compolyx.ImportedSolidModel.use_solsh_elements.md#compolyx.ImportedSolidModel.use_solsh_elements) | If selected solid-shell elements are written to the \*cdb file | -| [`ImportedSolidModel.vertex`](compolyx.ImportedSolidModel.vertex.md#compolyx.ImportedSolidModel.vertex) | This will throw an error if the object has been removed from the graph. | -| [`ImportedSolidModel.warping_limit`](compolyx.ImportedSolidModel.warping_limit.md#compolyx.ImportedSolidModel.warping_limit) | Defines the maximum allowable warping limit. | +| [`ImportedSolidModel.vertex`](compolyx.ImportedSolidModel.vertex.md#compolyx.ImportedSolidModel.vertex) | This will throw an error if the object has been removed from the graph | +| [`ImportedSolidModel.warping_limit`](compolyx.ImportedSolidModel.warping_limit.md#compolyx.ImportedSolidModel.warping_limit) | Defines the maximum allowable warping limit | | [`ImportedSolidModel.write_degenerated_elements`](compolyx.ImportedSolidModel.write_degenerated_elements.md#compolyx.ImportedSolidModel.write_degenerated_elements) | If set to false no drop-off and cut-off elements are written to the \*cdb file | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ImportedSolidModel.clear_generated_data`](compolyx.ImportedSolidModel.clear_generated_data.md#compolyx.ImportedSolidModel.clear_generated_data)() | Function clears generated solid model but keeps all definitions. | +| [`ImportedSolidModel.clear_generated_data`](compolyx.ImportedSolidModel.clear_generated_data.md#compolyx.ImportedSolidModel.clear_generated_data)() | Function clears generated solid model but keeps all definitions | | [`ImportedSolidModel.copy_cut_off_geometry_obj`](compolyx.ImportedSolidModel.copy_cut_off_geometry_obj.md#compolyx.ImportedSolidModel.copy_cut_off_geometry_obj)(source) | Copy a Cut-Off Geometry | -| [`ImportedSolidModel.copy_layup_mapping_object`](compolyx.ImportedSolidModel.copy_layup_mapping_object.md#compolyx.ImportedSolidModel.copy_layup_mapping_object)(source) | Copy a Layup Mapping object. | -| [`ImportedSolidModel.create_cut_off_geometry_obj`](compolyx.ImportedSolidModel.create_cut_off_geometry_obj.md#compolyx.ImportedSolidModel.create_cut_off_geometry_obj)(name) | Create a new cut-off geometry object. | -| [`ImportedSolidModel.create_layup_mapping_object`](compolyx.ImportedSolidModel.create_layup_mapping_object.md#compolyx.ImportedSolidModel.create_layup_mapping_object)([...]) | Create a new layup mapping object. | +| [`ImportedSolidModel.copy_layup_mapping_object`](compolyx.ImportedSolidModel.copy_layup_mapping_object.md#compolyx.ImportedSolidModel.copy_layup_mapping_object)(source) | Copy a Layup Mapping object | +| [`ImportedSolidModel.create_cut_off_geometry_obj`](compolyx.ImportedSolidModel.create_cut_off_geometry_obj.md#compolyx.ImportedSolidModel.create_cut_off_geometry_obj)(name) | Create a new cut-off geometry object | +| [`ImportedSolidModel.create_layup_mapping_object`](compolyx.ImportedSolidModel.create_layup_mapping_object.md#compolyx.ImportedSolidModel.create_layup_mapping_object)([...]) | Create a new layup mapping object | | [`ImportedSolidModel.create_solid_element_set`](compolyx.ImportedSolidModel.create_solid_element_set.md#compolyx.ImportedSolidModel.create_solid_element_set)(name) | For internal use only: Creates a Solid Element Set | | [`ImportedSolidModel.export_skin`](compolyx.ImportedSolidModel.export_skin.md#compolyx.ImportedSolidModel.export_skin)(path[, ...]) | Creates a geometry file (STP or IGES) of the solid model based on the tessellated FE mesh | -| [`ImportedSolidModel.find_parent`](compolyx.ImportedSolidModel.find_parent.md#compolyx.ImportedSolidModel.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`ImportedSolidModel.find_parent`](compolyx.ImportedSolidModel.find_parent.md#compolyx.ImportedSolidModel.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`ImportedSolidModel.get_short_description`](compolyx.ImportedSolidModel.get_short_description.md#compolyx.ImportedSolidModel.get_short_description)() | | -| [`ImportedSolidModel.has_reinforcing_objects`](compolyx.ImportedSolidModel.has_reinforcing_objects.md#compolyx.ImportedSolidModel.has_reinforcing_objects)() | Boolean whether Layup Mapping objects of type reinforcing are present. | -| [`ImportedSolidModel.import_initial_mesh`](compolyx.ImportedSolidModel.import_initial_mesh.md#compolyx.ImportedSolidModel.import_initial_mesh)([...]) | Load the solid mesh without updating the layup mapping. | +| [`ImportedSolidModel.has_reinforcing_objects`](compolyx.ImportedSolidModel.has_reinforcing_objects.md#compolyx.ImportedSolidModel.has_reinforcing_objects)() | Boolean whether Layup Mapping objects of type reinforcing are present | +| [`ImportedSolidModel.import_initial_mesh`](compolyx.ImportedSolidModel.import_initial_mesh.md#compolyx.ImportedSolidModel.import_initial_mesh)([...]) | Load the solid mesh without updating the layup mapping | | [`ImportedSolidModel.mapping_statistics`](compolyx.ImportedSolidModel.mapping_statistics.md#compolyx.ImportedSolidModel.mapping_statistics)() | Returns the statistics of the layup mapping (number of elements, volumes, mass etc.) | -| [`ImportedSolidModel.obj_exists`](compolyx.ImportedSolidModel.obj_exists.md#compolyx.ImportedSolidModel.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. | -| [`ImportedSolidModel.refresh_external_source`](compolyx.ImportedSolidModel.refresh_external_source.md#compolyx.ImportedSolidModel.refresh_external_source)([...]) | Reloads the mesh from the external source. | +| [`ImportedSolidModel.obj_exists`](compolyx.ImportedSolidModel.obj_exists.md#compolyx.ImportedSolidModel.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 | +| [`ImportedSolidModel.refresh_external_source`](compolyx.ImportedSolidModel.refresh_external_source.md#compolyx.ImportedSolidModel.refresh_external_source)([...]) | Reloads the mesh from the external source | | [`ImportedSolidModel.remove_global_cut_off_material`](compolyx.ImportedSolidModel.remove_global_cut_off_material.md#compolyx.ImportedSolidModel.remove_global_cut_off_material)() | Removes the global cutoff material of the SolidModel | | [`ImportedSolidModel.remove_global_drop_off_material`](compolyx.ImportedSolidModel.remove_global_drop_off_material.md#compolyx.ImportedSolidModel.remove_global_drop_off_material)() | Removes the global dropoff material of the SolidModel | | [`ImportedSolidModel.serialize`](compolyx.ImportedSolidModel.serialize.md#compolyx.ImportedSolidModel.serialize)() | Returns the Python serialization string | -| [`ImportedSolidModel.serialize_name_and_id`](compolyx.ImportedSolidModel.serialize_name_and_id.md#compolyx.ImportedSolidModel.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ImportedSolidModel.serialize_name_and_id`](compolyx.ImportedSolidModel.serialize_name_and_id.md#compolyx.ImportedSolidModel.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ImportedSolidModel.shell_elements`](compolyx.ImportedSolidModel.shell_elements.md#compolyx.ImportedSolidModel.shell_elements)() | Function returns the shell elements where this extrusion operates on | -| [`ImportedSolidModel.solid_elements`](compolyx.ImportedSolidModel.solid_elements.md#compolyx.ImportedSolidModel.solid_elements)(...) | * **Parameters:** | +| [`ImportedSolidModel.solid_elements`](compolyx.ImportedSolidModel.solid_elements.md#compolyx.ImportedSolidModel.solid_elements)(...) | | | [`ImportedSolidModel.update`](compolyx.ImportedSolidModel.update.md#compolyx.ImportedSolidModel.update)() | | -| [`ImportedSolidModel.update_mapping_statistics`](compolyx.ImportedSolidModel.update_mapping_statistics.md#compolyx.ImportedSolidModel.update_mapping_statistics)() | Computes the mapping statistics per ply to compare the original layup with the mapped data. | -| [`ImportedSolidModel.visit`](compolyx.ImportedSolidModel.visit.md#compolyx.ImportedSolidModel.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | -| [`ImportedSolidModel.write_h5_and_cdb_file`](compolyx.ImportedSolidModel.write_h5_and_cdb_file.md#compolyx.ImportedSolidModel.write_h5_and_cdb_file)(...) | Writes the .h5 and .cdb file for ANSYS Workbench application. | +| [`ImportedSolidModel.update_mapping_statistics`](compolyx.ImportedSolidModel.update_mapping_statistics.md#compolyx.ImportedSolidModel.update_mapping_statistics)() | Computes the mapping statistics per ply to compare the original layup with the mapped data | +| [`ImportedSolidModel.visit`](compolyx.ImportedSolidModel.visit.md#compolyx.ImportedSolidModel.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | +| [`ImportedSolidModel.write_h5_and_cdb_file`](compolyx.ImportedSolidModel.write_h5_and_cdb_file.md#compolyx.ImportedSolidModel.write_h5_and_cdb_file)(...) | Writes the .h5 and .cdb file for ANSYS Workbench application | | [`ImportedSolidModel.write_lsdyna_solid_model`](compolyx.ImportedSolidModel.write_lsdyna_solid_model.md#compolyx.ImportedSolidModel.write_lsdyna_solid_model)(path) | Export solid model as FE model for LS Dyna | -| [`ImportedSolidModel.write_solid_model`](compolyx.ImportedSolidModel.write_solid_model.md#compolyx.ImportedSolidModel.write_solid_model)(path) | Export solid model as FE model for ANSYS. | +| [`ImportedSolidModel.write_solid_model`](compolyx.ImportedSolidModel.write_solid_model.md#compolyx.ImportedSolidModel.write_solid_model)(path) | Export solid model as FE model for ANSYS | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.obj_exists.md index f0976421d9..757a50f392 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.obj_exists.md @@ -4,5 +4,5 @@ #### ImportedSolidModel.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.refresh_external_source.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.refresh_external_source.md index 550d1eda2b..5955662902 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.refresh_external_source.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.refresh_external_source.md @@ -7,4 +7,4 @@ Reloads the mesh from the external source. * **Parameters:** - - enforce: enforce the reloading of external data for locked object in the new acph5 serialization format. This option should be used with care! + - enforce: enforce the reloading of external data for locked object in the new acph5 serialization format. This option should be used with care. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.solid_elements.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.solid_elements.md index 03d49c54a5..a3f6e1d245 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.solid_elements.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.solid_elements.md @@ -5,7 +5,6 @@ #### ImportedSolidModel.solid_elements(include_solver_elements) * **Parameters:** - - include_solver_elements - : the solver elements are returned for layered elements which have them. + - include_solver_elements: The solver elements are returned for layered elements which have them. * **Returns:** - A list with solid element labels of current solid model + A list with solid element labels of current solid model. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.unit_system.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.unit_system.md index 21e52d8d3a..cd3619418c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.unit_system.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.unit_system.md @@ -4,4 +4,4 @@ #### *property* ImportedSolidModel.unit_system -Unit system type of the imported mesh. Allowed string values are undefined, si, mks, umks, cgs, mpa, bft, bin +Unit system type of the imported mesh. Available string values: `undefined`, `si`, `mks`, `umks`, `cgs`, `mpa`, `bft`, `bin`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.visit.md index 17c9d3bb1d..679314e1a7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.write_lsdyna_solid_model.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.write_lsdyna_solid_model.md index d4bf6d38b2..014bb356bc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.write_lsdyna_solid_model.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.write_lsdyna_solid_model.md @@ -7,9 +7,9 @@ Export solid model as FE model for LS Dyna * **Parameters:** - - path: Out file path (file extension must be .k) - - part_number: Ls Dyna part number (default is 1) - - mat_type: LS Dyna material card type (default is ‘MAT_ENHANCED_COMPOSITE_DAMAGE’) + - path: Out file path (file extension must be `.k`) + - part_number: Ls Dyna part number (default is `1`) + - mat_type: LS Dyna material card type (default is `MAT_ENHANCED_COMPOSITE_DAMAGE`) Supported mat_types: : - ‘MAT_ENHANCED_COMPOSITE_DAMAGE’ diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.write_solid_model.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.write_solid_model.md index ac0e41524c..aa88351a6b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.write_solid_model.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ImportedSolidModel.write_solid_model.md @@ -7,4 +7,4 @@ Export solid model as FE model for ANSYS. * **Parameters:** - - path: Out file path (current supported formats are .cdb or .h5). + - path: Out file path (supported formats are `.cdb` or `.h5`). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.is_dict_item.md index 6b65c0568a..6c9f861460 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* InterfaceLayer.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.is_list_item.md index bf9ed9c9e8..6c7b0bba8f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.is_list_item.md @@ -4,4 +4,4 @@ #### *property* InterfaceLayer.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.md index 304c7a56a8..6313e61cf4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.md @@ -11,11 +11,11 @@ Class to represent interface layer. | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| | [`InterfaceLayer.active`](compolyx.InterfaceLayer.active.md#compolyx.InterfaceLayer.active) | Sequence Entity is active | -| [`InterfaceLayer.enabled`](compolyx.InterfaceLayer.enabled.md#compolyx.InterfaceLayer.enabled) | Whether this object is currently enabled. | +| [`InterfaceLayer.enabled`](compolyx.InterfaceLayer.enabled.md#compolyx.InterfaceLayer.enabled) | Whether this object is currently enabled | | [`InterfaceLayer.global_ply_nr`](compolyx.InterfaceLayer.global_ply_nr.md#compolyx.InterfaceLayer.global_ply_nr) | | | [`InterfaceLayer.id`](compolyx.InterfaceLayer.id.md#compolyx.InterfaceLayer.id) | ID of object | -| [`InterfaceLayer.is_dict_item`](compolyx.InterfaceLayer.is_dict_item.md#compolyx.InterfaceLayer.is_dict_item) | Specifies wether the object is an item of a dict | -| [`InterfaceLayer.is_list_item`](compolyx.InterfaceLayer.is_list_item.md#compolyx.InterfaceLayer.is_list_item) | Specifies wether the object is an item of a list | +| [`InterfaceLayer.is_dict_item`](compolyx.InterfaceLayer.is_dict_item.md#compolyx.InterfaceLayer.is_dict_item) | Specifies whether the object is an item of a dict | +| [`InterfaceLayer.is_list_item`](compolyx.InterfaceLayer.is_list_item.md#compolyx.InterfaceLayer.is_list_item) | Specifies whether the object is an item of a list | | [`InterfaceLayer.link_path`](compolyx.InterfaceLayer.link_path.md#compolyx.InterfaceLayer.link_path) | Root path of the current node in the tree for links to this object | | [`InterfaceLayer.name`](compolyx.InterfaceLayer.name.md#compolyx.InterfaceLayer.name) | Name of object | | [`InterfaceLayer.open_area_sets`](compolyx.InterfaceLayer.open_area_sets.md#compolyx.InterfaceLayer.open_area_sets) | Open area set(s) of the Interface Layer | @@ -24,23 +24,23 @@ Class to represent interface layer. | [`InterfaceLayer.ply_offsets`](compolyx.InterfaceLayer.ply_offsets.md#compolyx.InterfaceLayer.ply_offsets) | Get the offsetted Interface Layer | | [`InterfaceLayer.root_path`](compolyx.InterfaceLayer.root_path.md#compolyx.InterfaceLayer.root_path) | Root path of the current node in the tree | | [`InterfaceLayer.status`](compolyx.InterfaceLayer.status.md#compolyx.InterfaceLayer.status) | Status of the object | -| [`InterfaceLayer.status_changed`](compolyx.InterfaceLayer.status_changed.md#compolyx.InterfaceLayer.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`InterfaceLayer.status_changed`](compolyx.InterfaceLayer.status_changed.md#compolyx.InterfaceLayer.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`InterfaceLayer.uid`](compolyx.InterfaceLayer.uid.md#compolyx.InterfaceLayer.uid) | UID of object | -| [`InterfaceLayer.vertex`](compolyx.InterfaceLayer.vertex.md#compolyx.InterfaceLayer.vertex) | This will throw an error if the object has been removed from the graph. | +| [`InterfaceLayer.vertex`](compolyx.InterfaceLayer.vertex.md#compolyx.InterfaceLayer.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`InterfaceLayer.add_open_area_set`](compolyx.InterfaceLayer.add_open_area_set.md#compolyx.InterfaceLayer.add_open_area_set)(value) | Add open area set to interface layer. | -| [`InterfaceLayer.add_oriented_selection_set`](compolyx.InterfaceLayer.add_oriented_selection_set.md#compolyx.InterfaceLayer.add_oriented_selection_set)(...) | Add oriented selection set. | -| [`InterfaceLayer.clear_open_area_sets`](compolyx.InterfaceLayer.clear_open_area_sets.md#compolyx.InterfaceLayer.clear_open_area_sets)() | Clears the open area selection. | -| [`InterfaceLayer.clear_oriented_selection_sets`](compolyx.InterfaceLayer.clear_oriented_selection_sets.md#compolyx.InterfaceLayer.clear_oriented_selection_sets)() | Clear all oriented selection sets of the interface layer. | -| [`InterfaceLayer.find_parent`](compolyx.InterfaceLayer.find_parent.md#compolyx.InterfaceLayer.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`InterfaceLayer.obj_exists`](compolyx.InterfaceLayer.obj_exists.md#compolyx.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`](compolyx.InterfaceLayer.remove_open_area_set.md#compolyx.InterfaceLayer.remove_open_area_set)(value) | Remove open area set from interface layer. | -| [`InterfaceLayer.remove_oriented_selection_set`](compolyx.InterfaceLayer.remove_oriented_selection_set.md#compolyx.InterfaceLayer.remove_oriented_selection_set)(...) | Remove oriented selection set from interface layer. | -| [`InterfaceLayer.serialize`](compolyx.InterfaceLayer.serialize.md#compolyx.InterfaceLayer.serialize)() | Serialize to Python string. | -| [`InterfaceLayer.serialize_name_and_id`](compolyx.InterfaceLayer.serialize_name_and_id.md#compolyx.InterfaceLayer.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`InterfaceLayer.add_open_area_set`](compolyx.InterfaceLayer.add_open_area_set.md#compolyx.InterfaceLayer.add_open_area_set)(value) | Add open area set to interface layer | +| [`InterfaceLayer.add_oriented_selection_set`](compolyx.InterfaceLayer.add_oriented_selection_set.md#compolyx.InterfaceLayer.add_oriented_selection_set)(...) | Add oriented selection set | +| [`InterfaceLayer.clear_open_area_sets`](compolyx.InterfaceLayer.clear_open_area_sets.md#compolyx.InterfaceLayer.clear_open_area_sets)() | Clears the open area selection | +| [`InterfaceLayer.clear_oriented_selection_sets`](compolyx.InterfaceLayer.clear_oriented_selection_sets.md#compolyx.InterfaceLayer.clear_oriented_selection_sets)() | Clear all oriented selection sets of the interface layer | +| [`InterfaceLayer.find_parent`](compolyx.InterfaceLayer.find_parent.md#compolyx.InterfaceLayer.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`InterfaceLayer.obj_exists`](compolyx.InterfaceLayer.obj_exists.md#compolyx.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`](compolyx.InterfaceLayer.remove_open_area_set.md#compolyx.InterfaceLayer.remove_open_area_set)(value) | Remove open area set from interface layer | +| [`InterfaceLayer.remove_oriented_selection_set`](compolyx.InterfaceLayer.remove_oriented_selection_set.md#compolyx.InterfaceLayer.remove_oriented_selection_set)(...) | Remove oriented selection set from interface layer | +| [`InterfaceLayer.serialize`](compolyx.InterfaceLayer.serialize.md#compolyx.InterfaceLayer.serialize)() | Serialize to Python string | +| [`InterfaceLayer.serialize_name_and_id`](compolyx.InterfaceLayer.serialize_name_and_id.md#compolyx.InterfaceLayer.serialize_name_and_id)() | Helper function to serialize name and ID | | [`InterfaceLayer.update`](compolyx.InterfaceLayer.update.md#compolyx.InterfaceLayer.update)() | | -| [`InterfaceLayer.visit`](compolyx.InterfaceLayer.visit.md#compolyx.InterfaceLayer.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`InterfaceLayer.visit`](compolyx.InterfaceLayer.visit.md#compolyx.InterfaceLayer.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.obj_exists.md index 64cb6bf535..6a491db206 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.obj_exists.md @@ -4,5 +4,5 @@ #### InterfaceLayer.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.visit.md index 4ef599504e..0e45f5d417 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.InterfaceLayer.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.base_element_material_handling.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.base_element_material_handling.md index ab9d0c8cf0..11e4f94074 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.base_element_material_handling.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.base_element_material_handling.md @@ -4,4 +4,4 @@ #### *property* LayupMappingObject.base_element_material_handling -Whether the base-element material is removed or kept. Allowed string values: [‘retain’, ‘remove’] +Whether the base-element material is removed or kept. Available string values: [`retain`, `remove`]. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.base_element_rosette_selection_method_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.base_element_rosette_selection_method_type.md index 9f5b11d747..9fff2f76aa 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.base_element_rosette_selection_method_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.base_element_rosette_selection_method_type.md @@ -4,4 +4,4 @@ #### *property* LayupMappingObject.base_element_rosette_selection_method_type -Selection method of the coordinate systems for the base elements. Allowed string values: [‘minimum_distance’, ‘minimum_distance_superposed’] +Selection method of the coordinate systems for the base elements. Available string values: [`minimum_distance`, `minimum_distance_superposed`] diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.element_technology.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.element_technology.md index 52038f91cf..8fc2eb5f8d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.element_technology.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.element_technology.md @@ -4,4 +4,4 @@ #### *property* LayupMappingObject.element_technology -Defines the element technology. Allowed string values: [‘layered_element’, ‘reinforcing’] +Defines the element technology. Available string values: [`layered_element`, `reinforcing`]. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.is_dict_item.md index b78a890753..c1bf0a6869 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* LayupMappingObject.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.is_list_item.md index e0916b8c21..57c46a2105 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.is_list_item.md @@ -4,4 +4,4 @@ #### *property* LayupMappingObject.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.md index 23cfeb0b9f..488d36bca7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.md @@ -10,49 +10,49 @@ Layup Mapping class | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| -| [`LayupMappingObject.active`](compolyx.LayupMappingObject.active.md#compolyx.LayupMappingObject.active) | Boolean whether to this object is active or not. | -| [`LayupMappingObject.all_plies`](compolyx.LayupMappingObject.all_plies.md#compolyx.LayupMappingObject.all_plies) | Boolean whether all plies of the selected scope should be mapped or a user-defined subset. | +| [`LayupMappingObject.active`](compolyx.LayupMappingObject.active.md#compolyx.LayupMappingObject.active) | Boolean whether to this object is active or not | +| [`LayupMappingObject.all_plies`](compolyx.LayupMappingObject.all_plies.md#compolyx.LayupMappingObject.all_plies) | Boolean whether all plies of the selected scope should be mapped or a user-defined subset | | [`LayupMappingObject.analysis_plies`](compolyx.LayupMappingObject.analysis_plies.md#compolyx.LayupMappingObject.analysis_plies) | Analysis Plies of the Mapping Object | -| [`LayupMappingObject.base_element_material_handling`](compolyx.LayupMappingObject.base_element_material_handling.md#compolyx.LayupMappingObject.base_element_material_handling) | Whether the base-element material is removed or kept. | -| [`LayupMappingObject.base_element_rosette_selection_method_type`](compolyx.LayupMappingObject.base_element_rosette_selection_method_type.md#compolyx.LayupMappingObject.base_element_rosette_selection_method_type) | Selection method of the coordinate systems for the base elements. | +| [`LayupMappingObject.base_element_material_handling`](compolyx.LayupMappingObject.base_element_material_handling.md#compolyx.LayupMappingObject.base_element_material_handling) | Whether the base-element material is removed or kept | +| [`LayupMappingObject.base_element_rosette_selection_method_type`](compolyx.LayupMappingObject.base_element_rosette_selection_method_type.md#compolyx.LayupMappingObject.base_element_rosette_selection_method_type) | Selection method of the coordinate systems for the base elements | | [`LayupMappingObject.base_element_rosettes`](compolyx.LayupMappingObject.base_element_rosettes.md#compolyx.LayupMappingObject.base_element_rosettes) | List of rosettes used to orient the lost elements | -| [`LayupMappingObject.base_material`](compolyx.LayupMappingObject.base_material.md#compolyx.LayupMappingObject.base_material) | Material of base-element if reinforcing is used. | -| [`LayupMappingObject.delete_lost_elements`](compolyx.LayupMappingObject.delete_lost_elements.md#compolyx.LayupMappingObject.delete_lost_elements) | Boolean whether to delete solid elements without layup data. | -| [`LayupMappingObject.element_sets`](compolyx.LayupMappingObject.element_sets.md#compolyx.LayupMappingObject.element_sets) | Element Set(s) of the solid model. | -| [`LayupMappingObject.element_technology`](compolyx.LayupMappingObject.element_technology.md#compolyx.LayupMappingObject.element_technology) | Defines the element technology. | -| [`LayupMappingObject.enabled`](compolyx.LayupMappingObject.enabled.md#compolyx.LayupMappingObject.enabled) | Whether this object is currently enabled or not. | -| [`LayupMappingObject.entire_solid_mesh`](compolyx.LayupMappingObject.entire_solid_mesh.md#compolyx.LayupMappingObject.entire_solid_mesh) | Boolean whether the mapping object is applied to the entire solid mesh. | -| [`LayupMappingObject.filler_material`](compolyx.LayupMappingObject.filler_material.md#compolyx.LayupMappingObject.filler_material) | Filler material if layered elements are used. | +| [`LayupMappingObject.base_material`](compolyx.LayupMappingObject.base_material.md#compolyx.LayupMappingObject.base_material) | Material of base-element if reinforcing is used | +| [`LayupMappingObject.delete_lost_elements`](compolyx.LayupMappingObject.delete_lost_elements.md#compolyx.LayupMappingObject.delete_lost_elements) | Boolean whether to delete solid elements without layup data | +| [`LayupMappingObject.element_sets`](compolyx.LayupMappingObject.element_sets.md#compolyx.LayupMappingObject.element_sets) | Element Set(s) of the solid model | +| [`LayupMappingObject.element_technology`](compolyx.LayupMappingObject.element_technology.md#compolyx.LayupMappingObject.element_technology) | Defines the element technology | +| [`LayupMappingObject.enabled`](compolyx.LayupMappingObject.enabled.md#compolyx.LayupMappingObject.enabled) | Whether this object is currently enabled or not | +| [`LayupMappingObject.entire_solid_mesh`](compolyx.LayupMappingObject.entire_solid_mesh.md#compolyx.LayupMappingObject.entire_solid_mesh) | Boolean whether the mapping object is applied to the entire solid mesh | +| [`LayupMappingObject.filler_material`](compolyx.LayupMappingObject.filler_material.md#compolyx.LayupMappingObject.filler_material) | Filler material if layered elements are used | | [`LayupMappingObject.id`](compolyx.LayupMappingObject.id.md#compolyx.LayupMappingObject.id) | ID of object | -| [`LayupMappingObject.is_dict_item`](compolyx.LayupMappingObject.is_dict_item.md#compolyx.LayupMappingObject.is_dict_item) | Specifies wether the object is an item of a dict | -| [`LayupMappingObject.is_list_item`](compolyx.LayupMappingObject.is_list_item.md#compolyx.LayupMappingObject.is_list_item) | Specifies wether the object is an item of a list | +| [`LayupMappingObject.is_dict_item`](compolyx.LayupMappingObject.is_dict_item.md#compolyx.LayupMappingObject.is_dict_item) | Specifies whether the object is an item of a dict | +| [`LayupMappingObject.is_list_item`](compolyx.LayupMappingObject.is_list_item.md#compolyx.LayupMappingObject.is_list_item) | Specifies whether the object is an item of a list | | [`LayupMappingObject.link_path`](compolyx.LayupMappingObject.link_path.md#compolyx.LayupMappingObject.link_path) | Root path of the current node in the tree for links to this object | -| [`LayupMappingObject.minimum_void_material_thickness`](compolyx.LayupMappingObject.minimum_void_material_thickness.md#compolyx.LayupMappingObject.minimum_void_material_thickness) | Minimum thickness of the void layer! | +| [`LayupMappingObject.minimum_void_material_thickness`](compolyx.LayupMappingObject.minimum_void_material_thickness.md#compolyx.LayupMappingObject.minimum_void_material_thickness) | Minimum thickness of the void layer | | [`LayupMappingObject.name`](compolyx.LayupMappingObject.name.md#compolyx.LayupMappingObject.name) | Name of object | | [`LayupMappingObject.parent`](compolyx.LayupMappingObject.parent.md#compolyx.LayupMappingObject.parent) | Parent object in tree | -| [`LayupMappingObject.reinforcing_behavior`](compolyx.LayupMappingObject.reinforcing_behavior.md#compolyx.LayupMappingObject.reinforcing_behavior) | Whether the reinforcing carries load and/or tension. | -| [`LayupMappingObject.reinforcing_stress_state`](compolyx.LayupMappingObject.reinforcing_stress_state.md#compolyx.LayupMappingObject.reinforcing_stress_state) | Defines which FE elements are used. | +| [`LayupMappingObject.reinforcing_behavior`](compolyx.LayupMappingObject.reinforcing_behavior.md#compolyx.LayupMappingObject.reinforcing_behavior) | Whether the reinforcing carries load and/or tension | +| [`LayupMappingObject.reinforcing_stress_state`](compolyx.LayupMappingObject.reinforcing_stress_state.md#compolyx.LayupMappingObject.reinforcing_stress_state) | Defines which FE elements are used | | [`LayupMappingObject.root_path`](compolyx.LayupMappingObject.root_path.md#compolyx.LayupMappingObject.root_path) | Root path of the current node in the tree | -| [`LayupMappingObject.rosette_selection_method_type`](compolyx.LayupMappingObject.rosette_selection_method_type.md#compolyx.LayupMappingObject.rosette_selection_method_type) | Selection method of the coordinate systems for the filler/lost elements. | +| [`LayupMappingObject.rosette_selection_method_type`](compolyx.LayupMappingObject.rosette_selection_method_type.md#compolyx.LayupMappingObject.rosette_selection_method_type) | Selection method of the coordinate systems for the filler/lost elements | | [`LayupMappingObject.rosettes`](compolyx.LayupMappingObject.rosettes.md#compolyx.LayupMappingObject.rosettes) | List of rosettes used to orient the lost elements | -| [`LayupMappingObject.scale_ply_thicknesses`](compolyx.LayupMappingObject.scale_ply_thicknesses.md#compolyx.LayupMappingObject.scale_ply_thicknesses) | Boolean whether to scale the layer thicknesses or to add void layers to fill voids. | -| [`LayupMappingObject.sequences`](compolyx.LayupMappingObject.sequences.md#compolyx.LayupMappingObject.sequences) | User-defined sequence entities to map. | +| [`LayupMappingObject.scale_ply_thicknesses`](compolyx.LayupMappingObject.scale_ply_thicknesses.md#compolyx.LayupMappingObject.scale_ply_thicknesses) | Boolean whether to scale the layer thicknesses or to add void layers to fill voids | +| [`LayupMappingObject.sequences`](compolyx.LayupMappingObject.sequences.md#compolyx.LayupMappingObject.sequences) | User-defined sequence entities to map | | [`LayupMappingObject.solid_element_sets`](compolyx.LayupMappingObject.solid_element_sets.md#compolyx.LayupMappingObject.solid_element_sets) | List of element sets of the solid mesh onto which the mapping is applied to | | [`LayupMappingObject.status`](compolyx.LayupMappingObject.status.md#compolyx.LayupMappingObject.status) | Status of the object | -| [`LayupMappingObject.status_changed`](compolyx.LayupMappingObject.status_changed.md#compolyx.LayupMappingObject.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`LayupMappingObject.status_changed`](compolyx.LayupMappingObject.status_changed.md#compolyx.LayupMappingObject.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`LayupMappingObject.uid`](compolyx.LayupMappingObject.uid.md#compolyx.LayupMappingObject.uid) | UID of object | -| [`LayupMappingObject.use_imported_plies`](compolyx.LayupMappingObject.use_imported_plies.md#compolyx.LayupMappingObject.use_imported_plies) | Boolean whether to map imported plies. | -| [`LayupMappingObject.vertex`](compolyx.LayupMappingObject.vertex.md#compolyx.LayupMappingObject.vertex) | This will throw an error if the object has been removed from the graph. | -| [`LayupMappingObject.void_material`](compolyx.LayupMappingObject.void_material.md#compolyx.LayupMappingObject.void_material) | Global void material. | +| [`LayupMappingObject.use_imported_plies`](compolyx.LayupMappingObject.use_imported_plies.md#compolyx.LayupMappingObject.use_imported_plies) | Boolean whether to map imported plies | +| [`LayupMappingObject.vertex`](compolyx.LayupMappingObject.vertex.md#compolyx.LayupMappingObject.vertex) | This will throw an error if the object has been removed from the graph | +| [`LayupMappingObject.void_material`](compolyx.LayupMappingObject.void_material.md#compolyx.LayupMappingObject.void_material) | Global void material | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`LayupMappingObject.find_parent`](compolyx.LayupMappingObject.find_parent.md#compolyx.LayupMappingObject.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`LayupMappingObject.find_parent`](compolyx.LayupMappingObject.find_parent.md#compolyx.LayupMappingObject.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`LayupMappingObject.get_short_description`](compolyx.LayupMappingObject.get_short_description.md#compolyx.LayupMappingObject.get_short_description)() | | -| [`LayupMappingObject.obj_exists`](compolyx.LayupMappingObject.obj_exists.md#compolyx.LayupMappingObject.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. | +| [`LayupMappingObject.obj_exists`](compolyx.LayupMappingObject.obj_exists.md#compolyx.LayupMappingObject.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 | | [`LayupMappingObject.serialize`](compolyx.LayupMappingObject.serialize.md#compolyx.LayupMappingObject.serialize)() | | -| [`LayupMappingObject.serialize_name_and_id`](compolyx.LayupMappingObject.serialize_name_and_id.md#compolyx.LayupMappingObject.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`LayupMappingObject.serialize_name_and_id`](compolyx.LayupMappingObject.serialize_name_and_id.md#compolyx.LayupMappingObject.serialize_name_and_id)() | Helper function to serialize name and ID | | [`LayupMappingObject.update`](compolyx.LayupMappingObject.update.md#compolyx.LayupMappingObject.update)() | | -| [`LayupMappingObject.visit`](compolyx.LayupMappingObject.visit.md#compolyx.LayupMappingObject.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`LayupMappingObject.visit`](compolyx.LayupMappingObject.visit.md#compolyx.LayupMappingObject.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.minimum_void_material_thickness.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.minimum_void_material_thickness.md index ec7e0a3255..4b9912f826 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.minimum_void_material_thickness.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.minimum_void_material_thickness.md @@ -4,4 +4,4 @@ #### *property* LayupMappingObject.minimum_void_material_thickness -Minimum thickness of the void layer! +Minimum thickness of the void layer. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.obj_exists.md index 8511e8108f..d55a153f33 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.obj_exists.md @@ -4,5 +4,5 @@ #### LayupMappingObject.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.reinforcing_behavior.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.reinforcing_behavior.md index 5787de71b8..faaac8e5db 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.reinforcing_behavior.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.reinforcing_behavior.md @@ -4,4 +4,4 @@ #### *property* LayupMappingObject.reinforcing_behavior -Whether the reinforcing carries load and/or tension. Allowed string values: [‘tension_and_compression’, ‘tension_only’, ‘compression_only’] +Whether the reinforcing carries load and/or tension. Available string values: [`tension_and_compression`, `tension_only`, `compression_only`]. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.reinforcing_stress_state.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.reinforcing_stress_state.md index 6780086c26..377c9f0e50 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.reinforcing_stress_state.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.reinforcing_stress_state.md @@ -4,4 +4,4 @@ #### *property* LayupMappingObject.reinforcing_stress_state -Defines which FE elements are used. Allowed string values: [‘uniaxial_stress_state’, ‘plane_stress_state’, ‘plane_stress_state_with_transverse_shear_stiffness’, ‘plane_stress_state_with_transverse_shear_and_bending_stiffness’] +Defines which FE elements are used. Available string values: [`uniaxial_stress_state`, `plane_stress_state`, `plane_stress_state_with_transverse_shear_stiffness`, `plane_stress_state_with_transverse_shear_and_bending_stiffness`]. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.rosette_selection_method_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.rosette_selection_method_type.md index 9ee425128d..6fc831f894 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.rosette_selection_method_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.rosette_selection_method_type.md @@ -4,4 +4,4 @@ #### *property* LayupMappingObject.rosette_selection_method_type -Selection method of the coordinate systems for the filler/lost elements. Allowed string values: [‘minimum_distance’, ‘minimum_distance_superposed’] +Selection method of the coordinate systems for the filler/lost elements. Available string values: [`minimum_distance`, `minimum_distance_superposed`]. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.visit.md index 100c9c0591..2b5971b0a1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LayupMappingObject.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.column_types.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.column_types.md index 42b4a9945c..aaacbc867c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.column_types.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.column_types.md @@ -4,4 +4,4 @@ #### *property* LookUpTable1D.column_types -a list of column types (‘scalar’, or ‘direction’) +a list of column types (`scalar` or `direction`) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.create_column.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.create_column.md index 305dfabe6d..9d5b9975df 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.create_column.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.create_column.md @@ -8,5 +8,5 @@ Create a new column. * **Parameters:** - name: Name of column. - - type: A string (‘scalar’, ‘direction’) specifying the column type (the values will be initialized to NaN). + - type: A string (`scalar`, `direction`) specifying the column type (the values will be initialized to NaN). - values: A numpy array with values (the type is determined from its shape). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.enabled.md index a739242df9..f412c5ca00 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.enabled.md @@ -4,4 +4,4 @@ #### *property* LookUpTable1D.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.is_dict_item.md index 2f1bf01d1a..025ba55cfc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* LookUpTable1D.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.is_list_item.md index 77c4cb205c..b0bbf0f377 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.is_list_item.md @@ -4,4 +4,4 @@ #### *property* LookUpTable1D.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.md index f6f8b60882..edfd8cdd47 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.md @@ -11,15 +11,15 @@ A LookUpTable to associate arbitrary data to a one-dimensional field of Location | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| | [`LookUpTable1D.active`](compolyx.LookUpTable1D.active.md#compolyx.LookUpTable1D.active) | LookUpTable active | -| [`LookUpTable1D.column_types`](compolyx.LookUpTable1D.column_types.md#compolyx.LookUpTable1D.column_types) | a list of column types ('scalar', or 'direction') | +| [`LookUpTable1D.column_types`](compolyx.LookUpTable1D.column_types.md#compolyx.LookUpTable1D.column_types) | A list of column types ('scalar' or 'direction') | | [`LookUpTable1D.columns`](compolyx.LookUpTable1D.columns.md#compolyx.LookUpTable1D.columns) | Dictionary with all columns | | [`LookUpTable1D.dimensions`](compolyx.LookUpTable1D.dimensions.md#compolyx.LookUpTable1D.dimensions) | | | [`LookUpTable1D.direction`](compolyx.LookUpTable1D.direction.md#compolyx.LookUpTable1D.direction) | The Direction of the Look Up Table | | [`LookUpTable1D.empty`](compolyx.LookUpTable1D.empty.md#compolyx.LookUpTable1D.empty) | True if table is empty | -| [`LookUpTable1D.enabled`](compolyx.LookUpTable1D.enabled.md#compolyx.LookUpTable1D.enabled) | Whether this object is currently enabled or not. | +| [`LookUpTable1D.enabled`](compolyx.LookUpTable1D.enabled.md#compolyx.LookUpTable1D.enabled) | Whether this object is currently enabled or not | | [`LookUpTable1D.id`](compolyx.LookUpTable1D.id.md#compolyx.LookUpTable1D.id) | ID of object | -| [`LookUpTable1D.is_dict_item`](compolyx.LookUpTable1D.is_dict_item.md#compolyx.LookUpTable1D.is_dict_item) | Specifies wether the object is an item of a dict | -| [`LookUpTable1D.is_list_item`](compolyx.LookUpTable1D.is_list_item.md#compolyx.LookUpTable1D.is_list_item) | Specifies wether the object is an item of a list | +| [`LookUpTable1D.is_dict_item`](compolyx.LookUpTable1D.is_dict_item.md#compolyx.LookUpTable1D.is_dict_item) | Specifies whether the object is an item of a dict | +| [`LookUpTable1D.is_list_item`](compolyx.LookUpTable1D.is_list_item.md#compolyx.LookUpTable1D.is_list_item) | Specifies whether the object is an item of a list | | [`LookUpTable1D.link_path`](compolyx.LookUpTable1D.link_path.md#compolyx.LookUpTable1D.link_path) | Root path of the current node in the tree for links to this object | | [`LookUpTable1D.location_column_name`](compolyx.LookUpTable1D.location_column_name.md#compolyx.LookUpTable1D.location_column_name) | | | [`LookUpTable1D.name`](compolyx.LookUpTable1D.name.md#compolyx.LookUpTable1D.name) | Name of object | @@ -29,24 +29,24 @@ A LookUpTable to associate arbitrary data to a one-dimensional field of Location | [`LookUpTable1D.parent`](compolyx.LookUpTable1D.parent.md#compolyx.LookUpTable1D.parent) | Parent object in tree | | [`LookUpTable1D.root_path`](compolyx.LookUpTable1D.root_path.md#compolyx.LookUpTable1D.root_path) | Root path of the current node in the tree | | [`LookUpTable1D.status`](compolyx.LookUpTable1D.status.md#compolyx.LookUpTable1D.status) | Status of the object | -| [`LookUpTable1D.status_changed`](compolyx.LookUpTable1D.status_changed.md#compolyx.LookUpTable1D.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`LookUpTable1D.tabular_data`](compolyx.LookUpTable1D.tabular_data.md#compolyx.LookUpTable1D.tabular_data) | a tuple containing a list of column labels and a 2d array with floats for all cells. | +| [`LookUpTable1D.status_changed`](compolyx.LookUpTable1D.status_changed.md#compolyx.LookUpTable1D.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`LookUpTable1D.tabular_data`](compolyx.LookUpTable1D.tabular_data.md#compolyx.LookUpTable1D.tabular_data) | a tuple containing a list of column labels and a 2d array with floats for all cells | | [`LookUpTable1D.uid`](compolyx.LookUpTable1D.uid.md#compolyx.LookUpTable1D.uid) | UID of object | | [`LookUpTable1D.vector_column_suffix`](compolyx.LookUpTable1D.vector_column_suffix.md#compolyx.LookUpTable1D.vector_column_suffix) | | -| [`LookUpTable1D.vertex`](compolyx.LookUpTable1D.vertex.md#compolyx.LookUpTable1D.vertex) | This will throw an error if the object has been removed from the graph. | +| [`LookUpTable1D.vertex`](compolyx.LookUpTable1D.vertex.md#compolyx.LookUpTable1D.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`LookUpTable1D.clear`](compolyx.LookUpTable1D.clear.md#compolyx.LookUpTable1D.clear)() | Clear table data (rows and columns). | -| [`LookUpTable1D.clear_rows`](compolyx.LookUpTable1D.clear_rows.md#compolyx.LookUpTable1D.clear_rows)() | Clear table rows (keep columns). | -| [`LookUpTable1D.create_column`](compolyx.LookUpTable1D.create_column.md#compolyx.LookUpTable1D.create_column)(name[, type, ...]) | Create a new column. | -| [`LookUpTable1D.find_parent`](compolyx.LookUpTable1D.find_parent.md#compolyx.LookUpTable1D.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`LookUpTable1D.load_from_csv_file`](compolyx.LookUpTable1D.load_from_csv_file.md#compolyx.LookUpTable1D.load_from_csv_file)(path) | Load the table from .csv file in path. | -| [`LookUpTable1D.obj_exists`](compolyx.LookUpTable1D.obj_exists.md#compolyx.LookUpTable1D.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. | +| [`LookUpTable1D.clear`](compolyx.LookUpTable1D.clear.md#compolyx.LookUpTable1D.clear)() | Clear table data (rows and columns) | +| [`LookUpTable1D.clear_rows`](compolyx.LookUpTable1D.clear_rows.md#compolyx.LookUpTable1D.clear_rows)() | Clear table rows (keep columns) | +| [`LookUpTable1D.create_column`](compolyx.LookUpTable1D.create_column.md#compolyx.LookUpTable1D.create_column)(name[, type, ...]) | Create a new column | +| [`LookUpTable1D.find_parent`](compolyx.LookUpTable1D.find_parent.md#compolyx.LookUpTable1D.find_parent)(type) | Steps up the tree and returns the first parent with given type | +| [`LookUpTable1D.load_from_csv_file`](compolyx.LookUpTable1D.load_from_csv_file.md#compolyx.LookUpTable1D.load_from_csv_file)(path) | Load the table from .csv file in path | +| [`LookUpTable1D.obj_exists`](compolyx.LookUpTable1D.obj_exists.md#compolyx.LookUpTable1D.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 | | [`LookUpTable1D.save_to_csv_file`](compolyx.LookUpTable1D.save_to_csv_file.md#compolyx.LookUpTable1D.save_to_csv_file)(path) | Save LookUpTable to CSV file. | | [`LookUpTable1D.serialize`](compolyx.LookUpTable1D.serialize.md#compolyx.LookUpTable1D.serialize)() | | -| [`LookUpTable1D.serialize_name_and_id`](compolyx.LookUpTable1D.serialize_name_and_id.md#compolyx.LookUpTable1D.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`LookUpTable1D.serialize_name_and_id`](compolyx.LookUpTable1D.serialize_name_and_id.md#compolyx.LookUpTable1D.serialize_name_and_id)() | Helper function to serialize name and ID | | [`LookUpTable1D.update`](compolyx.LookUpTable1D.update.md#compolyx.LookUpTable1D.update)() | | -| [`LookUpTable1D.visit`](compolyx.LookUpTable1D.visit.md#compolyx.LookUpTable1D.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`LookUpTable1D.visit`](compolyx.LookUpTable1D.visit.md#compolyx.LookUpTable1D.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.obj_exists.md index db329bb24e..06b40a0450 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.obj_exists.md @@ -4,5 +4,5 @@ #### LookUpTable1D.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.visit.md index 65fc4d4b55..2d41eb3328 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTable1D.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.column_types.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.column_types.md index 785d121679..79fc7d796f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.column_types.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.column_types.md @@ -4,4 +4,4 @@ #### *property* LookUpTableBase.column_types -a list of column types (‘scalar’, or ‘direction’) +a list of column types (`scalar` or `direction`) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.create_column.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.create_column.md index ac72f5581e..ce9a581987 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.create_column.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.create_column.md @@ -8,5 +8,5 @@ Create a new column. * **Parameters:** - name: Name of column. - - type: A string (‘scalar’, ‘direction’) specifying the column type (the values will be initialized to NaN). + - type: A string (`scalar` or `direction`) specifying the column type (the values will be initialized to NaN). - values: A numpy array with values (the type is determined from its shape). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.enabled.md index ead96204d1..d86d8960cc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.enabled.md @@ -4,4 +4,4 @@ #### *property* LookUpTableBase.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.is_dict_item.md index 86ad6a7386..7d97727355 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* LookUpTableBase.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.is_list_item.md index 8375294901..143e658672 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.is_list_item.md @@ -4,4 +4,4 @@ #### *property* LookUpTableBase.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.md index d9a67da193..21e8eedfc8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.md @@ -4,7 +4,7 @@ ### *class* compolyx.LookUpTableBase(obj, parent=None) -Look-Up table class. +Lookup table class. Associates scalar or vector values to points. @@ -24,14 +24,14 @@ Example: |------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| | [`LookUpTableBase.active`](compolyx.LookUpTableBase.active.md#compolyx.LookUpTableBase.active) | LookUpTable active | | [`LookUpTableBase.column_factory`](compolyx.LookUpTableBase.column_factory.md#compolyx.LookUpTableBase.column_factory) | | -| [`LookUpTableBase.column_types`](compolyx.LookUpTableBase.column_types.md#compolyx.LookUpTableBase.column_types) | a list of column types ('scalar', or 'direction') | +| [`LookUpTableBase.column_types`](compolyx.LookUpTableBase.column_types.md#compolyx.LookUpTableBase.column_types) | A list of column types ('scalar', or 'direction') | | [`LookUpTableBase.columns`](compolyx.LookUpTableBase.columns.md#compolyx.LookUpTableBase.columns) | Dictionary with all columns | | [`LookUpTableBase.dimensions`](compolyx.LookUpTableBase.dimensions.md#compolyx.LookUpTableBase.dimensions) | | | [`LookUpTableBase.empty`](compolyx.LookUpTableBase.empty.md#compolyx.LookUpTableBase.empty) | True if table is empty | | [`LookUpTableBase.enabled`](compolyx.LookUpTableBase.enabled.md#compolyx.LookUpTableBase.enabled) | Whether this object is currently enabled or not. | | [`LookUpTableBase.id`](compolyx.LookUpTableBase.id.md#compolyx.LookUpTableBase.id) | ID of object | -| [`LookUpTableBase.is_dict_item`](compolyx.LookUpTableBase.is_dict_item.md#compolyx.LookUpTableBase.is_dict_item) | Specifies wether the object is an item of a dict | -| [`LookUpTableBase.is_list_item`](compolyx.LookUpTableBase.is_list_item.md#compolyx.LookUpTableBase.is_list_item) | Specifies wether the object is an item of a list | +| [`LookUpTableBase.is_dict_item`](compolyx.LookUpTableBase.is_dict_item.md#compolyx.LookUpTableBase.is_dict_item) | Specifies whether the object is an item of a dict | +| [`LookUpTableBase.is_list_item`](compolyx.LookUpTableBase.is_list_item.md#compolyx.LookUpTableBase.is_list_item) | Specifies whether the object is an item of a list | | [`LookUpTableBase.link_path`](compolyx.LookUpTableBase.link_path.md#compolyx.LookUpTableBase.link_path) | Root path of the current node in the tree for links to this object | | [`LookUpTableBase.location_column_name`](compolyx.LookUpTableBase.location_column_name.md#compolyx.LookUpTableBase.location_column_name) | | | [`LookUpTableBase.name`](compolyx.LookUpTableBase.name.md#compolyx.LookUpTableBase.name) | Name of object | @@ -40,23 +40,23 @@ Example: | [`LookUpTableBase.parent`](compolyx.LookUpTableBase.parent.md#compolyx.LookUpTableBase.parent) | Parent object in tree | | [`LookUpTableBase.root_path`](compolyx.LookUpTableBase.root_path.md#compolyx.LookUpTableBase.root_path) | Root path of the current node in the tree | | [`LookUpTableBase.status`](compolyx.LookUpTableBase.status.md#compolyx.LookUpTableBase.status) | Status of the object | -| [`LookUpTableBase.status_changed`](compolyx.LookUpTableBase.status_changed.md#compolyx.LookUpTableBase.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`LookUpTableBase.tabular_data`](compolyx.LookUpTableBase.tabular_data.md#compolyx.LookUpTableBase.tabular_data) | a tuple containing a list of column labels and a 2d array with floats for all cells. | +| [`LookUpTableBase.status_changed`](compolyx.LookUpTableBase.status_changed.md#compolyx.LookUpTableBase.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`LookUpTableBase.tabular_data`](compolyx.LookUpTableBase.tabular_data.md#compolyx.LookUpTableBase.tabular_data) | a tuple containing a list of column labels and a 2d array with floats for all cells | | [`LookUpTableBase.uid`](compolyx.LookUpTableBase.uid.md#compolyx.LookUpTableBase.uid) | UID of object | | [`LookUpTableBase.vector_column_suffix`](compolyx.LookUpTableBase.vector_column_suffix.md#compolyx.LookUpTableBase.vector_column_suffix) | | -| [`LookUpTableBase.vertex`](compolyx.LookUpTableBase.vertex.md#compolyx.LookUpTableBase.vertex) | This will throw an error if the object has been removed from the graph. | +| [`LookUpTableBase.vertex`](compolyx.LookUpTableBase.vertex.md#compolyx.LookUpTableBase.vertex) | Throws an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`LookUpTableBase.clear`](compolyx.LookUpTableBase.clear.md#compolyx.LookUpTableBase.clear)() | Clear table data (rows and columns). | -| [`LookUpTableBase.clear_rows`](compolyx.LookUpTableBase.clear_rows.md#compolyx.LookUpTableBase.clear_rows)() | Clear table rows (keep columns). | -| [`LookUpTableBase.create_column`](compolyx.LookUpTableBase.create_column.md#compolyx.LookUpTableBase.create_column)(name[, type, ...]) | Create a new column. | -| [`LookUpTableBase.find_parent`](compolyx.LookUpTableBase.find_parent.md#compolyx.LookUpTableBase.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`LookUpTableBase.load_from_csv_file`](compolyx.LookUpTableBase.load_from_csv_file.md#compolyx.LookUpTableBase.load_from_csv_file)(path) | Load the table from .csv file in path. | -| [`LookUpTableBase.obj_exists`](compolyx.LookUpTableBase.obj_exists.md#compolyx.LookUpTableBase.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. | -| [`LookUpTableBase.save_to_csv_file`](compolyx.LookUpTableBase.save_to_csv_file.md#compolyx.LookUpTableBase.save_to_csv_file)(path) | Save LookUpTable to CSV file. | -| [`LookUpTableBase.serialize_name_and_id`](compolyx.LookUpTableBase.serialize_name_and_id.md#compolyx.LookUpTableBase.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`LookUpTableBase.clear`](compolyx.LookUpTableBase.clear.md#compolyx.LookUpTableBase.clear)() | Clear table data (rows and columns) | +| [`LookUpTableBase.clear_rows`](compolyx.LookUpTableBase.clear_rows.md#compolyx.LookUpTableBase.clear_rows)() | Clear table rows (keep columns) | +| [`LookUpTableBase.create_column`](compolyx.LookUpTableBase.create_column.md#compolyx.LookUpTableBase.create_column)(name[, type, ...]) | Create a new column | +| [`LookUpTableBase.find_parent`](compolyx.LookUpTableBase.find_parent.md#compolyx.LookUpTableBase.find_parent)(type) | Steps up the tree and returns the first parent with given type | +| [`LookUpTableBase.load_from_csv_file`](compolyx.LookUpTableBase.load_from_csv_file.md#compolyx.LookUpTableBase.load_from_csv_file)(path) | Load the table from .csv file in path | +| [`LookUpTableBase.obj_exists`](compolyx.LookUpTableBase.obj_exists.md#compolyx.LookUpTableBase.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 | +| [`LookUpTableBase.save_to_csv_file`](compolyx.LookUpTableBase.save_to_csv_file.md#compolyx.LookUpTableBase.save_to_csv_file)(path) | Save LookUpTable to CSV file | +| [`LookUpTableBase.serialize_name_and_id`](compolyx.LookUpTableBase.serialize_name_and_id.md#compolyx.LookUpTableBase.serialize_name_and_id)() | Helper function to serialize name and ID | | [`LookUpTableBase.update`](compolyx.LookUpTableBase.update.md#compolyx.LookUpTableBase.update)() | | -| [`LookUpTableBase.visit`](compolyx.LookUpTableBase.visit.md#compolyx.LookUpTableBase.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`LookUpTableBase.visit`](compolyx.LookUpTableBase.visit.md#compolyx.LookUpTableBase.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.obj_exists.md index a553cc8942..18bcb1781e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.obj_exists.md @@ -4,5 +4,5 @@ #### LookUpTableBase.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.visit.md index 9906b49d8a..43910100f1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableBase.visit.md @@ -9,7 +9,7 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.enabled.md index 8943b9690f..2803268ef0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.enabled.md @@ -4,4 +4,4 @@ #### *property* LookUpTableColumn.enabled -Whether this object is currently enabled. Mainly defined through the current application mode (pre or post). +Whether this object is currently enabled. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.is_dict_item.md index f936dd0fef..1529522595 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* LookUpTableColumn.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.is_list_item.md index 1b02be0736..30054fd649 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.is_list_item.md @@ -4,4 +4,4 @@ #### *property* LookUpTableColumn.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.md index d81c737aee..1bb8dcc846 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.md @@ -11,21 +11,21 @@ An object to hold a column in a table. | Name | Description | |------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| | [`LookUpTableColumn.dimension`](compolyx.LookUpTableColumn.dimension.md#compolyx.LookUpTableColumn.dimension) | | -| [`LookUpTableColumn.enabled`](compolyx.LookUpTableColumn.enabled.md#compolyx.LookUpTableColumn.enabled) | Whether this object is currently enabled. | -| [`LookUpTableColumn.is_dict_item`](compolyx.LookUpTableColumn.is_dict_item.md#compolyx.LookUpTableColumn.is_dict_item) | Specifies wether the object is an item of a dict | -| [`LookUpTableColumn.is_list_item`](compolyx.LookUpTableColumn.is_list_item.md#compolyx.LookUpTableColumn.is_list_item) | Specifies wether the object is an item of a list | +| [`LookUpTableColumn.enabled`](compolyx.LookUpTableColumn.enabled.md#compolyx.LookUpTableColumn.enabled) | Whether this object is currently enabled | +| [`LookUpTableColumn.is_dict_item`](compolyx.LookUpTableColumn.is_dict_item.md#compolyx.LookUpTableColumn.is_dict_item) | Specifies whether the object is an item of a dict | +| [`LookUpTableColumn.is_list_item`](compolyx.LookUpTableColumn.is_list_item.md#compolyx.LookUpTableColumn.is_list_item) | Specifies whether the object is an item of a list | | [`LookUpTableColumn.link_path`](compolyx.LookUpTableColumn.link_path.md#compolyx.LookUpTableColumn.link_path) | Root path of the current node in the tree for links to this object | | [`LookUpTableColumn.name`](compolyx.LookUpTableColumn.name.md#compolyx.LookUpTableColumn.name) | | | [`LookUpTableColumn.parent`](compolyx.LookUpTableColumn.parent.md#compolyx.LookUpTableColumn.parent) | Parent object in tree | | [`LookUpTableColumn.root_path`](compolyx.LookUpTableColumn.root_path.md#compolyx.LookUpTableColumn.root_path) | Root path of the current node in the tree | -| [`LookUpTableColumn.status`](compolyx.LookUpTableColumn.status.md#compolyx.LookUpTableColumn.status) | column status ('UPTODATE','NOTUPTODATE', or 'LOCKED') | -| [`LookUpTableColumn.type`](compolyx.LookUpTableColumn.type.md#compolyx.LookUpTableColumn.type) | column type (scalar or direction) | -| [`LookUpTableColumn.values`](compolyx.LookUpTableColumn.values.md#compolyx.LookUpTableColumn.values) | numpy array containing the column values | +| [`LookUpTableColumn.status`](compolyx.LookUpTableColumn.status.md#compolyx.LookUpTableColumn.status) | Column status ('UPTODATE', 'NOTUPTODATE', or 'LOCKED') | +| [`LookUpTableColumn.type`](compolyx.LookUpTableColumn.type.md#compolyx.LookUpTableColumn.type) | Column type (scalar or direction) | +| [`LookUpTableColumn.values`](compolyx.LookUpTableColumn.values.md#compolyx.LookUpTableColumn.values) | Numpy array containing the column values | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`LookUpTableColumn.find_parent`](compolyx.LookUpTableColumn.find_parent.md#compolyx.LookUpTableColumn.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`LookUpTableColumn.find_parent`](compolyx.LookUpTableColumn.find_parent.md#compolyx.LookUpTableColumn.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`LookUpTableColumn.obj_exists`](compolyx.LookUpTableColumn.obj_exists.md#compolyx.LookUpTableColumn.obj_exists)() | | -| [`LookUpTableColumn.visit`](compolyx.LookUpTableColumn.visit.md#compolyx.LookUpTableColumn.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`LookUpTableColumn.visit`](compolyx.LookUpTableColumn.visit.md#compolyx.LookUpTableColumn.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.status.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.status.md index 93d7d819a8..597022e44a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.status.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.status.md @@ -4,4 +4,4 @@ #### *property* LookUpTableColumn.status -column status (‘UPTODATE’,’NOTUPTODATE’, or ‘LOCKED’) +column status (`UPTODATE`, `NOTUPTODATE`, or `LOCKED`) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.visit.md index 3985b4c05c..26391ed62d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.LookUpTableColumn.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.enabled.md index e0acf71431..95d8964021 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.enabled.md @@ -4,4 +4,4 @@ #### *property* Material.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.is_dict_item.md index 52a771ac7c..59cf9ffcd6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* Material.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.is_list_item.md index fb351a5fbe..010a997953 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.is_list_item.md @@ -4,4 +4,4 @@ #### *property* Material.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.md index dff43023bd..5821096fc7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.md @@ -29,36 +29,36 @@ This class enables retrieving all material properties defined within the loaded | Name | Description | |------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`Material.active`](compolyx.Material.active.md#compolyx.Material.active) | active status of object | -| [`Material.active_properties`](compolyx.Material.active_properties.md#compolyx.Material.active_properties) | List of the active properties for the underlying material. | -| [`Material.enabled`](compolyx.Material.enabled.md#compolyx.Material.enabled) | Whether this object is currently enabled or not. | -| [`Material.ext_id`](compolyx.Material.ext_id.md#compolyx.Material.ext_id) | Id of corresponding Material in external source. | +| [`Material.active`](compolyx.Material.active.md#compolyx.Material.active) | Active status of object | +| [`Material.active_properties`](compolyx.Material.active_properties.md#compolyx.Material.active_properties) | List of the active properties for the underlying material | +| [`Material.enabled`](compolyx.Material.enabled.md#compolyx.Material.enabled) | Whether this object is currently enabled or not | +| [`Material.ext_id`](compolyx.Material.ext_id.md#compolyx.Material.ext_id) | ID of corresponding Material in external source | | [`Material.id`](compolyx.Material.id.md#compolyx.Material.id) | ID of object | -| [`Material.is_constant`](compolyx.Material.is_constant.md#compolyx.Material.is_constant) | True if engineering constants are constant. | -| [`Material.is_dict_item`](compolyx.Material.is_dict_item.md#compolyx.Material.is_dict_item) | Specifies wether the object is an item of a dict | -| [`Material.is_isotropic`](compolyx.Material.is_isotropic.md#compolyx.Material.is_isotropic) | True if ply_type is isotropic or isotropic_homogeneous_core. | -| [`Material.is_list_item`](compolyx.Material.is_list_item.md#compolyx.Material.is_list_item) | Specifies wether the object is an item of a list | +| [`Material.is_constant`](compolyx.Material.is_constant.md#compolyx.Material.is_constant) | True if engineering constants are constant | +| [`Material.is_dict_item`](compolyx.Material.is_dict_item.md#compolyx.Material.is_dict_item) | Specifies whether the object is an item of a dict | +| [`Material.is_isotropic`](compolyx.Material.is_isotropic.md#compolyx.Material.is_isotropic) | `True` if ply_type is isotropic or isotropic_homogeneous_core | +| [`Material.is_list_item`](compolyx.Material.is_list_item.md#compolyx.Material.is_list_item) | Specifies whether the object is an item of a list | | [`Material.link_path`](compolyx.Material.link_path.md#compolyx.Material.link_path) | Root path of the current node in the tree for links to this object | -| [`Material.locked`](compolyx.Material.locked.md#compolyx.Material.locked) | Material is generated from an external source and cannot be changed. | +| [`Material.locked`](compolyx.Material.locked.md#compolyx.Material.locked) | Material is generated from an external source and cannot be changed | | [`Material.name`](compolyx.Material.name.md#compolyx.Material.name) | Name of object | | [`Material.parent`](compolyx.Material.parent.md#compolyx.Material.parent) | Parent object in tree | -| [`Material.ply_type`](compolyx.Material.ply_type.md#compolyx.Material.ply_type) | Ply type. | -| [`Material.property_names`](compolyx.Material.property_names.md#compolyx.Material.property_names) | List with all available property keys. | +| [`Material.ply_type`](compolyx.Material.ply_type.md#compolyx.Material.ply_type) | Ply type | +| [`Material.property_names`](compolyx.Material.property_names.md#compolyx.Material.property_names) | List with all available property keys | | [`Material.root_path`](compolyx.Material.root_path.md#compolyx.Material.root_path) | Root path of the current node in the tree | | [`Material.status`](compolyx.Material.status.md#compolyx.Material.status) | Status of the object | -| [`Material.status_changed`](compolyx.Material.status_changed.md#compolyx.Material.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`Material.status_changed`](compolyx.Material.status_changed.md#compolyx.Material.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`Material.uid`](compolyx.Material.uid.md#compolyx.Material.uid) | UID of object | -| [`Material.vertex`](compolyx.Material.vertex.md#compolyx.Material.vertex) | This will throw an error if the object has been removed from the graph. | +| [`Material.vertex`](compolyx.Material.vertex.md#compolyx.Material.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`Material.create_property_set`](compolyx.Material.create_property_set.md#compolyx.Material.create_property_set)(property_name, ...) | Function to create a specific property set. | -| [`Material.delete_property_set`](compolyx.Material.delete_property_set.md#compolyx.Material.delete_property_set)(property_name) | Function to delete a specific property set. | -| [`Material.find_parent`](compolyx.Material.find_parent.md#compolyx.Material.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`Material.obj_exists`](compolyx.Material.obj_exists.md#compolyx.Material.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. | -| [`Material.serialize`](compolyx.Material.serialize.md#compolyx.Material.serialize)() | Serialize to Python string. | -| [`Material.serialize_name_and_id`](compolyx.Material.serialize_name_and_id.md#compolyx.Material.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`Material.create_property_set`](compolyx.Material.create_property_set.md#compolyx.Material.create_property_set)(property_name, ...) | Function to create a specific property set | +| [`Material.delete_property_set`](compolyx.Material.delete_property_set.md#compolyx.Material.delete_property_set)(property_name) | Function to delete a specific property set | +| [`Material.find_parent`](compolyx.Material.find_parent.md#compolyx.Material.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`Material.obj_exists`](compolyx.Material.obj_exists.md#compolyx.Material.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 | +| [`Material.serialize`](compolyx.Material.serialize.md#compolyx.Material.serialize)() | Serialize to Python string | +| [`Material.serialize_name_and_id`](compolyx.Material.serialize_name_and_id.md#compolyx.Material.serialize_name_and_id)() | Helper function to serialize name and ID | | [`Material.update`](compolyx.Material.update.md#compolyx.Material.update)() | | -| [`Material.visit`](compolyx.Material.visit.md#compolyx.Material.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`Material.visit`](compolyx.Material.visit.md#compolyx.Material.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.obj_exists.md index eb18a959fe..20e024437f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.obj_exists.md @@ -4,5 +4,5 @@ #### Material.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.ply_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.ply_type.md index 85aedaba2d..78ae667008 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.ply_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.ply_type.md @@ -4,4 +4,4 @@ #### *property* Material.ply_type -Ply type. Allowed string values: regular, woven, orthotropic_homogeneous_core, isotropic_homogeneous_core, honeycomb_core, isotropic, adhesive, undefined +Ply type. Available string values: `regular`, `woven`, `orthotropic_homogeneous_core`, `isotropic_homogeneous_core`, `honeycomb_core`, `isotropic`, `adhesive`, and `undefined`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.visit.md index 1fb4465765..5526afd1a7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Material.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_fabric.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_fabric.md index c872dd23f8..a067cb7c96 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_fabric.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_fabric.md @@ -14,9 +14,9 @@ Create a new fabric. - ignore_for_postprocessing: Flag if this material is postprocessed. - drop_off_material_handling: Type defining how drop-off material is used in drop-off areas of the fabric. - cut_off_material_handling: Type defining how cut-off material is used in cut-off areas of the fabric. - - drop_off_material: Material to use for ‘Custom’ drop-off material handling. - - cut_off_material: Material to use for ‘Custom’ cut-off material handling. - - draping_material_model: Material model for draping, either ‘woven’ or ‘unidirectional’. + - drop_off_material: Material to use for `Custom` drop-off material handling. + - cut_off_material: Material to use for `Custom` cut-off material handling. + - draping_material_model: Material model for draping, either `woven` or `unidirectional`. - draping_ud_coefficient: Coefficient for the unidirectional draping material model. * **Returns:** The created fabric. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_material.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_material.md index d6d3909cab..664d93cf20 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_material.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_material.md @@ -8,7 +8,7 @@ Create a constant material. * **Parameters:** - name: Name of the new material. - - ply_type: Type of ply for the material. Valid string values: regular, woven, orthotropic_homogeneous_core, isotropic_homogeneous_core, honeycomb_core, isotropic, adhesive, and undefined. + - ply_type: Type of ply for the material. Available string values: `regular`, `woven`, `orthotropic_homogeneous_core`, `isotropic_homogeneous_core`, `honeycomb_core`, `isotropic`, `adhesive`, and `undefined`. - E1 - rho: Material parameters. * **Returns:** New instance of material. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_stackup.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_stackup.md index a8c7d11833..0a5c35a2e7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_stackup.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_stackup.md @@ -10,13 +10,13 @@ Create a new stackup. - name: Name for the stackup. - fabrics: Fabrics of the stackup. - area_price: Area price of the stackup. - - symmetry: Symmetry of the stackup. Valid options: ‘No Symmetry’, ‘Even Symmetry’, and ‘Odd Symmetry’. - - layup_sequence: Layup sequence of the stackup. Valid options: ‘Top-Down’ and ‘Bottom-Up’. + - symmetry: Symmetry of the stackup. Available options: `No Symmetry`, `Even Symmetry`, and `Odd Symmetry`. + - layup_sequence: Layup sequence of the stackup. Available options: `Top-Down` and `Bottom-Up`. - drop_off_material_handling: Type defining how drop-off material is used in drop-off areas of the stackup. - cut_off_material_handling: Type defining how cut-off material is used in cut-off areas of the stackup. - - drop_off_material: Material to use for ‘Custom’ drop-off material handling. - - cut_off_material: Material to use for ‘Custom’ cut-off material handling. - - draping_material_model: Material model for draping, either ‘woven’ or ‘unidirectional’. + - drop_off_material: Material to use for `Custom` drop-off material handling. + - cut_off_material: Material to use for `Custom` cut-off material handling. + - draping_material_model: Material model for draping, either `woven` or `unidirectional`. - draping_ud_coefficient: Coefficient for the unidirectional draping material model. * **Returns:** The created stackup. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_sub_laminate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_sub_laminate.md index 49df4e8206..98258c913a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_sub_laminate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.create_sub_laminate.md @@ -9,8 +9,8 @@ Create a new sublaminate. * **Parameters:** - name: Name for the sublaminate. - fabrics: Fabrics of the sublaminate. - - symmetry: Symmetry of the sublaminate. Valid options: ‘No Symmetry’, ‘Even Symmetry’, and ‘Odd Symmetry’. - - layup_sequence: Layup sequence of the sublaminate. Valid options: ‘Top-Down’ and ‘Bottom-Up’. + - symmetry: Symmetry of the sublaminate. Available options: `No Symmetry`, `Even Symmetry`, and `Odd Symmetry`. + - layup_sequence: Layup sequence of the sublaminate. Available options: `Top-Down` and `Bottom-Up`. * **Returns:** The created sublaminate. * **Examples:** diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.is_dict_item.md index 56b233ebed..f315d02ef1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* MaterialData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.is_list_item.md index 49cd298e3b..e3315c1688 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* MaterialData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.md index c07a629596..7823dc2565 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.md @@ -10,37 +10,37 @@ MaterialData manages all composite material data. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`MaterialData.enabled`](compolyx.MaterialData.enabled.md#compolyx.MaterialData.enabled) | Whether MaterialData is currently enabled or not. | -| [`MaterialData.fabrics`](compolyx.MaterialData.fabrics.md#compolyx.MaterialData.fabrics) | Dictionary with all fabrics defined. | -| [`MaterialData.is_dict_item`](compolyx.MaterialData.is_dict_item.md#compolyx.MaterialData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`MaterialData.is_list_item`](compolyx.MaterialData.is_list_item.md#compolyx.MaterialData.is_list_item) | Specifies wether the object is an item of a list | +| [`MaterialData.enabled`](compolyx.MaterialData.enabled.md#compolyx.MaterialData.enabled) | Whether MaterialData is currently enabled or not | +| [`MaterialData.fabrics`](compolyx.MaterialData.fabrics.md#compolyx.MaterialData.fabrics) | Dictionary with all fabrics defined | +| [`MaterialData.is_dict_item`](compolyx.MaterialData.is_dict_item.md#compolyx.MaterialData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`MaterialData.is_list_item`](compolyx.MaterialData.is_list_item.md#compolyx.MaterialData.is_list_item) | Specifies whether the object is an item of a list | | [`MaterialData.link_path`](compolyx.MaterialData.link_path.md#compolyx.MaterialData.link_path) | Root path of the current node in the tree for links to this object | -| [`MaterialData.material_apdl_path`](compolyx.MaterialData.material_apdl_path.md#compolyx.MaterialData.material_apdl_path) | Optional path to file with APDL material definitions to be used in the CDB export. | -| [`MaterialData.materials`](compolyx.MaterialData.materials.md#compolyx.MaterialData.materials) | Dictionary with all materials defined. | +| [`MaterialData.material_apdl_path`](compolyx.MaterialData.material_apdl_path.md#compolyx.MaterialData.material_apdl_path) | Optional path to file with APDL material definitions to be used in the CDB export | +| [`MaterialData.materials`](compolyx.MaterialData.materials.md#compolyx.MaterialData.materials) | Dictionary with all materials defined | | [`MaterialData.matml_path`](compolyx.MaterialData.matml_path.md#compolyx.MaterialData.matml_path) | Path to MatML file as provided by Workbench EngineeringData | -| [`MaterialData.name`](compolyx.MaterialData.name.md#compolyx.MaterialData.name) | Currently a name is needed for every object in the db tree. | +| [`MaterialData.name`](compolyx.MaterialData.name.md#compolyx.MaterialData.name) | Currently a name is needed for every object in the db tree | | [`MaterialData.parent`](compolyx.MaterialData.parent.md#compolyx.MaterialData.parent) | Parent object in tree | | [`MaterialData.root_path`](compolyx.MaterialData.root_path.md#compolyx.MaterialData.root_path) | Root path of the current node in the tree | -| [`MaterialData.stackups`](compolyx.MaterialData.stackups.md#compolyx.MaterialData.stackups) | Dictionary with all stack ups defined. | -| [`MaterialData.sub_laminates`](compolyx.MaterialData.sub_laminates.md#compolyx.MaterialData.sub_laminates) | Dictionary with all sub laminates defined. | +| [`MaterialData.stackups`](compolyx.MaterialData.stackups.md#compolyx.MaterialData.stackups) | Dictionary with all stack ups defined | +| [`MaterialData.sub_laminates`](compolyx.MaterialData.sub_laminates.md#compolyx.MaterialData.sub_laminates) | Dictionary with all sub laminates defined | | [`MaterialData.unit_system`](compolyx.MaterialData.unit_system.md#compolyx.MaterialData.unit_system) | Unit system of material data, propagated from model | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`MaterialData.copy`](compolyx.MaterialData.copy.md#compolyx.MaterialData.copy)(source[, on_duplicate_name]) | Copy a list of material data source. | -| [`MaterialData.copy_fabric`](compolyx.MaterialData.copy_fabric.md#compolyx.MaterialData.copy_fabric)(source[, ...]) | Copy a fabric. | -| [`MaterialData.copy_material`](compolyx.MaterialData.copy_material.md#compolyx.MaterialData.copy_material)(source[, ...]) | Copy a material. | -| [`MaterialData.copy_stackup`](compolyx.MaterialData.copy_stackup.md#compolyx.MaterialData.copy_stackup)(source[, ...]) | Copy a stackup. | -| [`MaterialData.copy_sub_laminate`](compolyx.MaterialData.copy_sub_laminate.md#compolyx.MaterialData.copy_sub_laminate)(source[, ...]) | Copy a sublamiante. | -| [`MaterialData.create_fabric`](compolyx.MaterialData.create_fabric.md#compolyx.MaterialData.create_fabric)(name[, id, ...]) | Create a new fabric. | -| [`MaterialData.create_material`](compolyx.MaterialData.create_material.md#compolyx.MaterialData.create_material)(name[, id, ...]) | Create a constant material. | -| [`MaterialData.create_stackup`](compolyx.MaterialData.create_stackup.md#compolyx.MaterialData.create_stackup)(name[, id, ...]) | Create a new stackup. | -| [`MaterialData.create_sub_laminate`](compolyx.MaterialData.create_sub_laminate.md#compolyx.MaterialData.create_sub_laminate)(name[, id, ...]) | Create a new sublaminate. | -| [`MaterialData.export_matml`](compolyx.MaterialData.export_matml.md#compolyx.MaterialData.export_matml)(path[, unit_system]) | Export materials to ANSYS Engineering Data MatML format. | -| [`MaterialData.find_materials`](compolyx.MaterialData.find_materials.md#compolyx.MaterialData.find_materials)(\*\*properties) | Find materials with the given properties or property ranges. | -| [`MaterialData.find_parent`](compolyx.MaterialData.find_parent.md#compolyx.MaterialData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`MaterialData.import_matml`](compolyx.MaterialData.import_matml.md#compolyx.MaterialData.import_matml)(path[, ...]) | Import material data from MatML file as provided by Workbench Engineering Data. | +| [`MaterialData.copy`](compolyx.MaterialData.copy.md#compolyx.MaterialData.copy)(source[, on_duplicate_name]) | Copy a list of material data source | +| [`MaterialData.copy_fabric`](compolyx.MaterialData.copy_fabric.md#compolyx.MaterialData.copy_fabric)(source[, ...]) | Copy a fabric | +| [`MaterialData.copy_material`](compolyx.MaterialData.copy_material.md#compolyx.MaterialData.copy_material)(source[, ...]) | Copy a material | +| [`MaterialData.copy_stackup`](compolyx.MaterialData.copy_stackup.md#compolyx.MaterialData.copy_stackup)(source[, ...]) | Copy a stackup | +| [`MaterialData.copy_sub_laminate`](compolyx.MaterialData.copy_sub_laminate.md#compolyx.MaterialData.copy_sub_laminate)(source[, ...]) | Copy a sublamiante | +| [`MaterialData.create_fabric`](compolyx.MaterialData.create_fabric.md#compolyx.MaterialData.create_fabric)(name[, id, ...]) | Create a new fabric | +| [`MaterialData.create_material`](compolyx.MaterialData.create_material.md#compolyx.MaterialData.create_material)(name[, id, ...]) | Create a constant material | +| [`MaterialData.create_stackup`](compolyx.MaterialData.create_stackup.md#compolyx.MaterialData.create_stackup)(name[, id, ...]) | Create a new stackup | +| [`MaterialData.create_sub_laminate`](compolyx.MaterialData.create_sub_laminate.md#compolyx.MaterialData.create_sub_laminate)(name[, id, ...]) | Create a new sublaminate | +| [`MaterialData.export_matml`](compolyx.MaterialData.export_matml.md#compolyx.MaterialData.export_matml)(path[, unit_system]) | Export materials to ANSYS Engineering Data MatML format | +| [`MaterialData.find_materials`](compolyx.MaterialData.find_materials.md#compolyx.MaterialData.find_materials)(\*\*properties) | Find materials with the given properties or property ranges | +| [`MaterialData.find_parent`](compolyx.MaterialData.find_parent.md#compolyx.MaterialData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`MaterialData.import_matml`](compolyx.MaterialData.import_matml.md#compolyx.MaterialData.import_matml)(path[, ...]) | Import material data from MatML file as provided by Workbench Engineering Data | | [`MaterialData.serialize`](compolyx.MaterialData.serialize.md#compolyx.MaterialData.serialize)() | Serialize to Python string | -| [`MaterialData.visit`](compolyx.MaterialData.visit.md#compolyx.MaterialData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`MaterialData.visit`](compolyx.MaterialData.visit.md#compolyx.MaterialData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.visit.md index 27a22c1f48..607982d7d5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.MaterialData.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.add_solution.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.add_solution.md index 71890cf7fe..4112522f44 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.add_solution.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.add_solution.md @@ -10,13 +10,13 @@ Load a nodal solution from file(s) and add it to the model. - name: Custom name of the solution. - path: Path to the data file. - path2: Optional path to second result file. Useful for ANSYS PRNSOL solution, where nodal deformations and nodal rotations can be exported to different files only. - - format: File format string. Valid options: ‘abaqus:fieldreport’, ‘ansys:prnsol’,’ansys:rst’, and ‘nastran:f06’. - - subcase: Optional subcase to read. Only valid for ‘nastran:f06’ format. (False,0) if not given in the F06 file. - - load_factor: Optional load factor within substep of non-linear solution where the nodal solution should be taken from. Only valid for ‘nastran:f06’ format. (False,0) if not given in the F06 file. + - format: File format string. Available options: `abaqus:fieldreport`, `ansys:prnsol`, `ansys:rst`, and `nastran:f06`. + - subcase: Optional subcase to read. Only valid for `nastran:f06` format. (False,0) if not given in the F06 file. + - load_factor: Optional load factor within substep of non-linear solution where the nodal solution should be taken from. Only valid for `nastran:f06` format. (False,0) if not given in the F06 file. - set: Result set for ANSYS RST files, None is last result set. - read_stresses_strains: Reads strain and stress results from the RST file (necessary to postprocess non-linear solutions). - ‘use_felyx_to_compute_pp_results’: Use ACP to compute strain and stress data. - - use_solid_results: Mapps solid element solution onto ‘Layered Solid Reference Surface’. + - use_solid_results: Maps solid element solution onto `Layered Solid Reference Surface`. - recompute_iss_of_solids: For solids the interlaminar shear stresses are recalculated considering the laminate stacking. - renumbering_mapping_paths: List of paths of the assembly renumbering files used to map the results of composite assemblies. - active: Active/inactive flag. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.add_winding_entities.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.add_winding_entities.md index 0eda345747..547a8c397b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.add_winding_entities.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.add_winding_entities.md @@ -24,7 +24,7 @@ angle = sign(angle) \* 90° otherwise with const = reference_radius \* sin(nominal_angle) Each layer is a dict with the following properties: -: * fabric: Fabric of the layer (Stackups and Sublaminates are not supported). + * fabric: Fabric of the layer (Stackups and Sublaminates are not supported). * angle: Nominal angle at Reference Radius with respect to the axis of symmetry (in degree). * selection_rule_limits: A dictionary with the entries “upper” and “lower” that define the extent of the plies in axial direction. @@ -35,7 +35,7 @@ Each layer is a dict with the following properties: twice the original thickness of the layer. The function generates the following objects: -: - A cylindrical rosette. + - A cylindrical rosette. - An oriented selection set which defines a reference direction along the axial direction of the axisymmetric body. - A lookup table with the thickness corrections and angles. @@ -46,9 +46,9 @@ The function generates the following objects: - axial_direction: Direction vector for the axis of symmetry. - origin: Point on the axis of symmetry. - reference radius: Reference radius at which the plies are assumed to have the - : nominal angle and the nominal thickness. + nominal angle and the nominal thickness. - layers: List of dicts with the following entries: - : - fabric: Fabric of the layer (Stackups and Sublaminates are not supported). + - fabric: Fabric of the layer (Stackups and Sublaminates are not supported). - angle: Nominal angle at Reference Radius with respect to the axis of symmetry (in degree). - selection_rule_limits: A dictionary with the entries “upper” and “lower” that define the extent of the plies in axial direction. @@ -58,11 +58,11 @@ The function generates the following objects: a negative angle is generated. This implies that the resulting thickness is twice the original thickness of the layer. - number_of_digits_angle, optional, default: 3: Lookup tables for the angles are - : shared between different layers with similar angles. + shared between different layers with similar angles. Angles which are equal until number_of_digits_angle after the decimal point share the same lookup table. - max_angle_with_thickness_correction: The thickness for layers where abs(angle) > - : max_angle_with_thickness_correction is not + max_angle_with_thickness_correction is not corrected. These layers always have the nominal layer thickness. * **Usage:** diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_cutoff_selection_rule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_cutoff_selection_rule.md index 4cbf08f29b..664de57bee 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_cutoff_selection_rule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_cutoff_selection_rule.md @@ -9,15 +9,15 @@ Create new cut-off rule. * **Parameters:** - name: Name of the rule. - cutoff_rule_type: Valid options: geometry, taper, and variable_taper. - - offset: Offset of the rule (float for cutoff_rule_type=\`geometry\` or taper, LookUpTableColumn for cutoff_rule_type=\`variable_taper\`). - - angle: Angle of the rule (ignored for cutoff_rule_type=\`geometry\`, float for taper, LookUpTableColumn for variable_taper). + - offset: Offset of the rule (float for cutoff_rule_type=`geometry` or taper, LookUpTableColumn for cutoff_rule_type=`variable_taper`). + - angle: Angle of the rule (ignored for cutoff_rule_type=`geometry`, float for taper, LookUpTableColumn for variable_taper). - origin: Origin of the offset and angle interpolation for variable_taper. - direction: Direction of the offset and angle interpolation for variable_taper. - distance_type: along_direction or along_edge (only relevant for variable_taper). - ply_cutoff_type: Determines on which ply level the cutoff is done. - ply_tapering: Use ply tapering. - - cutoff_geometry: CADGeometry for the rule (only relevant for cutoff_rule_type=\`geometry\`). - - edge_set: Edge Set for cutoff_rule_type=\`taper\` or variable_taper. + - cutoff_geometry: CADGeometry for the rule (only relevant for cutoff_rule_type=`geometry`). + - edge_set: Edge Set for cutoff_rule_type=`taper` or `variable_taper`. - offset_method: Method to compute offset of plies laminate_stack or attached_plies. - offset_type: Measure offset from edge set normal to element reference surface (out_of_plane) or in element reference surface (in_plane). * **Returns:** diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_edge_set.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_edge_set.md index c0fe78e885..b5ad074d9d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_edge_set.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_edge_set.md @@ -8,10 +8,10 @@ Create a new edge set. * **Parameters:** - name: Name of the edge set. - - edge_set_type: Valid options: ‘By Nodes’, ‘By Reference’, and ‘Imported’ (only for imported edge sets). + - edge_set_type: Available options: `By Nodes`, `By Reference`, and `Imported` (only for imported edge sets). - origin: Origin. - limit_angle: The edge set is cropped if the angle between two element edges exceeds this limit. Use -1 to disable it. - element_set: Element set. - - node_labels: List of nodes defining the edge set (only if edge_set_type=’By Nodes’). + - node_labels: List of nodes defining the edge set (only if edge_set_type= `By Nodes`). * **Returns:** The created edge set. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_element_set.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_element_set.md index a100b66341..0267f46437 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_element_set.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_element_set.md @@ -13,7 +13,7 @@ Create a new element set. - x: X-range to select. - y: Y-range to select. - z: Z-range to select. - - op: Select operation. Valid options: all, new (default), add, remove, intersect, inverse, and none. + - op: Select operation. Available options: all, new (default), add, remove, intersect, inverse, and none. - middle_offset: Boolean to enforce that the laminate mid-plane is moved onto the reference surface. * **Returns:** The created element set. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_geometrical_selection_rule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_geometrical_selection_rule.md index d8bc806357..a7aed366df 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_geometrical_selection_rule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_geometrical_selection_rule.md @@ -8,15 +8,15 @@ Create new geometrical selection rule. * **Parameters:** - name: Name of the rule. - - geometrical_rule_type: Define whether the rule extent is defined by a geometry of element sets. Valid options: ‘geometry’ (default) or ‘element_sets’. + - geometrical_rule_type: Define whether the rule extent is defined by a geometry of element sets. Available options: `geometry` (default) or `element_sets`. - use_defaults: Whether to use the offset value of the CAD geometry. - in_plane_capture_tolerance: In-plane extend (extend) if CAD geometry is a surface. - neg_capture_tolerance: Offset in the negative direction if CAD geometry is a surface. - pos_capture_tolerance: Offset in the positive direction if CAD geometry is a surface. - include_rule_type: Whether the selection is inside or outside the CAD geometry. - - geometry: CAD geometry used to determine the selection (only relevant for geometrical_rule_type=\`geometry\`). + - geometry: CAD geometry used to determine the selection (only relevant for geometrical_rule_type=`geometry`). - use_projection_normal: Boolean on whether to use the projection normal. - projection_normal: Normal direction used to map elements on outlines/curves. - - element_sets: Preselection of elements in the form of an element set where the rule is applied on (only relevant for geometrical_rule_type=\`element_sets\`). + - element_sets: Preselection of elements in the form of an element set where the rule is applied on (only relevant for geometrical_rule_type=`element_sets`). * **Returns:** The created rule. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_lookup_table3d.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_lookup_table3d.md index f32c9d30d5..ff8931a6e0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_lookup_table3d.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_lookup_table3d.md @@ -11,7 +11,7 @@ Create a new 3D look-up table object. - id : ID - tabular_data: data points and values of the look-up table - algorithm_type: specify which algorithm type is used for the interpolation - - use_default_search_radius: force the program to use the default search radius. Used for the algorithm weighted_nearest_neighbor”. + - use_default_search_radius: force the program to use the default search radius. Used for the algorithm weighted_nearest_neighbor. - search_radius: set a custom search radius. Used if use_default_search_radius is false. Used for the algorithm weighted_nearest_neighbor. - dimensions: list of the dimensions of the columns (e.g. length for coordinates) - use_global_coordinate_system: Boolean telling if we want to use the global coordinate system or not. It is possible to pass a Rosette but still use the global one. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_oriented_selection_set.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_oriented_selection_set.md index 2a0da5f9bc..322e8c635f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_oriented_selection_set.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_oriented_selection_set.md @@ -15,10 +15,10 @@ Create a new oriented selection set. - geometries: Virtual geometries. - rosettes: Rosettes for the oriented selection set. - rosette_selection_method: Method to calculate element orientation - : (‘minimum_angle’, ‘maximum_angle’, ‘minimum_distance’, - ‘minimum_angle_superposed’, ‘minimum_distance_superposed’, - ‘maximum_angle_superposed’, ‘ansys_classic’, or - ‘tabular_values’). + : (`minimum_angle`, `maximum_angle`, `minimum_distance`, + `minimum_angle_superposed`, `minimum_distance_superposed`, + `maximum_angle_superposed`, `ansys_classic`, or + `tabular_values`). - reference_direction_field: Table column used to compute reference directions. - draping: Draping enabled. - draping_seed_point: Seed point used to start draping. @@ -26,7 +26,7 @@ Create a new oriented selection set. - auto_draping_direction: Generate direction for draping. - draping_mesh_size: Mesh size for draping. - use_default_draping_mesh_size: Enable this property to use the default size for the draping mesh. The default is the average element size of the shell mesh. - - draping_material_model: Material model for draping, either ‘woven’ or ‘unidirectional’. + - draping_material_model: Material model for draping, either `woven` or `unidirectional`. - draping_ud_coefficient: Coefficient for the unidirectional draping material model. - rotation_angle: Angle to rotate the reference directions around the orientation directions (in degree). * **Returns:** diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_published_parameter.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_published_parameter.md index b2d05ba92e..119f25f00a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_published_parameter.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_published_parameter.md @@ -11,7 +11,7 @@ Create a published parameter. - source_object: Name of the object the parameter is linked to. - source_property: Property of the linked object the parameter controls. - user_script: Script to be executed for determining the parameter value. Only used when category==”expression_output”. - - category: Controls the behavior of the parameter. Valid options: input, unbound_input, output, and expression_output. + - category: Controls the behavior of the parameter. Available options: `input`, `unbound_input`, `output`, and `expression_output`. - acp_type: Type of the parameter, as used within ACP. - description: String description of the parameter. - lower_limit: The lower limit for numeric values. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_rosette.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_rosette.md index 11167cefab..8093f01457 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_rosette.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_rosette.md @@ -12,7 +12,7 @@ Create a new rosette. - origin: The origin of the rosette. - dir1: Direction 1 of the rosette. - dir2: Direction 2 of the rosette. - - rosette_type: Type of the rosette (‘PARALLEL’, ‘RADIAL’, ‘CYLINDRICAL’, ‘SPHERICAL’, or ‘EDGE_WISE’). + - rosette_type: Type of the rosette (`PARALLEL`, `RADIAL`, `CYLINDRICAL`, `SPHERICAL`, or `EDGE_WISE`). - edge_set: Edge set to be used in rosette. - show: Whether the newly created rosette is shown in the scene or 3D window. * **Returns:** diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_script.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_script.md index 5c6e0e85b5..4d3a6d44ee 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_script.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_script.md @@ -12,8 +12,8 @@ Creates a script object, which allows executing custom Python code. - active: If False, the script will not be executed. - uptodate: Whether the script currently needs to be executed. - update_mode: Defines which changes cause the script to become. - : out-of-date. Valid options: ‘manual’ (run only when manually - triggered), ‘on_triggers’ (run when a parameter or the script - itself changes), and ‘always’ (run with every update). + : out-of-date. Available options: `manual` (run only when manually + triggered), `on_triggers` (run when a parameter or the script + itself changes), and `always` (run with every update). * **Returns:** The created script object. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_sensor.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_sensor.md index 9efe071b74..418ba733b0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_sensor.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_sensor.md @@ -9,7 +9,7 @@ Create new sensor. * **Parameters:** - name: Name of the rule. - active: Whether the sensor is active. - - sensor_type: Type of sensor. Valid options: SENSOR_BY_AREA, SENSOR_BY_MATERIAL, and SENSOR_BY_PLIES. + - sensor_type: Type of sensor. Available options: `SENSOR_BY_AREA`, `SENSOR_BY_MATERIAL`, and `SENSOR_BY_PLIES`. - entities: Entities of the sensor. * **Returns:** The created sensor. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_solid_model.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_solid_model.md index d2de282101..d360894441 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_solid_model.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_solid_model.md @@ -12,17 +12,17 @@ Create a new solid model. - active: Active status of the solid model. - element_sets: A list of element sets. - ex_type: - Extrusion method. Possible values are: - \* monolithic (1 element through the thickness) - \* analysis_ply_wise (1 element per layer) - \* modeling_ply_wise (1 element for each modeling ply) - \* production_ply_wise (1 element for each production ply) - \* specify_thickness (1 element per layer, layers thicker than max_thickness are split to several solids of at most max_thickness) - \* user_defined (groups plies by global ply numbers to groups) - \* material_wise (groups subsequent plies with equal material) - - drop_off_type: Valid options: inside ply (one element inside the ply boundary) and outside ply (one element outside the ply boundary). - - offset_type: Valid options: shell normal (offset to the shell normal), surface normal (update normal direction by normal of layered solids), and distortion controlled (surface normal with local corrections). - - max_thickness: Maximum thickness for one solid, splits the layer into more solids, if a single layer is thicker than this value (only for ex_type=\`specify thickness\`). + Extrusion method. Available options are: + * `monolithic` (1 element through the thickness) + * `analysis_ply_wise` (1 element per layer) + * `modeling_ply_wise` (1 element for each modeling ply) + * `production_ply_wise` (1 element for each production ply) + * `specify_thickness` (1 element per layer, layers thicker than max_thickness are split to several solids of at most max_thickness) + * `user_defined` (groups plies by global ply numbers to groups) + * `material_wise` (groups subsequent plies with equal material) + - drop_off_type: Available options: `inside ply` (one element inside the ply boundary) and `outside ply` (one element outside the ply boundary). + - offset_type: Available options: `shell normal` (offset to the shell normal), `surface normal` (update normal direction by normal of layered solids), and `distortion controlled` (surface normal with local corrections). + - max_thickness: Maximum thickness for one solid, splits the layer into more solids, if a single layer is thicker than this value (only for ex_type=`specify thickness`). - ply_group_pointers: Step used to make user-defined ply groups. - element_set: (deprecated, use element_sets instead) A single element set. - skip_elements_without_plies: Whether to remove elements without plies from the region of extrusion. @@ -48,10 +48,10 @@ Create a new solid model. - delete_bad_elements: Boolean for whether to delete the erroneous elements. - disable_dropoffs_on_top: Boolean for whether to disalbe the drop-off elements on the top surface of the laminate. - disable_dropoffs_on_bottom: Boolean for whether to disalbe the drop-off elements on the bottom surface of the laminate. - - disable_dropoff_sets_on_top: List of element or oriented selection sets defining the region where the drop-offs are disabled on the top skin of the laminate. Default is ‘all’. - - disable_dropoff_sets_on_bottom: List of element or oriented selection sets defining the region where the drop-offs are disabled on the bottom skin of the laminate. Default is ‘all’. + - disable_dropoff_sets_on_top: List of element or oriented selection sets defining the region where the drop-offs are disabled on the top skin of the laminate. Default is `all`. + - disable_dropoff_sets_on_bottom: List of element or oriented selection sets defining the region where the drop-offs are disabled on the bottom skin of the laminate. Default is `all`. - warping_limit: Warping limit factor used to detect erroneous elements. - - minimum_volume: Minimum volume of solid elements. Default is ‘0’. Elements equal or smaller than this limit are removed from the solid model. + - minimum_volume: Minimum volume of solid elements. Default is `0`. Elements equal or smaller than this limit are removed from the solid model. - drop_hanging_nodes: Hanging nodes are dropped (not exported) if set to true. Hanging nodes are mid-side nodes that are not shared by adjacent elements. * **Returns:** The created solid model. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_variable_offset_selection_rule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_variable_offset_selection_rule.md index 20169c62b6..e8879d6eb7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_variable_offset_selection_rule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.create_variable_offset_selection_rule.md @@ -17,7 +17,7 @@ Create new slab offset rule. - element_set: Preselection of elements in the form of an element set where the rule is applied on. - include_rule_type: Boolean whether to select the element inside or outside the variable tube. - use_offset_correction: Boolean whether to evaluate the radius/offset along the surface. - - distance_along_edge: Boolean whether to evaluate the distance along the edge or direction of the rule. Default is ‘False’. - - inherit_from_lookup_table: Boolean whether to inherit origin and direction from the attached lookup table. Default is ‘False’. + - distance_along_edge: Boolean whether to evaluate the distance along the edge or direction of the rule. Default is `False`. + - inherit_from_lookup_table: Boolean whether to inherit origin and direction from the attached lookup table. Default is `False`. * **Returns:** The created rule. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.export_composite_cae_h5.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.export_composite_cae_h5.md index c38432130b..8f906eb276 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.export_composite_cae_h5.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.export_composite_cae_h5.md @@ -6,14 +6,14 @@ Export layup to composite CAE .hdf5 file. -> * **parameters:** -> - path: Save path of the .h5 file. -> - remove_midside_nodes: Whether midside nodes should be exported. -> - layup_representation_3d: Whether to compute the 3D layup representation of the model. See note. -> - offset_type: Specifies the ply surface to export. Valid options: bottom_offset, middle_offset, and top_offset. -> - element_sets: A list of element sets and/or oriented selection sets. Only plies defined over the selected elements will be exported. If empty list or none, then all elements will be considered. -> - modeling_plies: A list of modeling plies and/or modeling groups. If empty list or none, then all modeling plies will be exported. -> - ascii_encoding: If True, set the .hdf5 data type for strings to H5T_CSET_ASCII. Note that the string contents will be UTF-8 encoded regardless of this setting, meaning the content will only be well-defined ASCII if the ACP object names do not contain unicode characters outside the ASCII range. This option is added for compatibility with readers which may not support the H5T_CSET_UTF8 data type. + * **parameters:** + - path: Save path of the .h5 file. + - remove_midside_nodes: Whether midside nodes should be exported. + - layup_representation_3d: Whether to compute the 3D layup representation of the model. See note. + - offset_type: Specifies the ply surface to export. Valid options: bottom_offset, middle_offset, and top_offset. + - element_sets: A list of element sets and/or oriented selection sets. Only plies defined over the selected elements will be exported. If empty list or none, then all elements will be considered. + - modeling_plies: A list of modeling plies and/or modeling groups. If empty list or none, then all modeling plies will be exported. + - ascii_encoding: If True, set the .hdf5 data type for strings to H5T_CSET_ASCII. Note that the string contents will be UTF-8 encoded regardless of this setting, meaning the content will only be well-defined ASCII if the ACP object names do not contain unicode characters outside the ASCII range. This option is added for compatibility with readers which may not support the H5T_CSET_UTF8 data type. Note about layup_representation_3d: The 3D layup representation contains the offset ply surfaces where the bottom offset of each ply is exported. The computation can take a while depending on the model size diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.export_ply_geometries.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.export_ply_geometries.md index fbd45af65a..e0a271d11b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.export_ply_geometries.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.export_ply_geometries.md @@ -7,15 +7,15 @@ Exports the surface, boundary, and/or fiber directions of modeling, production, and analysis ply to .igs or .step file. * **Parameters:** - - filename: File path (valid extensions are iges, igs, step, stp, and stl). - - plies: List of plies (valid options are modeling, production, and analysis plies). - - boundary: Boolean whether to export the boundary. Default is ‘True’. - - surface: Boolean whether to export the ply surface. Default is ‘True’. - - offset_type: Offset type. Valid types: ‘no_offset’, ‘middle_offset’ (default), ‘top_offset’, and ‘bottom_offset’. - - direction_arrows: Boolean whether to export the direction arrows. Default is ‘False’. - - first_direction: Boolean whether to export the first (main) material direction. Default is ‘True’. - - second_direction: Boolean whether to export the second material direction. Default is ‘False’. - - arrow_length: Length of the arrows. Default is ‘1’. - - arrow_type: Defines the arrow type. Valid types: ‘standard_arrow’, ‘no_arrow’ (default), and ‘half_arrow’. + - filename: File path (available extensions are `iges`, `igs`, `step`, `stp`, and `stl`). + - plies: List of plies (available options are `modeling`, `production`, and `analysis plies`). + - boundary: Boolean whether to export the boundary. Default is `True`. + - surface: Boolean whether to export the ply surface. Default is `True`. + - offset_type: Offset type. Available types: `no_offset`, `middle_offset` (default), `top_offset`, and `bottom_offset`. + - direction_arrows: Boolean whether to export the direction arrows. Default is `False`. + - first_direction: Boolean whether to export the first (main) material direction. Default is `True`. + - second_direction: Boolean whether to export the second material direction. Default is `False`. + - arrow_length: Length of the arrows. Default is `1`. + - arrow_type: Defines the arrow type. Available types: `standard_arrow`, `no_arrow` (default), and `half_arrow`. Note: Directions and boundaries are not supported by the STL format. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.format.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.format.md index 0db6c0f007..12cdf6eb24 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.format.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.format.md @@ -4,4 +4,4 @@ #### *property* Model.format -File format string. Choose one of ‘ansys:h5’, ‘ansys:cdb’, ‘ansys:dat’ or ‘layup’ +File format string. Choose one of `ansys:h5`, `ansys:cdb`, `ansys:dat`, or `layup` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup.md index 3e9003cf32..4a57de2bad 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup.md @@ -7,7 +7,7 @@ Load layup from excel or .csv file. * **Parameters:** - - mode: Valid options: - : update_properties_only: Definitions are updated with properties given. - update_entities: Definitions are updated, additional plies are generated and deleted. - recreate: Existing layup is deleted generated from scratch. + - mode: Available options: + - `update_properties_only`: Definitions are updated with properties given. + - `update_entities`: Definitions are updated, additional plies are generated and deleted. + - `recreate`: Existing layup is deleted generated from scratch. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup_from_csv_file.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup_from_csv_file.md index 435d5c4d20..3b53e06413 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup_from_csv_file.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup_from_csv_file.md @@ -9,8 +9,8 @@ Function that reads the layup data from a .csv file and adds the data to the gra * **Parameters:** - objects: List of objects to be synced. - path: The path to the file. - - mode: Valid options: - : update_properties_only: Definitions are updated with properties given. - update_entities: Definitions are updated, additional plies are generated and deleted. - recreate: Existing layup is deleted generated from scratch. + - mode: Available options: + - `update_properties_only`: Definitions are updated with properties given. + - `update_entities`: Definitions are updated, additional plies are generated and deleted. + - `recreate`: Existing layup is deleted generated from scratch. - modeling_group: Key of the mpg_collection dict equals the ID of the mpg. Only plies of this modeling_group will be imported from the file if none is specified all mpgs are read. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup_from_excel_file.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup_from_excel_file.md index e768b8c359..bc18549e14 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup_from_excel_file.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.get_layup_from_excel_file.md @@ -9,8 +9,7 @@ Load layup from Excel File. * **Parameters:** - path: Path to file to load. - objects: Objects to be loaded and overwritten. - - mode: Valid options: - : > update_properties_only: Definitions are updated with properties given. -
- update_entities: Definitions are updated, additional plies are generated and deleted. - recreate: Existing layup is deleted generated from scratch. + - mode: Available options: + - `update_properties_only`: Definitions are updated with properties given. + - `update_entities`: Definitions are updated, additional plies are generated and deleted. + - `recreate`: Existing layup is deleted generated from scratch. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.import_section_data_from_legacy_model.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.import_section_data_from_legacy_model.md index 0e144e103a..7fa6066ac5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.import_section_data_from_legacy_model.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.import_section_data_from_legacy_model.md @@ -10,14 +10,14 @@ The mapping is based on the element labels and therefore it is a requirement tha the element labels in the legacy and ACP model match. The import is only performed if the file and ACP Model units are consistent. * **Parameters:** - - path: File path. Supported file extensions are CDB, DAT, and INP. - - format: File format. Supported are ‘ansys:cdb’ and ‘ansys:dat’. + - path: File path. Supported file extensions are `CDB`, `DAT`, and `INP`. + - format: File format. Supported are `ansys:cdb` and `ansys:dat`. - materials_mask_prefix: Defines the prefix that is added to the Material ID while importing materials via ExternalModel. - materials_mask_suffix: Defines the suffix that is added to the Material ID while importing materials via ExternalModel. * **Materials mapping:** Only relevant when the import happens within the Workbench application. The materials mask prefix and suffix parameters enable automatic mapping of the Workbench application’s material and legacy material IDs. - For instance the prefix and suffix, MAT1 and \` (Setup, File1)\` enable mapping MAT1 (Setup, File1) with legacy material 1. + For instance the prefix and suffix, MAT1 and `(Setup, File1)` enable mapping MAT1 (Setup, File1) with legacy material 1. The mapping is case independent. Pass empty mapping masks when no mapping is needed. * **Example:** diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.is_dict_item.md index e442c81eb2..5025ffd437 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* Model.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.is_list_item.md index cdc5a1a818..d95174a3a5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.is_list_item.md @@ -4,4 +4,4 @@ #### *property* Model.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.md index fb2ec03e01..203c59158f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.md @@ -27,41 +27,41 @@ Get existing model: | [`Model.active_scene`](compolyx.Model.active_scene.md#compolyx.Model.active_scene) | Active Scene | | [`Model.analysis_model_path`](compolyx.Model.analysis_model_path.md#compolyx.Model.analysis_model_path) | Analysis model file path | | [`Model.angle_tolerance`](compolyx.Model.angle_tolerance.md#compolyx.Model.angle_tolerance) | Section computation angle tolerance (in degree) | -| [`Model.cache_update_results`](compolyx.Model.cache_update_results.md#compolyx.Model.cache_update_results) | Define whether to store the update results or not. | +| [`Model.cache_update_results`](compolyx.Model.cache_update_results.md#compolyx.Model.cache_update_results) | Define whether to store the update results or not | | [`Model.definitions`](compolyx.Model.definitions.md#compolyx.Model.definitions) | Definitions | -| [`Model.deformation_scale_factor`](compolyx.Model.deformation_scale_factor.md#compolyx.Model.deformation_scale_factor) | Factor with which the deformed shape plot is scaled. | -| [`Model.draping_offset_correction`](compolyx.Model.draping_offset_correction.md#compolyx.Model.draping_offset_correction) | Define whether to consider lay-up thickness in draping analysis. | -| [`Model.edge_sets`](compolyx.Model.edge_sets.md#compolyx.Model.edge_sets) | Dictionary with all Edge Sets defined. | -| [`Model.element_sets`](compolyx.Model.element_sets.md#compolyx.Model.element_sets) | Dictionary with all Element Sets defined. | +| [`Model.deformation_scale_factor`](compolyx.Model.deformation_scale_factor.md#compolyx.Model.deformation_scale_factor) | Factor with which the deformed shape plot is scaled | +| [`Model.draping_offset_correction`](compolyx.Model.draping_offset_correction.md#compolyx.Model.draping_offset_correction) | Define whether to consider lay-up thickness in draping analysis | +| [`Model.edge_sets`](compolyx.Model.edge_sets.md#compolyx.Model.edge_sets) | Dictionary with all Edge Sets defined | +| [`Model.element_sets`](compolyx.Model.element_sets.md#compolyx.Model.element_sets) | Dictionary with all Element Sets defined | | [`Model.enabled`](compolyx.Model.enabled.md#compolyx.Model.enabled) | | | [`Model.excel_path`](compolyx.Model.excel_path.md#compolyx.Model.excel_path) | | -| [`Model.field_definitions`](compolyx.Model.field_definitions.md#compolyx.Model.field_definitions) | Dictionary with all defined field definitions. | -| [`Model.force_disable_result_extrapolation`](compolyx.Model.force_disable_result_extrapolation.md#compolyx.Model.force_disable_result_extrapolation) | Force the result extrapolation to be disabled ('ERESX,NO' command) when exporting to APDL or CDB format. | +| [`Model.field_definitions`](compolyx.Model.field_definitions.md#compolyx.Model.field_definitions) | Dictionary with all defined field definitions | +| [`Model.force_disable_result_extrapolation`](compolyx.Model.force_disable_result_extrapolation.md#compolyx.Model.force_disable_result_extrapolation) | Force the result extrapolation to be disabled ('ERESX,NO' command) when exporting to APDL or CDB format | | [`Model.format`](compolyx.Model.format.md#compolyx.Model.format) | File format string. | | [`Model.geometry`](compolyx.Model.geometry.md#compolyx.Model.geometry) | Geometry node | -| [`Model.is_dict_item`](compolyx.Model.is_dict_item.md#compolyx.Model.is_dict_item) | Specifies wether the object is an item of a dict | -| [`Model.is_list_item`](compolyx.Model.is_list_item.md#compolyx.Model.is_list_item) | Specifies wether the object is an item of a list | +| [`Model.is_dict_item`](compolyx.Model.is_dict_item.md#compolyx.Model.is_dict_item) | Specifies whether the object is an item of a dict | +| [`Model.is_list_item`](compolyx.Model.is_list_item.md#compolyx.Model.is_list_item) | Specifies whether the object is an item of a list | | [`Model.layup_plots`](compolyx.Model.layup_plots.md#compolyx.Model.layup_plots) | Plots | | [`Model.link_path`](compolyx.Model.link_path.md#compolyx.Model.link_path) | Root path of the current node in the tree for links to this object | | [`Model.lookup_tables`](compolyx.Model.lookup_tables.md#compolyx.Model.lookup_tables) | Dictionary with all Look-Up Tables | -| [`Model.material_data`](compolyx.Model.material_data.md#compolyx.Model.material_data) | Dictionary with all Material Data defined. | +| [`Model.material_data`](compolyx.Model.material_data.md#compolyx.Model.material_data) | Dictionary with all Material Data defined | | [`Model.mesh`](compolyx.Model.mesh.md#compolyx.Model.mesh) | Mesh of this model | | [`Model.minimum_analysis_ply_thickness`](compolyx.Model.minimum_analysis_ply_thickness.md#compolyx.Model.minimum_analysis_ply_thickness) | Section computation minimum analysis ply thickness (in length unit of model) | -| [`Model.modeling_groups`](compolyx.Model.modeling_groups.md#compolyx.Model.modeling_groups) | Dictionary with all Modeling Groups defined. | +| [`Model.modeling_groups`](compolyx.Model.modeling_groups.md#compolyx.Model.modeling_groups) | Dictionary with all Modeling Groups defined | | [`Model.name`](compolyx.Model.name.md#compolyx.Model.name) | Name of object | | [`Model.oriented_selection_sets`](compolyx.Model.oriented_selection_sets.md#compolyx.Model.oriented_selection_sets) | Dictionary with all oriented element sets defined. | -| [`Model.parameters`](compolyx.Model.parameters.md#compolyx.Model.parameters) | List of parameters visible to the workbench | +| [`Model.parameters`](compolyx.Model.parameters.md#compolyx.Model.parameters) | List of parameters visible to the Workbench application | | [`Model.parent`](compolyx.Model.parent.md#compolyx.Model.parent) | Parent object in tree | -| [`Model.path`](compolyx.Model.path.md#compolyx.Model.path) | Path to the reference surface input file. | +| [`Model.path`](compolyx.Model.path.md#compolyx.Model.path) | Path to the reference surface input file | | [`Model.plybook`](compolyx.Model.plybook.md#compolyx.Model.plybook) | PlyBook | | [`Model.pre_path`](compolyx.Model.pre_path.md#compolyx.Model.pre_path) | Save path of pre database linked to currently loaded post database | | [`Model.ratio_of_displayed_vectors`](compolyx.Model.ratio_of_displayed_vectors.md#compolyx.Model.ratio_of_displayed_vectors) | | -| [`Model.reference_surface_bounding_box`](compolyx.Model.reference_surface_bounding_box.md#compolyx.Model.reference_surface_bounding_box) | Tuple with corners of bounding box of reference surface mesh. | -| [`Model.reference_surface_input_unit_system_locked`](compolyx.Model.reference_surface_input_unit_system_locked.md#compolyx.Model.reference_surface_input_unit_system_locked) | If the unit system of the reference surface is not defined in the mesh input, the unit system can be changed. | +| [`Model.reference_surface_bounding_box`](compolyx.Model.reference_surface_bounding_box.md#compolyx.Model.reference_surface_bounding_box) | Tuple with corners of bounding box of reference surface mesh | +| [`Model.reference_surface_input_unit_system_locked`](compolyx.Model.reference_surface_input_unit_system_locked.md#compolyx.Model.reference_surface_input_unit_system_locked) | If the unit system of the reference surface is not defined in the mesh input, the unit system can be changed | | [`Model.reference_surface_input_unit_system_type`](compolyx.Model.reference_surface_input_unit_system_type.md#compolyx.Model.reference_surface_input_unit_system_type) | Unit System of the Reference Surface Input File | | [`Model.relative_thickness_tolerance`](compolyx.Model.relative_thickness_tolerance.md#compolyx.Model.relative_thickness_tolerance) | Section computation relative thickness tolerance | | [`Model.root_path`](compolyx.Model.root_path.md#compolyx.Model.root_path) | Root path of the current node in the tree | -| [`Model.rosettes`](compolyx.Model.rosettes.md#compolyx.Model.rosettes) | Dictionary with all Rosettes defined. | +| [`Model.rosettes`](compolyx.Model.rosettes.md#compolyx.Model.rosettes) | Dictionary with all Rosettes defined | | [`Model.sampling_points`](compolyx.Model.sampling_points.md#compolyx.Model.sampling_points) | Sampling Point Container | | [`Model.save_path`](compolyx.Model.save_path.md#compolyx.Model.save_path) | | | [`Model.scenes`](compolyx.Model.scenes.md#compolyx.Model.scenes) | Scenes | @@ -70,15 +70,15 @@ Get existing model: | [`Model.selection`](compolyx.Model.selection.md#compolyx.Model.selection) | Selected objects of this model | | [`Model.selection_rules`](compolyx.Model.selection_rules.md#compolyx.Model.selection_rules) | Dictionary with all Selection Rules defined. | | [`Model.sensors`](compolyx.Model.sensors.md#compolyx.Model.sensors) | Dictionary with all Sensors. | -| [`Model.show_deformed`](compolyx.Model.show_deformed.md#compolyx.Model.show_deformed) | Whether to show result plots in the deformed and scaled configuration. | -| [`Model.show_solver_elements`](compolyx.Model.show_solver_elements.md#compolyx.Model.show_solver_elements) | Whether mesh selections and plot should consider solver elements in solid models or not. | +| [`Model.show_deformed`](compolyx.Model.show_deformed.md#compolyx.Model.show_deformed) | Whether to show result plots in the deformed and scaled configuration | +| [`Model.show_solver_elements`](compolyx.Model.show_solver_elements.md#compolyx.Model.show_solver_elements) | Whether mesh selections and plot should consider solver elements in solid models or not | | [`Model.solid_models`](compolyx.Model.solid_models.md#compolyx.Model.solid_models) | SolidModel | | [`Model.solutions`](compolyx.Model.solutions.md#compolyx.Model.solutions) | Solutions | | [`Model.solver`](compolyx.Model.solver.md#compolyx.Model.solver) | Solver instance | | [`Model.status_changed_controller`](compolyx.Model.status_changed_controller.md#compolyx.Model.status_changed_controller) | | -| [`Model.unit_system`](compolyx.Model.unit_system.md#compolyx.Model.unit_system) | Create a unit system and assign it to the model. | -| [`Model.use_default_section_tolerances`](compolyx.Model.use_default_section_tolerances.md#compolyx.Model.use_default_section_tolerances) | Boolean whether to uses angle and thickness tolerances of the application preferences for section computation. | -| [`Model.use_nodal_thicknesses`](compolyx.Model.use_nodal_thicknesses.md#compolyx.Model.use_nodal_thicknesses) | Define whether to use nodal thicknesses or element thicknesses. | +| [`Model.unit_system`](compolyx.Model.unit_system.md#compolyx.Model.unit_system) | Create a unit system and assign it to the model | +| [`Model.use_default_section_tolerances`](compolyx.Model.use_default_section_tolerances.md#compolyx.Model.use_default_section_tolerances) | Boolean whether to uses angle and thickness tolerances of the application preferences for section computation | +| [`Model.use_nodal_thicknesses`](compolyx.Model.use_nodal_thicknesses.md#compolyx.Model.use_nodal_thicknesses) | Define whether to use nodal thicknesses or element thicknesses | | [`Model.vector_scale_factor`](compolyx.Model.vector_scale_factor.md#compolyx.Model.vector_scale_factor) | | | [`Model.views`](compolyx.Model.views.md#compolyx.Model.views) | Views | | [`Model.workbench_state`](compolyx.Model.workbench_state.md#compolyx.Model.workbench_state) | | @@ -87,87 +87,87 @@ Get existing model: | Name | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| -| [`Model.add_solution`](compolyx.Model.add_solution.md#compolyx.Model.add_solution)(name[, id, path, path2, ...]) | Load a nodal solution from file(s) and add it to the model. | -| [`Model.add_winding_entities`](compolyx.Model.add_winding_entities.md#compolyx.Model.add_winding_entities)(axial_direction, ...) | Generates a winding layup for an axisymmetric body. | -| [`Model.average_element_size`](compolyx.Model.average_element_size.md#compolyx.Model.average_element_size)() | Average element size of the model. | +| [`Model.add_solution`](compolyx.Model.add_solution.md#compolyx.Model.add_solution)(name[, id, path, path2, ...]) | Load a nodal solution from file(s) and add it to the model | +| [`Model.add_winding_entities`](compolyx.Model.add_winding_entities.md#compolyx.Model.add_winding_entities)(axial_direction, ...) | Generates a winding layup for an axisymmetric body | +| [`Model.average_element_size`](compolyx.Model.average_element_size.md#compolyx.Model.average_element_size)() | Average element size of the model | | [`Model.coordinate_system_arrow_length`](compolyx.Model.coordinate_system_arrow_length.md#compolyx.Model.coordinate_system_arrow_length)() | | -| [`Model.copy_combined_failure_criteria`](compolyx.Model.copy_combined_failure_criteria.md#compolyx.Model.copy_combined_failure_criteria)(source) | Copy a combined failure criteria definition. | -| [`Model.copy_edge_set`](compolyx.Model.copy_edge_set.md#compolyx.Model.copy_edge_set)(source) | Copy a edge set. | -| [`Model.copy_element_set`](compolyx.Model.copy_element_set.md#compolyx.Model.copy_element_set)(source) | Copy an element set. | -| [`Model.copy_field_definition`](compolyx.Model.copy_field_definition.md#compolyx.Model.copy_field_definition)(source) | Copy a FieldDefinition. | -| [`Model.copy_lookup_table`](compolyx.Model.copy_lookup_table.md#compolyx.Model.copy_lookup_table)(source) | Copy a look-up table. | -| [`Model.copy_oriented_selection_set`](compolyx.Model.copy_oriented_selection_set.md#compolyx.Model.copy_oriented_selection_set)(source) | Copy an oriented element set. | -| [`Model.copy_rosette`](compolyx.Model.copy_rosette.md#compolyx.Model.copy_rosette)(source) | Copy a rosette. | -| [`Model.copy_sampling_point`](compolyx.Model.copy_sampling_point.md#compolyx.Model.copy_sampling_point)(source) | Copy a sampling point. | -| [`Model.copy_section_cut`](compolyx.Model.copy_section_cut.md#compolyx.Model.copy_section_cut)(source) | Copy a section cut. | -| [`Model.copy_selection_rule`](compolyx.Model.copy_selection_rule.md#compolyx.Model.copy_selection_rule)(source) | Copy a rule. | -| [`Model.copy_sensor`](compolyx.Model.copy_sensor.md#compolyx.Model.copy_sensor)(source) | Copy a sensor. | -| [`Model.copy_solid_model`](compolyx.Model.copy_solid_model.md#compolyx.Model.copy_solid_model)(source) | Copy a solid model. | -| [`Model.create_boolean_selection_rule`](compolyx.Model.create_boolean_selection_rule.md#compolyx.Model.create_boolean_selection_rule)(name[, ...]) | Create a new boolean selection rule. | -| [`Model.create_combined_failure_criteria`](compolyx.Model.create_combined_failure_criteria.md#compolyx.Model.create_combined_failure_criteria)(name) | Create a combined failure criteria. | +| [`Model.copy_combined_failure_criteria`](compolyx.Model.copy_combined_failure_criteria.md#compolyx.Model.copy_combined_failure_criteria)(source) | Copy a combined failure criteria definition | +| [`Model.copy_edge_set`](compolyx.Model.copy_edge_set.md#compolyx.Model.copy_edge_set)(source) | Copy a edge set | +| [`Model.copy_element_set`](compolyx.Model.copy_element_set.md#compolyx.Model.copy_element_set)(source) | Copy an element set | +| [`Model.copy_field_definition`](compolyx.Model.copy_field_definition.md#compolyx.Model.copy_field_definition)(source) | Copy a FieldDefinition | +| [`Model.copy_lookup_table`](compolyx.Model.copy_lookup_table.md#compolyx.Model.copy_lookup_table)(source) | Copy a lookup table | +| [`Model.copy_oriented_selection_set`](compolyx.Model.copy_oriented_selection_set.md#compolyx.Model.copy_oriented_selection_set)(source) | Copy an oriented element set | +| [`Model.copy_rosette`](compolyx.Model.copy_rosette.md#compolyx.Model.copy_rosette)(source) | Copy a rosette | +| [`Model.copy_sampling_point`](compolyx.Model.copy_sampling_point.md#compolyx.Model.copy_sampling_point)(source) | Copy a sampling point | +| [`Model.copy_section_cut`](compolyx.Model.copy_section_cut.md#compolyx.Model.copy_section_cut)(source) | Copy a section cut | +| [`Model.copy_selection_rule`](compolyx.Model.copy_selection_rule.md#compolyx.Model.copy_selection_rule)(source) | Copy a rule | +| [`Model.copy_sensor`](compolyx.Model.copy_sensor.md#compolyx.Model.copy_sensor)(source) | Copy a sensor | +| [`Model.copy_solid_model`](compolyx.Model.copy_solid_model.md#compolyx.Model.copy_solid_model)(source) | Copy a solid model | +| [`Model.create_boolean_selection_rule`](compolyx.Model.create_boolean_selection_rule.md#compolyx.Model.create_boolean_selection_rule)(name[, ...]) | Create a new boolean selection rule | +| [`Model.create_combined_failure_criteria`](compolyx.Model.create_combined_failure_criteria.md#compolyx.Model.create_combined_failure_criteria)(name) | Create a combined failure criteria | | [`Model.create_combined_solution`](compolyx.Model.create_combined_solution.md#compolyx.Model.create_combined_solution)([name, solutions]) | | -| [`Model.create_cutoff_selection_rule`](compolyx.Model.create_cutoff_selection_rule.md#compolyx.Model.create_cutoff_selection_rule)(name[, ...]) | Create new cut-off rule. | -| [`Model.create_cylindrical_selection_rule`](compolyx.Model.create_cylindrical_selection_rule.md#compolyx.Model.create_cylindrical_selection_rule)(name) | Create new cylindrical selection rule. | -| [`Model.create_edge_set`](compolyx.Model.create_edge_set.md#compolyx.Model.create_edge_set)(name[, id, origin, ...]) | Create a new edge set. | -| [`Model.create_element_set`](compolyx.Model.create_element_set.md#compolyx.Model.create_element_set)(name[, id, ...]) | Create a new element set. | -| [`Model.create_envelope_solution`](compolyx.Model.create_envelope_solution.md#compolyx.Model.create_envelope_solution)(name[, id, ...]) | Create an envelope solution. | -| [`Model.create_field_definition`](compolyx.Model.create_field_definition.md#compolyx.Model.create_field_definition)(name[, id, ...]) | Create a new field definition. | -| [`Model.create_geometrical_selection_rule`](compolyx.Model.create_geometrical_selection_rule.md#compolyx.Model.create_geometrical_selection_rule)(name) | Create new geometrical selection rule. | +| [`Model.create_cutoff_selection_rule`](compolyx.Model.create_cutoff_selection_rule.md#compolyx.Model.create_cutoff_selection_rule)(name[, ...]) | Create new cut-off rule | +| [`Model.create_cylindrical_selection_rule`](compolyx.Model.create_cylindrical_selection_rule.md#compolyx.Model.create_cylindrical_selection_rule)(name) | Create new cylindrical selection rule | +| [`Model.create_edge_set`](compolyx.Model.create_edge_set.md#compolyx.Model.create_edge_set)(name[, id, origin, ...]) | Create a new edge set | +| [`Model.create_element_set`](compolyx.Model.create_element_set.md#compolyx.Model.create_element_set)(name[, id, ...]) | Create a new element set | +| [`Model.create_envelope_solution`](compolyx.Model.create_envelope_solution.md#compolyx.Model.create_envelope_solution)(name[, id, ...]) | Create an envelope solution | +| [`Model.create_field_definition`](compolyx.Model.create_field_definition.md#compolyx.Model.create_field_definition)(name[, id, ...]) | Create a new field definition | +| [`Model.create_geometrical_selection_rule`](compolyx.Model.create_geometrical_selection_rule.md#compolyx.Model.create_geometrical_selection_rule)(name) | Create new geometrical selection rule | | [`Model.create_imported_modeling_group`](compolyx.Model.create_imported_modeling_group.md#compolyx.Model.create_imported_modeling_group)(name[, id]) | | -| [`Model.create_imported_solid_model`](compolyx.Model.create_imported_solid_model.md#compolyx.Model.create_imported_solid_model)(name[, ...]) | Create a new solid model. | -| [`Model.create_lookup_table1d`](compolyx.Model.create_lookup_table1d.md#compolyx.Model.create_lookup_table1d)(name[, id, ...]) | Create a new 1D look-up table object. | -| [`Model.create_lookup_table3d`](compolyx.Model.create_lookup_table3d.md#compolyx.Model.create_lookup_table3d)(name[, id, ...]) | Create a new 3D look-up table object. | +| [`Model.create_imported_solid_model`](compolyx.Model.create_imported_solid_model.md#compolyx.Model.create_imported_solid_model)(name[, ...]) | Create a new solid model | +| [`Model.create_lookup_table1d`](compolyx.Model.create_lookup_table1d.md#compolyx.Model.create_lookup_table1d)(name[, id, ...]) | Create a new 1D lookup table object | +| [`Model.create_lookup_table3d`](compolyx.Model.create_lookup_table3d.md#compolyx.Model.create_lookup_table3d)(name[, id, ...]) | Create a new 3D lookup table object | | [`Model.create_modeling_group`](compolyx.Model.create_modeling_group.md#compolyx.Model.create_modeling_group)(name[, id]) | | -| [`Model.create_oriented_selection_set`](compolyx.Model.create_oriented_selection_set.md#compolyx.Model.create_oriented_selection_set)(name[, ...]) | Create a new oriented selection set. | -| [`Model.create_parallel_selection_rule`](compolyx.Model.create_parallel_selection_rule.md#compolyx.Model.create_parallel_selection_rule)(name[, ...]) | Create a new parallel selection rule. | -| [`Model.create_published_parameter`](compolyx.Model.create_published_parameter.md#compolyx.Model.create_published_parameter)(name[, ...]) | Create a published parameter. | -| [`Model.create_rosette`](compolyx.Model.create_rosette.md#compolyx.Model.create_rosette)(name[, id, origin, ...]) | Create a new rosette. | -| [`Model.create_sampling_point`](compolyx.Model.create_sampling_point.md#compolyx.Model.create_sampling_point)(name[, id, ...]) | Create a new sampling point. | -| [`Model.create_scene`](compolyx.Model.create_scene.md#compolyx.Model.create_scene)(name[, id, title, ...]) | Create a new scene. | -| [`Model.create_script`](compolyx.Model.create_script.md#compolyx.Model.create_script)(name[, source, active, ...]) | Creates a script object, which allows executing custom Python code. | -| [`Model.create_section_cut`](compolyx.Model.create_section_cut.md#compolyx.Model.create_section_cut)(name[, id, active, ...]) | Creates a new section cut. | -| [`Model.create_sensor`](compolyx.Model.create_sensor.md#compolyx.Model.create_sensor)(name[, id, active, ...]) | Create new sensor. | -| [`Model.create_solid_model`](compolyx.Model.create_solid_model.md#compolyx.Model.create_solid_model)(name[, id, active, ...]) | Create a new solid model. | -| [`Model.create_spherical_selection_rule`](compolyx.Model.create_spherical_selection_rule.md#compolyx.Model.create_spherical_selection_rule)(name) | Create a new spherical selection rule. | -| [`Model.create_tube_selection_rule`](compolyx.Model.create_tube_selection_rule.md#compolyx.Model.create_tube_selection_rule)(name[, id, ...]) | Create a new tube selection rule. | -| [`Model.create_variable_offset_selection_rule`](compolyx.Model.create_variable_offset_selection_rule.md#compolyx.Model.create_variable_offset_selection_rule)(name) | Create new slab offset rule. | +| [`Model.create_oriented_selection_set`](compolyx.Model.create_oriented_selection_set.md#compolyx.Model.create_oriented_selection_set)(name[, ...]) | Create a new oriented selection set | +| [`Model.create_parallel_selection_rule`](compolyx.Model.create_parallel_selection_rule.md#compolyx.Model.create_parallel_selection_rule)(name[, ...]) | Create a new parallel selection rule | +| [`Model.create_published_parameter`](compolyx.Model.create_published_parameter.md#compolyx.Model.create_published_parameter)(name[, ...]) | Create a published parameter | +| [`Model.create_rosette`](compolyx.Model.create_rosette.md#compolyx.Model.create_rosette)(name[, id, origin, ...]) | Create a new rosette | +| [`Model.create_sampling_point`](compolyx.Model.create_sampling_point.md#compolyx.Model.create_sampling_point)(name[, id, ...]) | Create a new sampling point | +| [`Model.create_scene`](compolyx.Model.create_scene.md#compolyx.Model.create_scene)(name[, id, title, ...]) | Create a new scene | +| [`Model.create_script`](compolyx.Model.create_script.md#compolyx.Model.create_script)(name[, source, active, ...]) | Creates a script object, which allows executing custom Python code | +| [`Model.create_section_cut`](compolyx.Model.create_section_cut.md#compolyx.Model.create_section_cut)(name[, id, active, ...]) | Creates a new section cut | +| [`Model.create_sensor`](compolyx.Model.create_sensor.md#compolyx.Model.create_sensor)(name[, id, active, ...]) | Create new sensor | +| [`Model.create_solid_model`](compolyx.Model.create_solid_model.md#compolyx.Model.create_solid_model)(name[, id, active, ...]) | Create a new solid model | +| [`Model.create_spherical_selection_rule`](compolyx.Model.create_spherical_selection_rule.md#compolyx.Model.create_spherical_selection_rule)(name) | Create a new spherical selection rule | +| [`Model.create_tube_selection_rule`](compolyx.Model.create_tube_selection_rule.md#compolyx.Model.create_tube_selection_rule)(name[, id, ...]) | Create a new tube selection rule | +| [`Model.create_variable_offset_selection_rule`](compolyx.Model.create_variable_offset_selection_rule.md#compolyx.Model.create_variable_offset_selection_rule)(name) | Create new slab offset rule | | [`Model.create_view`](compolyx.Model.create_view.md#compolyx.Model.create_view)(name[, position, ...]) | | -| [`Model.element_normal`](compolyx.Model.element_normal.md#compolyx.Model.element_normal)(globalID) | Returns the element normal (direction). | -| [`Model.export`](compolyx.Model.export.md#compolyx.Model.export)(path) | Exports all ACP composite definitions as Python commands to a file. | -| [`Model.export_composite_cae_h5`](compolyx.Model.export_composite_cae_h5.md#compolyx.Model.export_composite_cae_h5)(path[, ...]) | Export layup to composite CAE .hdf5 file. | -| [`Model.export_h5_composite_definitions`](compolyx.Model.export_h5_composite_definitions.md#compolyx.Model.export_h5_composite_definitions)(path) | Save composite definitions to .hdf5 file. | -| [`Model.export_ply_geometries`](compolyx.Model.export_ply_geometries.md#compolyx.Model.export_ply_geometries)(filename[, ...]) | Exports the surface, boundary, and/or fiber directions of modeling, production, and analysis ply to .igs or .step file. | -| [`Model.export_solid_models`](compolyx.Model.export_solid_models.md#compolyx.Model.export_solid_models)([directory, ...]) | Save solid models to files. | -| [`Model.find_materials`](compolyx.Model.find_materials.md#compolyx.Model.find_materials)(\*\*properties) | Find materials with the given properties or property ranges. | -| [`Model.find_parent`](compolyx.Model.find_parent.md#compolyx.Model.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`Model.element_normal`](compolyx.Model.element_normal.md#compolyx.Model.element_normal)(globalID) | Returns the element normal (direction) | +| [`Model.export`](compolyx.Model.export.md#compolyx.Model.export)(path) | Exports all ACP composite definitions as Python commands to a file | +| [`Model.export_composite_cae_h5`](compolyx.Model.export_composite_cae_h5.md#compolyx.Model.export_composite_cae_h5)(path[, ...]) | Export layup to composite CAE .hdf5 file | +| [`Model.export_h5_composite_definitions`](compolyx.Model.export_h5_composite_definitions.md#compolyx.Model.export_h5_composite_definitions)(path) | Save composite definitions to .hdf5 file | +| [`Model.export_ply_geometries`](compolyx.Model.export_ply_geometries.md#compolyx.Model.export_ply_geometries)(filename[, ...]) | Exports the surface, boundary, and/or fiber directions of modeling, production, and analysis ply to .igs or .step file | +| [`Model.export_solid_models`](compolyx.Model.export_solid_models.md#compolyx.Model.export_solid_models)([directory, ...]) | Save solid models to files | +| [`Model.find_materials`](compolyx.Model.find_materials.md#compolyx.Model.find_materials)(\*\*properties) | Find materials with the given properties or property ranges | +| [`Model.find_parent`](compolyx.Model.find_parent.md#compolyx.Model.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`Model.get_composite_cae_h5_mesh_preview`](compolyx.Model.get_composite_cae_h5_mesh_preview.md#compolyx.Model.get_composite_cae_h5_mesh_preview)(...) | | -| [`Model.get_element_by_point`](compolyx.Model.get_element_by_point.md#compolyx.Model.get_element_by_point)(point) | Returns the element label of the closest element with respect to the given point. | -| [`Model.get_layup`](compolyx.Model.get_layup.md#compolyx.Model.get_layup)(path[, format, objects, mode]) | Load layup from excel or .csv file. | -| [`Model.get_layup_from_csv_file`](compolyx.Model.get_layup_from_csv_file.md#compolyx.Model.get_layup_from_csv_file)(path[, ...]) | Function that reads the layup data from a .csv file and adds the data to the graph. | -| [`Model.get_layup_from_excel_file`](compolyx.Model.get_layup_from_excel_file.md#compolyx.Model.get_layup_from_excel_file)(path[, ...]) | Load layup from Excel File. | +| [`Model.get_element_by_point`](compolyx.Model.get_element_by_point.md#compolyx.Model.get_element_by_point)(point) | Returns the element label of the closest element with respect to the given point | +| [`Model.get_layup`](compolyx.Model.get_layup.md#compolyx.Model.get_layup)(path[, format, objects, mode]) | Load layup from excel or .csv file | +| [`Model.get_layup_from_csv_file`](compolyx.Model.get_layup_from_csv_file.md#compolyx.Model.get_layup_from_csv_file)(path[, ...]) | Function that reads the layup data from a .csv file and adds the data to the graph | +| [`Model.get_layup_from_excel_file`](compolyx.Model.get_layup_from_excel_file.md#compolyx.Model.get_layup_from_excel_file)(path[, ...]) | Load layup from Excel File | | [`Model.graph_report`](compolyx.Model.graph_report.md#compolyx.Model.graph_report)() | | -| [`Model.import_composite_cae_h5`](compolyx.Model.import_composite_cae_h5.md#compolyx.Model.import_composite_cae_h5)(path[, mode, ...]) | Import a composite layup definition from a .hdf5 file. | -| [`Model.import_composite_definitions_from_acp_file`](compolyx.Model.import_composite_definitions_from_acp_file.md#compolyx.Model.import_composite_definitions_from_acp_file)([...]) | This functions loads the ACP composite definitions from an external ACP system. | -| [`Model.import_section_data_from_legacy_model`](compolyx.Model.import_section_data_from_legacy_model.md#compolyx.Model.import_section_data_from_legacy_model)(path) | Import and convert the layup of a legacy (Mechanical APDL) shell model into ACP composite definitions. | -| [`Model.mesh_query`](compolyx.Model.mesh_query.md#compolyx.Model.mesh_query)(name, position[, ...]) | Query arbitrary data from the mesh of the model. | -| [`Model.plot_dependencies`](compolyx.Model.plot_dependencies.md#compolyx.Model.plot_dependencies)([path, parent, levels]) | Generates a graph with all dependencies. | +| [`Model.import_composite_cae_h5`](compolyx.Model.import_composite_cae_h5.md#compolyx.Model.import_composite_cae_h5)(path[, mode, ...]) | Import a composite layup definition from a .hdf5 file | +| [`Model.import_composite_definitions_from_acp_file`](compolyx.Model.import_composite_definitions_from_acp_file.md#compolyx.Model.import_composite_definitions_from_acp_file)([...]) | This functions loads the ACP composite definitions from an external ACP system | +| [`Model.import_section_data_from_legacy_model`](compolyx.Model.import_section_data_from_legacy_model.md#compolyx.Model.import_section_data_from_legacy_model)(path) | Import and convert the layup of a legacy (Mechanical APDL) shell model into ACP composite definitions | +| [`Model.mesh_query`](compolyx.Model.mesh_query.md#compolyx.Model.mesh_query)(name, position[, ...]) | Query arbitrary data from the mesh of the model | +| [`Model.plot_dependencies`](compolyx.Model.plot_dependencies.md#compolyx.Model.plot_dependencies)([path, parent, levels]) | Generates a graph with all dependencies | | [`Model.reference_element`](compolyx.Model.reference_element.md#compolyx.Model.reference_element)(globalID) | | | [`Model.refresh_material_apdl_file`](compolyx.Model.refresh_material_apdl_file.md#compolyx.Model.refresh_material_apdl_file)(apdl_file_path) | | -| [`Model.refresh_material_data`](compolyx.Model.refresh_material_data.md#compolyx.Model.refresh_material_data)(matml_file_path, ...) | Refresh material external data sources in the model .acph5 database. | -| [`Model.reload_mesh`](compolyx.Model.reload_mesh.md#compolyx.Model.reload_mesh)([path, format]) | Reloads the mesh (nodes, elements, and named selections). | -| [`Model.reorder_modeling_groups`](compolyx.Model.reorder_modeling_groups.md#compolyx.Model.reorder_modeling_groups)([source, ...]) | Reorders the modeling groups by placing source before or after the target. | -| [`Model.save`](compolyx.Model.save.md#compolyx.Model.save)([path, cache_data]) | Save ACP model to .acph5 file. | -| [`Model.save_analysis_model`](compolyx.Model.save_analysis_model.md#compolyx.Model.save_analysis_model)(path) | Save actual analysis model to disc. | -| [`Model.save_apdl_commands`](compolyx.Model.save_apdl_commands.md#compolyx.Model.save_apdl_commands)(path) | Save APDL commands for composite definitions of actual model. | -| [`Model.save_h5`](compolyx.Model.save_h5.md#compolyx.Model.save_h5)(path[, cache_data]) | Save ACP model in .acph5 format. | -| [`Model.save_layup`](compolyx.Model.save_layup.md#compolyx.Model.save_layup)(path[, format, objects]) | Function that saves the layup data to a .csv file. | -| [`Model.save_layup_to_csv_file`](compolyx.Model.save_layup_to_csv_file.md#compolyx.Model.save_layup_to_csv_file)(path[, objects]) | Function that saves the layup data to a .csv file. | -| [`Model.save_layup_to_excel_file`](compolyx.Model.save_layup_to_excel_file.md#compolyx.Model.save_layup_to_excel_file)(path[, objects]) | Function that saves the layup data to an excel file (Windows only). | -| [`Model.select_elements`](compolyx.Model.select_elements.md#compolyx.Model.select_elements)([selection, op, ...]) | Selects element within active model and marks the selection as SELECTED. | -| [`Model.select_nodes`](compolyx.Model.select_nodes.md#compolyx.Model.select_nodes)([selection, op, labels, ...]) | Function selects nodes in graph and marks the given selection as SELECTED. | -| [`Model.select_solid_elements_from_shells`](compolyx.Model.select_solid_elements_from_shells.md#compolyx.Model.select_solid_elements_from_shells)([...]) | Selects the solid element within given selection and deselects the shell elements. | -| [`Model.solve`](compolyx.Model.solve.md#compolyx.Model.solve)([wait]) | Convenience function to directly solve the current model. | +| [`Model.refresh_material_data`](compolyx.Model.refresh_material_data.md#compolyx.Model.refresh_material_data)(matml_file_path, ...) | Refresh material external data sources in the model .acph5 database | +| [`Model.reload_mesh`](compolyx.Model.reload_mesh.md#compolyx.Model.reload_mesh)([path, format]) | Reloads the mesh (nodes, elements, and named selections) | +| [`Model.reorder_modeling_groups`](compolyx.Model.reorder_modeling_groups.md#compolyx.Model.reorder_modeling_groups)([source, ...]) | Reorders the modeling groups by placing source before or after the target | +| [`Model.save`](compolyx.Model.save.md#compolyx.Model.save)([path, cache_data]) | Save ACP model to .acph5 file | +| [`Model.save_analysis_model`](compolyx.Model.save_analysis_model.md#compolyx.Model.save_analysis_model)(path) | Save actual analysis model to disc | +| [`Model.save_apdl_commands`](compolyx.Model.save_apdl_commands.md#compolyx.Model.save_apdl_commands)(path) | Save APDL commands for composite definitions of actual model | +| [`Model.save_h5`](compolyx.Model.save_h5.md#compolyx.Model.save_h5)(path[, cache_data]) | Save ACP model in .acph5 format | +| [`Model.save_layup`](compolyx.Model.save_layup.md#compolyx.Model.save_layup)(path[, format, objects]) | Function that saves the layup data to a .csv file | +| [`Model.save_layup_to_csv_file`](compolyx.Model.save_layup_to_csv_file.md#compolyx.Model.save_layup_to_csv_file)(path[, objects]) | Function that saves the layup data to a .csv file | +| [`Model.save_layup_to_excel_file`](compolyx.Model.save_layup_to_excel_file.md#compolyx.Model.save_layup_to_excel_file)(path[, objects]) | Function that saves the layup data to an excel file (Windows only) | +| [`Model.select_elements`](compolyx.Model.select_elements.md#compolyx.Model.select_elements)([selection, op, ...]) | Selects element within active model and marks the selection as SELECTED | +| [`Model.select_nodes`](compolyx.Model.select_nodes.md#compolyx.Model.select_nodes)([selection, op, labels, ...]) | Function selects nodes in graph and marks the given selection as SELECTED | +| [`Model.select_solid_elements_from_shells`](compolyx.Model.select_solid_elements_from_shells.md#compolyx.Model.select_solid_elements_from_shells)([...]) | Selects the solid element within given selection and deselects the shell elements | +| [`Model.solve`](compolyx.Model.solve.md#compolyx.Model.solve)([wait]) | Convenience function to directly solve the current model | | [`Model.sphere_widget_radius`](compolyx.Model.sphere_widget_radius.md#compolyx.Model.sphere_widget_radius)() | | -| [`Model.update`](compolyx.Model.update.md#compolyx.Model.update)([objects, relations_only]) | Main update function. | -| [`Model.visit`](compolyx.Model.visit.md#compolyx.Model.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | -| [`Model.wbupdate`](compolyx.Model.wbupdate.md#compolyx.Model.wbupdate)([objects, relations_only]) | Generate all output files of ACP for the Workbench application. | +| [`Model.update`](compolyx.Model.update.md#compolyx.Model.update)([objects, relations_only]) | Main update function | +| [`Model.visit`](compolyx.Model.visit.md#compolyx.Model.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | +| [`Model.wbupdate`](compolyx.Model.wbupdate.md#compolyx.Model.wbupdate)([objects, relations_only]) | Generate all output files of ACP for the Workbench application | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.reload_mesh.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.reload_mesh.md index 3bb37c3b3d..7f95972a20 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.reload_mesh.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.reload_mesh.md @@ -7,6 +7,6 @@ Reloads the mesh (nodes, elements, and named selections). The following imported entities are ignored: materials and rosettes. -Parameters: -: - path: New mesh path. Default is the current model path. +* **Parameters:** + - path: New mesh path. Default is the current model path. - format: New format. Default is the current format. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_elements.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_elements.md index 3323cd337c..5c81e660e5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_elements.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_elements.md @@ -8,10 +8,10 @@ Selects element within active model and marks the selection as SELECTED. * **Parameters:** - selection: The selection to update. - Can be given as string (‘sel0’-‘sel5’ or ‘all’) or ObjectSelection object such as - - model.selection - - scene.active_set - - op: Select operation. Valid options: all, new (default), add, remove, intersect, inverse, and none. + Can be given as string (`sel0`-`sel5` or `all`) or ObjectSelection object such as + - `model.selection` + - `scene.active_set` + - op: Select operation. Available options: `all`, `new` (default), `add`, `remove`, `intersect`, `inverse`, and `none`. - labels: List with element labels to select. - indices: List with element indices to select. - attached_to: Elements attached to entities/vertices in this list will be selected. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_nodes.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_nodes.md index 2245d418a9..729ed0fdac 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_nodes.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_nodes.md @@ -8,11 +8,11 @@ Function selects nodes in graph and marks the given selection as SELECTED. * **Parameters:** - selection: The selection to update. - Can be given as string (‘sel0’-‘sel5’ or ‘all’) + Can be given as string (`sel0`-`sel5` or `all`) or ObjectSelection object such as - - model.selection - - scene.active_set - - op: Select operation. Valid options: all, new (default), add, remove, intersect, inverse, and none. + - `model.selection` + - `scene.active_set` + - op: Select operation. Available options: `all`, `new` (default), `add`, `remove`, `intersect`, `inverse`, and `none`. - labels: List with node labels to select. - attached_to: Nodes attached to the given list of entities or vertices will be selected. If attached_to=”elements” all nodes attached to selected elements are selected. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_solid_elements_from_shells.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_solid_elements_from_shells.md index 2eeb9ad334..303f36eaa2 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_solid_elements_from_shells.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.select_solid_elements_from_shells.md @@ -7,6 +7,6 @@ Selects the solid element within given selection and deselects the shell elements. * **Parameters:** - - selection: The selection to update. Can be given as string ‘sel0’-‘sel5’. + - selection: The selection to update. Can be given as string `sel0`-`sel5`. * **Return:** Number of selected solid elements. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.unit_system.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.unit_system.md index 370e23026a..2d055fc447 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.unit_system.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.unit_system.md @@ -5,4 +5,4 @@ #### *property* Model.unit_system Create a unit system and assign it to the model. -Unit system types are: si,mks,cgs,umks,mpa,bft,bin,undefined +Unit system types are: `si`, `mks`, `cgs`, `umks`, `mpa`, `bft`, `bin`, and `undefined`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.visit.md index 7fd31eaa57..0ee317dab0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Model.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_butt_joint_sequence.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_butt_joint_sequence.md index 9c9f1f59f2..0c0be8b993 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_butt_joint_sequence.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_butt_joint_sequence.md @@ -10,6 +10,6 @@ Makes a copy of a butt-joint sequence. - source: Source object to copy. - global_ply_nr: Global ply number to use. If 0, then the ply is added at the top. - sort: Whether to sort all plies of modeling group after copy. - : If multiple plies are copied at once it can be useful to sort only once at the end of the copy operation. + If multiple plies are copied at once it can be useful to sort only once at the end of the copy operation. * **Returns:** New instance of modeling ply. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_interface_layer.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_interface_layer.md index a29d644380..8043283127 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_interface_layer.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_interface_layer.md @@ -10,6 +10,6 @@ Copy an interface layer. - source: Source object to copy. - global_ply_nr: Global ply number to use. If 0, then the ply is added at the top. - sort: Whether to sort all plies of interface layer group after copy. - : If multiple plies are copied at once it can be useful to sort only once at the end of the copy operation. + If multiple plies are copied at once it can be useful to sort only once at the end of the copy operation. * **Returns:** New instance of interface layer. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_modeling_ply.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_modeling_ply.md index bcd230720b..4cb1e5ad26 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_modeling_ply.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.copy_modeling_ply.md @@ -10,6 +10,6 @@ Copy a modeling ply. - source: Source object to copy. - global_ply_nr: Global ply number to use. If 0, then the ply is added at the top. - sort: Whether to sort all plies of modeling group after copy. - : If multiple plies are copied at once it can be useful to sort only once at the end of the copy operation. + If multiple plies are copied at once it can be useful to sort only once at the end of the copy operation. * **Returns:** New instance of modeling ply. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.create_interface_layer.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.create_interface_layer.md index 78746b828c..7a2c1add3a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.create_interface_layer.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.create_interface_layer.md @@ -12,7 +12,7 @@ Create an iterface layer. - global_ply_nr: Ply number for stacking sequence. - oriented_selection_sets: Oriented selection set for the expansion of the iterface layer. - open_area_sets: Defines the initial crack of a VCCT layer (optional). - - active: Iterface layer active (default: ‘True’). + - active: Iterface layer active (default: `True`). * **Returns:** The created iterface layer. * **Example:** diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.create_modeling_ply.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.create_modeling_ply.md index 8d99d0c78f..d881f11999 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.create_modeling_ply.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.create_modeling_ply.md @@ -15,18 +15,18 @@ Create modeling ply. - global_ply_nr: Ply number for stacking sequence. - oriented_selection_sets: Oriented selection set for the expansion of the modeling ply. - selection_rules: Element selection rules for the modeling ply. - - draping: The type of draping to be used. Valid options: “no_draping”, “evaluate_draping”, and “tabular_values”. + - draping: The type of draping to be used. Available options: `no_draping`, `evaluate_draping`, and `tabular_values`. - draping_seed_point: Start/seed point for draping. - - auto_draping_direction: Automatically set draping direction (default: ‘True’). - - draping_direction: Direction to go in draping (default: ‘None’). + - auto_draping_direction: Automatically set draping direction (default: `True`). + - draping_direction: Direction to go in draping (default: `None`). - draping_mesh_size: Mesh size used for draping. - use_default_draping_mesh_size: Whether to use a default size for the draping mesh. Default is the average element size of the shell mesh. - - thickness_definition: Enum that describes the method used for thickness definition (default: ‘Nominal’). + - thickness_definition: Enum that describes the method used for thickness definition (default: `Nominal`). - core_geometry: The assigned core geometry. - active: Modeling ply active. - taper_edges: Taper Edges for the modeling ply. - thickness_field: Look-Up table column with scalar values for thickness sampling (optional). - - thickness_field_type: The type of thickness field. Valid options: ‘absolute’ or ‘relative’. + - thickness_field_type: The type of thickness field. Available options: `absolute` or `relative`. - angle_1_field: Look-Up table column with scalar values for angle 1. - angle_2_field: Look-Up table column with scalar values for angle 2. * **Returns:** diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.enabled.md index 4aef1bcff0..8948745559 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.enabled.md @@ -4,4 +4,4 @@ #### *property* ModelingGroup.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.export_ply_geometries.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.export_ply_geometries.md index 113241827a..527bc8f7cb 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.export_ply_geometries.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.export_ply_geometries.md @@ -7,13 +7,13 @@ Exports the surface, boundary, and/or fiber directions of modeling, production, and analysis ply to .igs or .step file. * **Parameters:** - - filename: File path (valid extensions are .iges, .igs, .step, and .stp). - - ply_level: Defines which plies are exported: modeling_ply_wise, production_ply_wise or analysis_ply_wise. Default is production_ply_wise. - - boundary: Boolean whether to export the boundary (default: ‘True’). - - surface: Boolean whether to export the ply surface (default: ‘True’). - - offset_type: Offset type. Valid options: no_offset, middle_offset (default), top_offset, and bottom_offset. - - direction_arrows: Boolean whether to export the direction arrows. Default is False. - - first_direction: Boolean whether to export the first (main) material direction (default: ‘True’). - - second_direction: Boolean whether to export the second material direction (default: ‘False’). - - arrow_length: Length of the arrows (default: ‘1’). - - arrow_type: Defines the arrow type. Valid options: standard_arrow, no_arrow (default), and half_arrow). + - filename: File path (Available extensions are `.iges`, `.igs`, `.step`, and `.stp`). + - ply_level: Defines which plies are exported: `modeling_ply_wise`, `production_ply_wise`, or `analysis_ply_wise`. Default is `production_ply_wise`. + - boundary: Boolean whether to export the boundary (default: `True`). + - surface: Boolean whether to export the ply surface (default: `True`). + - offset_type: Offset type. Available options: `no_offset`, `middle_offset` (default), `top_offset`, and `bottom_offset`. + - direction_arrows: Boolean whether to export the direction arrows. Default is `False`. + - first_direction: Boolean whether to export the first (main) material direction (default: `True`). + - second_direction: Boolean whether to export the second material direction (default: `False`). + - arrow_length: Length of the arrows (default: `1`). + - arrow_type: Defines the arrow type. Available options: `standard_arrow`, `no_arrow` (default), and `half_arrow`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.is_dict_item.md index 4dd85268b5..2f1981781c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ModelingGroup.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.is_list_item.md index 46770751b2..ba6ffa6edf 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ModelingGroup.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.md index 917fb3ca7a..df28ca98c8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.md @@ -28,11 +28,11 @@ Creation: | Name | Description | |------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`ModelingGroup.active`](compolyx.ModelingGroup.active.md#compolyx.ModelingGroup.active) | active status of object | -| [`ModelingGroup.enabled`](compolyx.ModelingGroup.enabled.md#compolyx.ModelingGroup.enabled) | Whether this object is currently enabled or not. | +| [`ModelingGroup.active`](compolyx.ModelingGroup.active.md#compolyx.ModelingGroup.active) | Active status of object | +| [`ModelingGroup.enabled`](compolyx.ModelingGroup.enabled.md#compolyx.ModelingGroup.enabled) | Whether this object is currently enabled or not | | [`ModelingGroup.id`](compolyx.ModelingGroup.id.md#compolyx.ModelingGroup.id) | ID of object | -| [`ModelingGroup.is_dict_item`](compolyx.ModelingGroup.is_dict_item.md#compolyx.ModelingGroup.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ModelingGroup.is_list_item`](compolyx.ModelingGroup.is_list_item.md#compolyx.ModelingGroup.is_list_item) | Specifies wether the object is an item of a list | +| [`ModelingGroup.is_dict_item`](compolyx.ModelingGroup.is_dict_item.md#compolyx.ModelingGroup.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ModelingGroup.is_list_item`](compolyx.ModelingGroup.is_list_item.md#compolyx.ModelingGroup.is_list_item) | Specifies whether the object is an item of a list | | [`ModelingGroup.link_path`](compolyx.ModelingGroup.link_path.md#compolyx.ModelingGroup.link_path) | Root path of the current node in the tree for links to this object | | [`ModelingGroup.name`](compolyx.ModelingGroup.name.md#compolyx.ModelingGroup.name) | Name of object | | [`ModelingGroup.parent`](compolyx.ModelingGroup.parent.md#compolyx.ModelingGroup.parent) | Parent object in tree | @@ -40,32 +40,32 @@ Creation: | [`ModelingGroup.root_path`](compolyx.ModelingGroup.root_path.md#compolyx.ModelingGroup.root_path) | Root path of the current node in the tree | | [`ModelingGroup.size`](compolyx.ModelingGroup.size.md#compolyx.ModelingGroup.size) | Number of entities | | [`ModelingGroup.status`](compolyx.ModelingGroup.status.md#compolyx.ModelingGroup.status) | Status of the object | -| [`ModelingGroup.status_changed`](compolyx.ModelingGroup.status_changed.md#compolyx.ModelingGroup.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`ModelingGroup.status_changed`](compolyx.ModelingGroup.status_changed.md#compolyx.ModelingGroup.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`ModelingGroup.uid`](compolyx.ModelingGroup.uid.md#compolyx.ModelingGroup.uid) | UID of object | -| [`ModelingGroup.vertex`](compolyx.ModelingGroup.vertex.md#compolyx.ModelingGroup.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ModelingGroup.vertex`](compolyx.ModelingGroup.vertex.md#compolyx.ModelingGroup.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ModelingGroup.add`](compolyx.ModelingGroup.add.md#compolyx.ModelingGroup.add)(entity) | Add entity to the set. | +| [`ModelingGroup.add`](compolyx.ModelingGroup.add.md#compolyx.ModelingGroup.add)(entity) | Add entity to the set | | [`ModelingGroup.clear`](compolyx.ModelingGroup.clear.md#compolyx.ModelingGroup.clear)() | | -| [`ModelingGroup.copy_butt_joint_sequence`](compolyx.ModelingGroup.copy_butt_joint_sequence.md#compolyx.ModelingGroup.copy_butt_joint_sequence)(source) | Makes a copy of a butt-joint sequence. | -| [`ModelingGroup.copy_interface_layer`](compolyx.ModelingGroup.copy_interface_layer.md#compolyx.ModelingGroup.copy_interface_layer)(source[, ...]) | Copy an interface layer. | -| [`ModelingGroup.copy_modeling_ply`](compolyx.ModelingGroup.copy_modeling_ply.md#compolyx.ModelingGroup.copy_modeling_ply)(source[, ...]) | Copy a modeling ply. | +| [`ModelingGroup.copy_butt_joint_sequence`](compolyx.ModelingGroup.copy_butt_joint_sequence.md#compolyx.ModelingGroup.copy_butt_joint_sequence)(source) | Makes a copy of a butt-joint sequence | +| [`ModelingGroup.copy_interface_layer`](compolyx.ModelingGroup.copy_interface_layer.md#compolyx.ModelingGroup.copy_interface_layer)(source[, ...]) | Copy an interface layer | +| [`ModelingGroup.copy_modeling_ply`](compolyx.ModelingGroup.copy_modeling_ply.md#compolyx.ModelingGroup.copy_modeling_ply)(source[, ...]) | Copy a modeling ply | | [`ModelingGroup.copy_sequence_entity`](compolyx.ModelingGroup.copy_sequence_entity.md#compolyx.ModelingGroup.copy_sequence_entity)(source[, ...]) | | -| [`ModelingGroup.create_butt_joint_sequence`](compolyx.ModelingGroup.create_butt_joint_sequence.md#compolyx.ModelingGroup.create_butt_joint_sequence)([...]) | Creates a new butt-joint sequences and adds it to this modeling group. | -| [`ModelingGroup.create_interface_layer`](compolyx.ModelingGroup.create_interface_layer.md#compolyx.ModelingGroup.create_interface_layer)([name, ...]) | Create an iterface layer. | -| [`ModelingGroup.create_modeling_ply`](compolyx.ModelingGroup.create_modeling_ply.md#compolyx.ModelingGroup.create_modeling_ply)([name, ...]) | Create modeling ply. | -| [`ModelingGroup.export_ply_geometries`](compolyx.ModelingGroup.export_ply_geometries.md#compolyx.ModelingGroup.export_ply_geometries)(filename) | Exports the surface, boundary, and/or fiber directions of modeling, production, and analysis ply to .igs or .step file. | -| [`ModelingGroup.find_parent`](compolyx.ModelingGroup.find_parent.md#compolyx.ModelingGroup.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`ModelingGroup.create_butt_joint_sequence`](compolyx.ModelingGroup.create_butt_joint_sequence.md#compolyx.ModelingGroup.create_butt_joint_sequence)([...]) | Creates a new butt-joint sequences and adds it to this modeling group | +| [`ModelingGroup.create_interface_layer`](compolyx.ModelingGroup.create_interface_layer.md#compolyx.ModelingGroup.create_interface_layer)([name, ...]) | Create an iterface layer | +| [`ModelingGroup.create_modeling_ply`](compolyx.ModelingGroup.create_modeling_ply.md#compolyx.ModelingGroup.create_modeling_ply)([name, ...]) | Create modeling ply | +| [`ModelingGroup.export_ply_geometries`](compolyx.ModelingGroup.export_ply_geometries.md#compolyx.ModelingGroup.export_ply_geometries)(filename) | Exports the surface, boundary, and/or fiber directions of modeling, production, and analysis ply to .igs or .step file | +| [`ModelingGroup.find_parent`](compolyx.ModelingGroup.find_parent.md#compolyx.ModelingGroup.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`ModelingGroup.get_short_description`](compolyx.ModelingGroup.get_short_description.md#compolyx.ModelingGroup.get_short_description)() | | | [`ModelingGroup.is_imported`](compolyx.ModelingGroup.is_imported.md#compolyx.ModelingGroup.is_imported)() | | -| [`ModelingGroup.obj_exists`](compolyx.ModelingGroup.obj_exists.md#compolyx.ModelingGroup.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. | -| [`ModelingGroup.remove`](compolyx.ModelingGroup.remove.md#compolyx.ModelingGroup.remove)(entity) | Remove entity from the set. | -| [`ModelingGroup.reorder_plies`](compolyx.ModelingGroup.reorder_plies.md#compolyx.ModelingGroup.reorder_plies)(source, target) | Reorder the ply group. | -| [`ModelingGroup.serialize`](compolyx.ModelingGroup.serialize.md#compolyx.ModelingGroup.serialize)([butt_joints]) | Serialize to Python string. | -| [`ModelingGroup.serialize_name_and_id`](compolyx.ModelingGroup.serialize_name_and_id.md#compolyx.ModelingGroup.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ModelingGroup.obj_exists`](compolyx.ModelingGroup.obj_exists.md#compolyx.ModelingGroup.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 | +| [`ModelingGroup.remove`](compolyx.ModelingGroup.remove.md#compolyx.ModelingGroup.remove)(entity) | Remove entity from the set | +| [`ModelingGroup.reorder_plies`](compolyx.ModelingGroup.reorder_plies.md#compolyx.ModelingGroup.reorder_plies)(source, target) | Reorder the ply group | +| [`ModelingGroup.serialize`](compolyx.ModelingGroup.serialize.md#compolyx.ModelingGroup.serialize)([butt_joints]) | Serialize to Python string | +| [`ModelingGroup.serialize_name_and_id`](compolyx.ModelingGroup.serialize_name_and_id.md#compolyx.ModelingGroup.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ModelingGroup.sync_plies`](compolyx.ModelingGroup.sync_plies.md#compolyx.ModelingGroup.sync_plies)() | | | [`ModelingGroup.update`](compolyx.ModelingGroup.update.md#compolyx.ModelingGroup.update)() | | -| [`ModelingGroup.visit`](compolyx.ModelingGroup.visit.md#compolyx.ModelingGroup.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ModelingGroup.visit`](compolyx.ModelingGroup.visit.md#compolyx.ModelingGroup.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.obj_exists.md index 894a0b7ae5..18741d90c9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.obj_exists.md @@ -4,5 +4,5 @@ #### ModelingGroup.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.reorder_plies.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.reorder_plies.md index f65766c18c..e0e7eb58e6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.reorder_plies.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingGroup.reorder_plies.md @@ -9,11 +9,11 @@ specified as a target, then the modeling plies retain their original global ply * **Parameters:** - source: List of plies to insert at new position. - - target: Position to insert plies. Valid options are modeling group and sequence entity. - - option: Where to insert: after (default), before, end (for SequenceEntity targets), or keep (for - : ModelingGroup targets). - - after: Paste right after the target. - - before: Paste right before the target. - - end: Paste at the end of the ModelingGroup containing target. - - keep: Keep the previous global_ply_nr (only works for move, and when target is a ModelingGroup). + - target: Position to insert plies. Available options are modeling group and sequence entity. + - option: Where to insert: `after` (default), `before`, `end` (for SequenceEntity targets), or `keep` (for + ModelingGroup targets). + - `after`: Paste right after the target. + - `before`: Paste right before the target. + - `end`: Paste at the end of the ModelingGroup containing target. + - `keep`: Keep the previous global_ply_nr (only works for move, and when target is a ModelingGroup). - reverse: If True, reverse the order of imported plies. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.direction_arrows.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.direction_arrows.md index 54697be01c..be8623ef2e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.direction_arrows.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.direction_arrows.md @@ -8,5 +8,5 @@ Direction arrows of the ply. * **Parameters:** - arrow_length: Length of the arrow. - - arrow_type: ‘standard_arrow’ (default), ‘no_arrow’, ‘half_arrow’. - - offset_type: ‘no_offset’ (default), ‘bottom_offset’, ‘middle_offset’, ‘top_offset’. + - arrow_type: `standard_arrow` (default), `no_arrow`, `half_arrow`. + - offset_type: `no_offset` (default), `bottom_offset`, `middle_offset`, `top_offset`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.enabled.md index 61f6dd7175..e29a85f891 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.enabled.md @@ -4,4 +4,4 @@ #### *property* ModelingPly.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.is_dict_item.md index b2a796cafe..cb749dc118 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ModelingPly.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.is_list_item.md index ec1881c97f..fcc474f1c4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ModelingPly.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.obj_exists.md index 6b7d0aaa34..b549acc0ea 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.obj_exists.md @@ -4,5 +4,5 @@ #### ModelingPly.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.thickness_field_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.thickness_field_type.md index ce8311df96..0b7ec59b80 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.thickness_field_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.thickness_field_type.md @@ -4,4 +4,4 @@ #### *property* ModelingPly.thickness_field_type -The type of the Thickness field ‘absolute’ or ‘relative’ +The type of the Thickness field `absolute` or `relative` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.write_boundaries.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.write_boundaries.md index ac735a74f1..9d533a9ee7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.write_boundaries.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ModelingPly.write_boundaries.md @@ -8,8 +8,8 @@ Write boundaries in iges/step format. * **Parameters:** - filename: Output file. - - format: ‘iges’, ‘step’, None (automatic format recognition). - - offset_type: ‘no_offset’ (default), ‘bottom_offset’, ‘middle_offset’, ‘top_offset’. + - format: `iges`, `step`, `None` (automatic format recognition). + - offset_type: `no_offset` (default), `bottom_offset`, `middle_offset`, `top_offset`. - with_direction_arrows: The element directions should be written to. - arrow_length: Length of the direction arrows (default is average element edge size). - - arrow_type: Type to be used as arrows (‘standard_arrow’(default), ‘no_arrow’, ‘half_arrow’). + - arrow_type: Type to be used as arrows (`standard_arrow` (default), `no_arrow`, `half_arrow`). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.enabled.md index eb2b535e3c..4c9880f25a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.enabled.md @@ -4,4 +4,4 @@ #### *property* OrientedSelectionSet.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.is_dict_item.md index 144295e1f9..598f8ba530 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* OrientedSelectionSet.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.is_list_item.md index 56b24a3ebd..9a66e3bf49 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.is_list_item.md @@ -4,4 +4,4 @@ #### *property* OrientedSelectionSet.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.md index 0cb7026705..15b7de5708 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.md @@ -10,63 +10,63 @@ Class to represent oriented selection set. | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| -| [`OrientedSelectionSet.active`](compolyx.OrientedSelectionSet.active.md#compolyx.OrientedSelectionSet.active) | active status of object | -| [`OrientedSelectionSet.auto_draping_direction`](compolyx.OrientedSelectionSet.auto_draping_direction.md#compolyx.OrientedSelectionSet.auto_draping_direction) | Automatic selection of draping direction. | +| [`OrientedSelectionSet.active`](compolyx.OrientedSelectionSet.active.md#compolyx.OrientedSelectionSet.active) | Active status of object | +| [`OrientedSelectionSet.auto_draping_direction`](compolyx.OrientedSelectionSet.auto_draping_direction.md#compolyx.OrientedSelectionSet.auto_draping_direction) | Automatic selection of draping direction | | [`OrientedSelectionSet.boundaries`](compolyx.OrientedSelectionSet.boundaries.md#compolyx.OrientedSelectionSet.boundaries) | Get the boundaries of the Oriented Selection Set | | [`OrientedSelectionSet.draping`](compolyx.OrientedSelectionSet.draping.md#compolyx.OrientedSelectionSet.draping) | Flag for using draping or not | -| [`OrientedSelectionSet.draping_direction`](compolyx.OrientedSelectionSet.draping_direction.md#compolyx.OrientedSelectionSet.draping_direction) | The direction in which the draping starts. | -| [`OrientedSelectionSet.draping_material_model`](compolyx.OrientedSelectionSet.draping_material_model.md#compolyx.OrientedSelectionSet.draping_material_model) | Draping material model. | -| [`OrientedSelectionSet.draping_mesh_size`](compolyx.OrientedSelectionSet.draping_mesh_size.md#compolyx.OrientedSelectionSet.draping_mesh_size) | The mesh size for draping. | +| [`OrientedSelectionSet.draping_direction`](compolyx.OrientedSelectionSet.draping_direction.md#compolyx.OrientedSelectionSet.draping_direction) | The direction in which the draping starts | +| [`OrientedSelectionSet.draping_material_model`](compolyx.OrientedSelectionSet.draping_material_model.md#compolyx.OrientedSelectionSet.draping_material_model) | Draping material model | +| [`OrientedSelectionSet.draping_mesh_size`](compolyx.OrientedSelectionSet.draping_mesh_size.md#compolyx.OrientedSelectionSet.draping_mesh_size) | The mesh size for draping | | [`OrientedSelectionSet.draping_obj`](compolyx.OrientedSelectionSet.draping_obj.md#compolyx.OrientedSelectionSet.draping_obj) | Draping representation | | [`OrientedSelectionSet.draping_seed_point`](compolyx.OrientedSelectionSet.draping_seed_point.md#compolyx.OrientedSelectionSet.draping_seed_point) | The seed point where the draping starts. | | [`OrientedSelectionSet.draping_ud_coefficient`](compolyx.OrientedSelectionSet.draping_ud_coefficient.md#compolyx.OrientedSelectionSet.draping_ud_coefficient) | UD draping coefficient | -| [`OrientedSelectionSet.element_sets`](compolyx.OrientedSelectionSet.element_sets.md#compolyx.OrientedSelectionSet.element_sets) | Element Sets of the oriented element set. | -| [`OrientedSelectionSet.elements`](compolyx.OrientedSelectionSet.elements.md#compolyx.OrientedSelectionSet.elements) | Elements of the Oriented Selection Set. | -| [`OrientedSelectionSet.enabled`](compolyx.OrientedSelectionSet.enabled.md#compolyx.OrientedSelectionSet.enabled) | Whether this object is currently enabled or not. | +| [`OrientedSelectionSet.element_sets`](compolyx.OrientedSelectionSet.element_sets.md#compolyx.OrientedSelectionSet.element_sets) | Element Sets of the oriented element set | +| [`OrientedSelectionSet.elements`](compolyx.OrientedSelectionSet.elements.md#compolyx.OrientedSelectionSet.elements) | Elements of the Oriented Selection Set | +| [`OrientedSelectionSet.enabled`](compolyx.OrientedSelectionSet.enabled.md#compolyx.OrientedSelectionSet.enabled) | Whether this object is currently enabled or not | | [`OrientedSelectionSet.id`](compolyx.OrientedSelectionSet.id.md#compolyx.OrientedSelectionSet.id) | ID of object | -| [`OrientedSelectionSet.is_dict_item`](compolyx.OrientedSelectionSet.is_dict_item.md#compolyx.OrientedSelectionSet.is_dict_item) | Specifies wether the object is an item of a dict | -| [`OrientedSelectionSet.is_list_item`](compolyx.OrientedSelectionSet.is_list_item.md#compolyx.OrientedSelectionSet.is_list_item) | Specifies wether the object is an item of a list | +| [`OrientedSelectionSet.is_dict_item`](compolyx.OrientedSelectionSet.is_dict_item.md#compolyx.OrientedSelectionSet.is_dict_item) | Specifies whether the object is an item of a dict | +| [`OrientedSelectionSet.is_list_item`](compolyx.OrientedSelectionSet.is_list_item.md#compolyx.OrientedSelectionSet.is_list_item) | Specifies whether the object is an item of a list | | [`OrientedSelectionSet.link_path`](compolyx.OrientedSelectionSet.link_path.md#compolyx.OrientedSelectionSet.link_path) | Root path of the current node in the tree for links to this object | | [`OrientedSelectionSet.name`](compolyx.OrientedSelectionSet.name.md#compolyx.OrientedSelectionSet.name) | Name of object | | [`OrientedSelectionSet.normals`](compolyx.OrientedSelectionSet.normals.md#compolyx.OrientedSelectionSet.normals) | Get the Normals of the Oriented Selection Set | -| [`OrientedSelectionSet.orientation_direction`](compolyx.OrientedSelectionSet.orientation_direction.md#compolyx.OrientedSelectionSet.orientation_direction) | The Orientation Direction of the Oriented Element set. | -| [`OrientedSelectionSet.orientation_point`](compolyx.OrientedSelectionSet.orientation_point.md#compolyx.OrientedSelectionSet.orientation_point) | The Orientation Point of the Oriented Selection Set. | +| [`OrientedSelectionSet.orientation_direction`](compolyx.OrientedSelectionSet.orientation_direction.md#compolyx.OrientedSelectionSet.orientation_direction) | The Orientation Direction of the Oriented Element set | +| [`OrientedSelectionSet.orientation_point`](compolyx.OrientedSelectionSet.orientation_point.md#compolyx.OrientedSelectionSet.orientation_point) | The Orientation Point of the Oriented Selection Set | | [`OrientedSelectionSet.orientations`](compolyx.OrientedSelectionSet.orientations.md#compolyx.OrientedSelectionSet.orientations) | Get the oriented normals of the Oriented Selection Set | | [`OrientedSelectionSet.parent`](compolyx.OrientedSelectionSet.parent.md#compolyx.OrientedSelectionSet.parent) | Parent object in tree | | [`OrientedSelectionSet.ref_directions`](compolyx.OrientedSelectionSet.ref_directions.md#compolyx.OrientedSelectionSet.ref_directions) | Get the Refernce Directions of the Oriented Selection Set | -| [`OrientedSelectionSet.reference_direction_field`](compolyx.OrientedSelectionSet.reference_direction_field.md#compolyx.OrientedSelectionSet.reference_direction_field) | a look-up table column or None for external reference directions | +| [`OrientedSelectionSet.reference_direction_field`](compolyx.OrientedSelectionSet.reference_direction_field.md#compolyx.OrientedSelectionSet.reference_direction_field) | a lookup table column or None for external reference directions | | [`OrientedSelectionSet.root_path`](compolyx.OrientedSelectionSet.root_path.md#compolyx.OrientedSelectionSet.root_path) | Root path of the current node in the tree | -| [`OrientedSelectionSet.rosette_selection_method`](compolyx.OrientedSelectionSet.rosette_selection_method.md#compolyx.OrientedSelectionSet.rosette_selection_method) | Selection Method for Rosettes of the Oriented Selection Set. | -| [`OrientedSelectionSet.rosettes`](compolyx.OrientedSelectionSet.rosettes.md#compolyx.OrientedSelectionSet.rosettes) | Rosettes of the Oriented Selection Set. | -| [`OrientedSelectionSet.rotation_angle`](compolyx.OrientedSelectionSet.rotation_angle.md#compolyx.OrientedSelectionSet.rotation_angle) | Angle to rotate the reference directions around the orientation directions (in degree). | -| [`OrientedSelectionSet.selection_rules`](compolyx.OrientedSelectionSet.selection_rules.md#compolyx.OrientedSelectionSet.selection_rules) | Selection Rules of the Oriented Selection Set. | +| [`OrientedSelectionSet.rosette_selection_method`](compolyx.OrientedSelectionSet.rosette_selection_method.md#compolyx.OrientedSelectionSet.rosette_selection_method) | Selection Method for Rosettes of the Oriented Selection Set | +| [`OrientedSelectionSet.rosettes`](compolyx.OrientedSelectionSet.rosettes.md#compolyx.OrientedSelectionSet.rosettes) | Rosettes of the Oriented Selection Set | +| [`OrientedSelectionSet.rotation_angle`](compolyx.OrientedSelectionSet.rotation_angle.md#compolyx.OrientedSelectionSet.rotation_angle) | Angle to rotate the reference directions around the orientation directions (in degree) | +| [`OrientedSelectionSet.selection_rules`](compolyx.OrientedSelectionSet.selection_rules.md#compolyx.OrientedSelectionSet.selection_rules) | Selection Rules of the Oriented Selection Set | | [`OrientedSelectionSet.status`](compolyx.OrientedSelectionSet.status.md#compolyx.OrientedSelectionSet.status) | Status of the object | -| [`OrientedSelectionSet.status_changed`](compolyx.OrientedSelectionSet.status_changed.md#compolyx.OrientedSelectionSet.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`OrientedSelectionSet.status_changed`](compolyx.OrientedSelectionSet.status_changed.md#compolyx.OrientedSelectionSet.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`OrientedSelectionSet.uid`](compolyx.OrientedSelectionSet.uid.md#compolyx.OrientedSelectionSet.uid) | UID of object | | [`OrientedSelectionSet.use_default_draping_mesh_size`](compolyx.OrientedSelectionSet.use_default_draping_mesh_size.md#compolyx.OrientedSelectionSet.use_default_draping_mesh_size) | Whether to use a default size for the draping mesh. | -| [`OrientedSelectionSet.vertex`](compolyx.OrientedSelectionSet.vertex.md#compolyx.OrientedSelectionSet.vertex) | This will throw an error if the object has been removed from the graph. | +| [`OrientedSelectionSet.vertex`](compolyx.OrientedSelectionSet.vertex.md#compolyx.OrientedSelectionSet.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`OrientedSelectionSet.add_element_set`](compolyx.OrientedSelectionSet.add_element_set.md#compolyx.OrientedSelectionSet.add_element_set)(element_set) | Add element set to oriented selection set. | -| [`OrientedSelectionSet.add_rosette`](compolyx.OrientedSelectionSet.add_rosette.md#compolyx.OrientedSelectionSet.add_rosette)(rosette) | Add rosette to oriented selection set. | -| [`OrientedSelectionSet.add_selection_rule`](compolyx.OrientedSelectionSet.add_selection_rule.md#compolyx.OrientedSelectionSet.add_selection_rule)(rule) | Add selection rule to oriented selection set. | -| [`OrientedSelectionSet.clear_element_sets`](compolyx.OrientedSelectionSet.clear_element_sets.md#compolyx.OrientedSelectionSet.clear_element_sets)() | Clear element sets of oriented selection set. | -| [`OrientedSelectionSet.clear_rosettes`](compolyx.OrientedSelectionSet.clear_rosettes.md#compolyx.OrientedSelectionSet.clear_rosettes)() | Clear rosettes of oriented selection set. | -| [`OrientedSelectionSet.clear_selection_rules`](compolyx.OrientedSelectionSet.clear_selection_rules.md#compolyx.OrientedSelectionSet.clear_selection_rules)() | Clear selection rules of oriented selection set. | -| [`OrientedSelectionSet.find_parent`](compolyx.OrientedSelectionSet.find_parent.md#compolyx.OrientedSelectionSet.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`OrientedSelectionSet.add_element_set`](compolyx.OrientedSelectionSet.add_element_set.md#compolyx.OrientedSelectionSet.add_element_set)(element_set) | Add element set to oriented selection set | +| [`OrientedSelectionSet.add_rosette`](compolyx.OrientedSelectionSet.add_rosette.md#compolyx.OrientedSelectionSet.add_rosette)(rosette) | Add rosette to oriented selection set | +| [`OrientedSelectionSet.add_selection_rule`](compolyx.OrientedSelectionSet.add_selection_rule.md#compolyx.OrientedSelectionSet.add_selection_rule)(rule) | Add selection rule to oriented selection set | +| [`OrientedSelectionSet.clear_element_sets`](compolyx.OrientedSelectionSet.clear_element_sets.md#compolyx.OrientedSelectionSet.clear_element_sets)() | Clear element sets of oriented selection set | +| [`OrientedSelectionSet.clear_rosettes`](compolyx.OrientedSelectionSet.clear_rosettes.md#compolyx.OrientedSelectionSet.clear_rosettes)() | Clear rosettes of oriented selection set | +| [`OrientedSelectionSet.clear_selection_rules`](compolyx.OrientedSelectionSet.clear_selection_rules.md#compolyx.OrientedSelectionSet.clear_selection_rules)() | Clear selection rules of oriented selection set | +| [`OrientedSelectionSet.find_parent`](compolyx.OrientedSelectionSet.find_parent.md#compolyx.OrientedSelectionSet.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`OrientedSelectionSet.get_short_description`](compolyx.OrientedSelectionSet.get_short_description.md#compolyx.OrientedSelectionSet.get_short_description)() | | | [`OrientedSelectionSet.normal_from_id`](compolyx.OrientedSelectionSet.normal_from_id.md#compolyx.OrientedSelectionSet.normal_from_id)(id) | Returns the element normal | -| [`OrientedSelectionSet.obj_exists`](compolyx.OrientedSelectionSet.obj_exists.md#compolyx.OrientedSelectionSet.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. | +| [`OrientedSelectionSet.obj_exists`](compolyx.OrientedSelectionSet.obj_exists.md#compolyx.OrientedSelectionSet.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 | | [`OrientedSelectionSet.reference_element_id`](compolyx.OrientedSelectionSet.reference_element_id.md#compolyx.OrientedSelectionSet.reference_element_id)() | | -| [`OrientedSelectionSet.remove_element_set`](compolyx.OrientedSelectionSet.remove_element_set.md#compolyx.OrientedSelectionSet.remove_element_set)(...) | Remove element set from oriented selection set. | -| [`OrientedSelectionSet.remove_rosette`](compolyx.OrientedSelectionSet.remove_rosette.md#compolyx.OrientedSelectionSet.remove_rosette)(rosette) | Remove rosette from oriented selection set. | -| [`OrientedSelectionSet.remove_selection_rule`](compolyx.OrientedSelectionSet.remove_selection_rule.md#compolyx.OrientedSelectionSet.remove_selection_rule)(rule) | Remove rule from oriented selection set. | -| [`OrientedSelectionSet.save_flat_wrap`](compolyx.OrientedSelectionSet.save_flat_wrap.md#compolyx.OrientedSelectionSet.save_flat_wrap)(filename) | Write the flatwrap to .dxf, .iges, or .step file. | -| [`OrientedSelectionSet.serialize`](compolyx.OrientedSelectionSet.serialize.md#compolyx.OrientedSelectionSet.serialize)() | Serialize to Python string. | -| [`OrientedSelectionSet.serialize_name_and_id`](compolyx.OrientedSelectionSet.serialize_name_and_id.md#compolyx.OrientedSelectionSet.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`OrientedSelectionSet.remove_element_set`](compolyx.OrientedSelectionSet.remove_element_set.md#compolyx.OrientedSelectionSet.remove_element_set)(...) | Remove element set from oriented selection set | +| [`OrientedSelectionSet.remove_rosette`](compolyx.OrientedSelectionSet.remove_rosette.md#compolyx.OrientedSelectionSet.remove_rosette)(rosette) | Remove rosette from oriented selection set | +| [`OrientedSelectionSet.remove_selection_rule`](compolyx.OrientedSelectionSet.remove_selection_rule.md#compolyx.OrientedSelectionSet.remove_selection_rule)(rule) | Remove rule from oriented selection set | +| [`OrientedSelectionSet.save_flat_wrap`](compolyx.OrientedSelectionSet.save_flat_wrap.md#compolyx.OrientedSelectionSet.save_flat_wrap)(filename) | Write the flatwrap to .dxf, .iges, or .step file | +| [`OrientedSelectionSet.serialize`](compolyx.OrientedSelectionSet.serialize.md#compolyx.OrientedSelectionSet.serialize)() | Serialize to Python string | +| [`OrientedSelectionSet.serialize_name_and_id`](compolyx.OrientedSelectionSet.serialize_name_and_id.md#compolyx.OrientedSelectionSet.serialize_name_and_id)() | Helper function to serialize name and ID | | [`OrientedSelectionSet.update`](compolyx.OrientedSelectionSet.update.md#compolyx.OrientedSelectionSet.update)() | | -| [`OrientedSelectionSet.visit`](compolyx.OrientedSelectionSet.visit.md#compolyx.OrientedSelectionSet.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | -| [`OrientedSelectionSet.write_boundaries`](compolyx.OrientedSelectionSet.write_boundaries.md#compolyx.OrientedSelectionSet.write_boundaries)(filename) | Write boundaries in .iges/.step format. | +| [`OrientedSelectionSet.visit`](compolyx.OrientedSelectionSet.visit.md#compolyx.OrientedSelectionSet.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | +| [`OrientedSelectionSet.write_boundaries`](compolyx.OrientedSelectionSet.write_boundaries.md#compolyx.OrientedSelectionSet.write_boundaries)(filename) | Write boundaries in .iges/.step format | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.obj_exists.md index bc3c8cea61..a9450e14e3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.obj_exists.md @@ -4,5 +4,5 @@ #### OrientedSelectionSet.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.visit.md index 2e57cd1d32..ae7927724b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.write_boundaries.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.write_boundaries.md index dc7ab36b44..9060e8bd15 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.write_boundaries.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.OrientedSelectionSet.write_boundaries.md @@ -9,4 +9,4 @@ Write boundaries in .iges/.step format. * **Parameters:** - filename: Output file. -- format: ‘iges’, ‘step’, or ‘None’ (automatic format recognition). +- format: `iges`, `step`, or `None` (automatic format recognition). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.enabled.md index cc56a70146..02749d709d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.enabled.md @@ -4,4 +4,4 @@ #### *property* ParallelSelectionRule.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.is_dict_item.md index 2194bf3804..7d3c4764ea 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ParallelSelectionRule.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.is_list_item.md index a8f8d38f16..f9bbc09bd7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ParallelSelectionRule.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.md index 68f325c947..f19e23a765 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.md @@ -10,41 +10,41 @@ Parallel selection rule. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`ParallelSelectionRule.active`](compolyx.ParallelSelectionRule.active.md#compolyx.ParallelSelectionRule.active) | active status of object | +| [`ParallelSelectionRule.active`](compolyx.ParallelSelectionRule.active.md#compolyx.ParallelSelectionRule.active) | Active status of object | | [`ParallelSelectionRule.changed`](compolyx.ParallelSelectionRule.changed.md#compolyx.ParallelSelectionRule.changed) | Triggers Observable to dispatch changed message | -| [`ParallelSelectionRule.direction`](compolyx.ParallelSelectionRule.direction.md#compolyx.ParallelSelectionRule.direction) | Direction of the Parallel Selection Rule. | +| [`ParallelSelectionRule.direction`](compolyx.ParallelSelectionRule.direction.md#compolyx.ParallelSelectionRule.direction) | Direction of the Parallel Selection Rule | | [`ParallelSelectionRule.direction_in_global_coordinates`](compolyx.ParallelSelectionRule.direction_in_global_coordinates.md#compolyx.ParallelSelectionRule.direction_in_global_coordinates) | Direction of the rule in global coordinates | -| [`ParallelSelectionRule.enabled`](compolyx.ParallelSelectionRule.enabled.md#compolyx.ParallelSelectionRule.enabled) | Whether this object is currently enabled or not. | -| [`ParallelSelectionRule.extent`](compolyx.ParallelSelectionRule.extent.md#compolyx.ParallelSelectionRule.extent) | extent of the rule | +| [`ParallelSelectionRule.enabled`](compolyx.ParallelSelectionRule.enabled.md#compolyx.ParallelSelectionRule.enabled) | Whether this object is currently enabled or not | +| [`ParallelSelectionRule.extent`](compolyx.ParallelSelectionRule.extent.md#compolyx.ParallelSelectionRule.extent) | Extent of the rule | | [`ParallelSelectionRule.id`](compolyx.ParallelSelectionRule.id.md#compolyx.ParallelSelectionRule.id) | ID of object | -| [`ParallelSelectionRule.include_rule_type`](compolyx.ParallelSelectionRule.include_rule_type.md#compolyx.ParallelSelectionRule.include_rule_type) | include type | -| [`ParallelSelectionRule.is_dict_item`](compolyx.ParallelSelectionRule.is_dict_item.md#compolyx.ParallelSelectionRule.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ParallelSelectionRule.is_list_item`](compolyx.ParallelSelectionRule.is_list_item.md#compolyx.ParallelSelectionRule.is_list_item) | Specifies wether the object is an item of a list | +| [`ParallelSelectionRule.include_rule_type`](compolyx.ParallelSelectionRule.include_rule_type.md#compolyx.ParallelSelectionRule.include_rule_type) | Include type | +| [`ParallelSelectionRule.is_dict_item`](compolyx.ParallelSelectionRule.is_dict_item.md#compolyx.ParallelSelectionRule.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ParallelSelectionRule.is_list_item`](compolyx.ParallelSelectionRule.is_list_item.md#compolyx.ParallelSelectionRule.is_list_item) | Specifies whether the object is an item of a list | | [`ParallelSelectionRule.link_path`](compolyx.ParallelSelectionRule.link_path.md#compolyx.ParallelSelectionRule.link_path) | Root path of the current node in the tree for links to this object | | [`ParallelSelectionRule.name`](compolyx.ParallelSelectionRule.name.md#compolyx.ParallelSelectionRule.name) | Name of object | | [`ParallelSelectionRule.neg_distance`](compolyx.ParallelSelectionRule.neg_distance.md#compolyx.ParallelSelectionRule.neg_distance) | Negative distance | -| [`ParallelSelectionRule.origin`](compolyx.ParallelSelectionRule.origin.md#compolyx.ParallelSelectionRule.origin) | Origin of the Parallel Selection Rule. | +| [`ParallelSelectionRule.origin`](compolyx.ParallelSelectionRule.origin.md#compolyx.ParallelSelectionRule.origin) | Origin of the Parallel Selection Rule | | [`ParallelSelectionRule.origin_in_global_coordinates`](compolyx.ParallelSelectionRule.origin_in_global_coordinates.md#compolyx.ParallelSelectionRule.origin_in_global_coordinates) | Origin of the rule in global coordinates | | [`ParallelSelectionRule.parent`](compolyx.ParallelSelectionRule.parent.md#compolyx.ParallelSelectionRule.parent) | Parent object in tree | | [`ParallelSelectionRule.pos_distance`](compolyx.ParallelSelectionRule.pos_distance.md#compolyx.ParallelSelectionRule.pos_distance) | Positive distance | -| [`ParallelSelectionRule.relative_rule_type`](compolyx.ParallelSelectionRule.relative_rule_type.md#compolyx.ParallelSelectionRule.relative_rule_type) | relative type | +| [`ParallelSelectionRule.relative_rule_type`](compolyx.ParallelSelectionRule.relative_rule_type.md#compolyx.ParallelSelectionRule.relative_rule_type) | Relative type | | [`ParallelSelectionRule.root_path`](compolyx.ParallelSelectionRule.root_path.md#compolyx.ParallelSelectionRule.root_path) | Root path of the current node in the tree | | [`ParallelSelectionRule.rosette`](compolyx.ParallelSelectionRule.rosette.md#compolyx.ParallelSelectionRule.rosette) | Rosette of the used for origin and direction | | [`ParallelSelectionRule.status`](compolyx.ParallelSelectionRule.status.md#compolyx.ParallelSelectionRule.status) | Status of the object | -| [`ParallelSelectionRule.status_changed`](compolyx.ParallelSelectionRule.status_changed.md#compolyx.ParallelSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`ParallelSelectionRule.status_changed`](compolyx.ParallelSelectionRule.status_changed.md#compolyx.ParallelSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`ParallelSelectionRule.uid`](compolyx.ParallelSelectionRule.uid.md#compolyx.ParallelSelectionRule.uid) | UID of object | | [`ParallelSelectionRule.use_global_coordinate_system`](compolyx.ParallelSelectionRule.use_global_coordinate_system.md#compolyx.ParallelSelectionRule.use_global_coordinate_system) | Use global coordinate system for origin and direction | -| [`ParallelSelectionRule.vertex`](compolyx.ParallelSelectionRule.vertex.md#compolyx.ParallelSelectionRule.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ParallelSelectionRule.vertex`](compolyx.ParallelSelectionRule.vertex.md#compolyx.ParallelSelectionRule.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ParallelSelectionRule.find_parent`](compolyx.ParallelSelectionRule.find_parent.md#compolyx.ParallelSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`ParallelSelectionRule.find_parent`](compolyx.ParallelSelectionRule.find_parent.md#compolyx.ParallelSelectionRule.find_parent)(type) | Steps up the tree and returns the first parent with given type | | [`ParallelSelectionRule.get_short_description`](compolyx.ParallelSelectionRule.get_short_description.md#compolyx.ParallelSelectionRule.get_short_description)() | | -| [`ParallelSelectionRule.obj_exists`](compolyx.ParallelSelectionRule.obj_exists.md#compolyx.ParallelSelectionRule.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. | -| [`ParallelSelectionRule.serialize`](compolyx.ParallelSelectionRule.serialize.md#compolyx.ParallelSelectionRule.serialize)() | Serialize to Python string. | -| [`ParallelSelectionRule.serialize_name_and_id`](compolyx.ParallelSelectionRule.serialize_name_and_id.md#compolyx.ParallelSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ParallelSelectionRule.obj_exists`](compolyx.ParallelSelectionRule.obj_exists.md#compolyx.ParallelSelectionRule.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 | +| [`ParallelSelectionRule.serialize`](compolyx.ParallelSelectionRule.serialize.md#compolyx.ParallelSelectionRule.serialize)() | Serialize to Python string | +| [`ParallelSelectionRule.serialize_name_and_id`](compolyx.ParallelSelectionRule.serialize_name_and_id.md#compolyx.ParallelSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ParallelSelectionRule.serialize_rule_types`](compolyx.ParallelSelectionRule.serialize_rule_types.md#compolyx.ParallelSelectionRule.serialize_rule_types)() | | | [`ParallelSelectionRule.update`](compolyx.ParallelSelectionRule.update.md#compolyx.ParallelSelectionRule.update)() | | -| [`ParallelSelectionRule.visit`](compolyx.ParallelSelectionRule.visit.md#compolyx.ParallelSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ParallelSelectionRule.visit`](compolyx.ParallelSelectionRule.visit.md#compolyx.ParallelSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.obj_exists.md index e97fb8551d..ce7150716e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.obj_exists.md @@ -4,5 +4,5 @@ #### ParallelSelectionRule.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.visit.md index a208cd3f54..3e2f7fc6b7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.ParallelSelectionRule.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.is_dict_item.md index aa6faa6d49..0ba241f125 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* PlyBook.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.is_list_item.md index 1503dfc91d..4b7547f63a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.is_list_item.md @@ -4,4 +4,4 @@ #### *property* PlyBook.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.md index 22d062bbbf..26d63f6adc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PlyBook.md @@ -10,9 +10,9 @@ Class to represent a ply book. | Name | Description | |---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| -| [`PlyBook.chapters`](compolyx.PlyBook.chapters.md#compolyx.PlyBook.chapters) | Dictionary with all chapters defined. | -| [`PlyBook.is_dict_item`](compolyx.PlyBook.is_dict_item.md#compolyx.PlyBook.is_dict_item) | Specifies wether the object is an item of a dict | -| [`PlyBook.is_list_item`](compolyx.PlyBook.is_list_item.md#compolyx.PlyBook.is_list_item) | Specifies wether the object is an item of a list | +| [`PlyBook.chapters`](compolyx.PlyBook.chapters.md#compolyx.PlyBook.chapters) | Dictionary with all chapters defined | +| [`PlyBook.is_dict_item`](compolyx.PlyBook.is_dict_item.md#compolyx.PlyBook.is_dict_item) | Specifies whether the object is an item of a dict | +| [`PlyBook.is_list_item`](compolyx.PlyBook.is_list_item.md#compolyx.PlyBook.is_list_item) | Specifies whether the object is an item of a list | | [`PlyBook.link_path`](compolyx.PlyBook.link_path.md#compolyx.PlyBook.link_path) | Root path of the current node in the tree for links to this object | | [`PlyBook.name`](compolyx.PlyBook.name.md#compolyx.PlyBook.name) | Name of object | | [`PlyBook.parent`](compolyx.PlyBook.parent.md#compolyx.PlyBook.parent) | Parent object in tree | @@ -27,10 +27,10 @@ Class to represent a ply book. | Name | Description | |------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| | [`PlyBook.automatic_setup`](compolyx.PlyBook.automatic_setup.md#compolyx.PlyBook.automatic_setup)() | | -| [`PlyBook.create_chapter`](compolyx.PlyBook.create_chapter.md#compolyx.PlyBook.create_chapter)(name[, view, ...]) | Add a chapter to the ply book. | -| [`PlyBook.find_parent`](compolyx.PlyBook.find_parent.md#compolyx.PlyBook.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`PlyBook.generate`](compolyx.PlyBook.generate.md#compolyx.PlyBook.generate)(filename[, format]) | Generate the complete plybook. | +| [`PlyBook.create_chapter`](compolyx.PlyBook.create_chapter.md#compolyx.PlyBook.create_chapter)(name[, view, ...]) | Add a chapter to the ply book | +| [`PlyBook.find_parent`](compolyx.PlyBook.find_parent.md#compolyx.PlyBook.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`PlyBook.generate`](compolyx.PlyBook.generate.md#compolyx.PlyBook.generate)(filename[, format]) | Generate the complete plybook | | [`PlyBook.initialize_plybook`](compolyx.PlyBook.initialize_plybook.md#compolyx.PlyBook.initialize_plybook)(\*\*kwargs) | | | [`PlyBook.serialize`](compolyx.PlyBook.serialize.md#compolyx.PlyBook.serialize)() | | | [`PlyBook.update`](compolyx.PlyBook.update.md#compolyx.PlyBook.update)() | | -| [`PlyBook.visit`](compolyx.PlyBook.visit.md#compolyx.PlyBook.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`PlyBook.visit`](compolyx.PlyBook.visit.md#compolyx.PlyBook.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PropertySet.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PropertySet.md index 1ec94cd2ac..abb7ca7c5a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PropertySet.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PropertySet.md @@ -26,14 +26,14 @@ This class wraps GIL-functionality and adds Python-UI utilities to all material | Name | Description | |-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| -| [`PropertySet.independent_names`](compolyx.PropertySet.independent_names.md#compolyx.PropertySet.independent_names) | List of the independent variable names. | -| [`PropertySet.is_constant`](compolyx.PropertySet.is_constant.md#compolyx.PropertySet.is_constant) | True if the Engineering Constants of this material are constant. | -| [`PropertySet.property_names`](compolyx.PropertySet.property_names.md#compolyx.PropertySet.property_names) | Propety name list. | +| [`PropertySet.independent_names`](compolyx.PropertySet.independent_names.md#compolyx.PropertySet.independent_names) | List of the independent variable names | +| [`PropertySet.is_constant`](compolyx.PropertySet.is_constant.md#compolyx.PropertySet.is_constant) | True if the Engineering Constants of this material are constant | +| [`PropertySet.property_names`](compolyx.PropertySet.property_names.md#compolyx.PropertySet.property_names) | Propety name list | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------|------------------------------------------| -| [`PropertySet.get`](compolyx.PropertySet.get.md#compolyx.PropertySet.get)([variables]) | Get raw PropertySet data. | -| [`PropertySet.query`](compolyx.PropertySet.query.md#compolyx.PropertySet.query)([variables, environment_point]) | Query PropertySet data. | -| [`PropertySet.set`](compolyx.PropertySet.set.md#compolyx.PropertySet.set)([props]) | Set constant and variable material data. | +| [`PropertySet.get`](compolyx.PropertySet.get.md#compolyx.PropertySet.get)([variables]) | Get raw PropertySet data | +| [`PropertySet.query`](compolyx.PropertySet.query.md#compolyx.PropertySet.query)([variables, environment_point]) | Query PropertySet data | +| [`PropertySet.set`](compolyx.PropertySet.set.md#compolyx.PropertySet.set)([props]) | Set constant and variable material data | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.acp_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.acp_type.md index 457414e33c..e2fbba2dce 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.acp_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.acp_type.md @@ -4,4 +4,4 @@ #### *property* PublishedParameter.acp_type -ACP parameter type. Can be one of: ‘int’, ‘float’, ‘float_list’, ‘bool’, ‘string’ or None +ACP parameter type. Available options: `int`, `float`, `float_list`, `bool`, `string`, or `None`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.ansys_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.ansys_type.md index 94704ffe5f..864ef92fbd 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.ansys_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.ansys_type.md @@ -4,4 +4,4 @@ #### *property* PublishedParameter.ansys_type -ANSYS parameter type where ACP parameter is mapped to. Can be one of: ‘int’, ‘double’, ‘boolean’, or None +ANSYS parameter type where ACP parameter is mapped to. Available options: `int`, `double`, `boolean`, or `None`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.category.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.category.md index 9cbd06a172..737718b112 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.category.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.category.md @@ -4,4 +4,4 @@ #### *property* PublishedParameter.category -Should be one of: input, unbound_input, output or expression_output +Available options: `input`, `unbound_input`, `output`, and `expression_output`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.enabled.md index 481bcca0aa..cd6ea21cea 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.enabled.md @@ -4,4 +4,4 @@ #### *property* PublishedParameter.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.is_dict_item.md index b1438e3466..95d76f90d5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* PublishedParameter.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.is_list_item.md index 028213416c..79764fb4f1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.is_list_item.md @@ -4,4 +4,4 @@ #### *property* PublishedParameter.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.md index 54680d8288..399bff8a6d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.md @@ -10,15 +10,15 @@ Class to represent parameters which are linked to the Ansys Workbench applicatio | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| -| [`PublishedParameter.acp_type`](compolyx.PublishedParameter.acp_type.md#compolyx.PublishedParameter.acp_type) | ACP parameter type. | -| [`PublishedParameter.ansys_type`](compolyx.PublishedParameter.ansys_type.md#compolyx.PublishedParameter.ansys_type) | ANSYS parameter type where ACP parameter is mapped to. | +| [`PublishedParameter.acp_type`](compolyx.PublishedParameter.acp_type.md#compolyx.PublishedParameter.acp_type) | ACP parameter type | +| [`PublishedParameter.ansys_type`](compolyx.PublishedParameter.ansys_type.md#compolyx.PublishedParameter.ansys_type) | ANSYS parameter type where ACP parameter is mapped to | | [`PublishedParameter.category`](compolyx.PublishedParameter.category.md#compolyx.PublishedParameter.category) | Should be one of: input, unbound_input, output or expression_output | | [`PublishedParameter.cyclic`](compolyx.PublishedParameter.cyclic.md#compolyx.PublishedParameter.cyclic) | Whether a float value is cyclic or not | | [`PublishedParameter.description`](compolyx.PublishedParameter.description.md#compolyx.PublishedParameter.description) | A human-readable description of the linked parameter | -| [`PublishedParameter.enabled`](compolyx.PublishedParameter.enabled.md#compolyx.PublishedParameter.enabled) | Whether this object is currently enabled or not. | +| [`PublishedParameter.enabled`](compolyx.PublishedParameter.enabled.md#compolyx.PublishedParameter.enabled) | Whether this object is currently enabled or not | | [`PublishedParameter.float_list`](compolyx.PublishedParameter.float_list.md#compolyx.PublishedParameter.float_list) | A list of possible values for a float | -| [`PublishedParameter.is_dict_item`](compolyx.PublishedParameter.is_dict_item.md#compolyx.PublishedParameter.is_dict_item) | Specifies wether the object is an item of a dict | -| [`PublishedParameter.is_list_item`](compolyx.PublishedParameter.is_list_item.md#compolyx.PublishedParameter.is_list_item) | Specifies wether the object is an item of a list | +| [`PublishedParameter.is_dict_item`](compolyx.PublishedParameter.is_dict_item.md#compolyx.PublishedParameter.is_dict_item) | Specifies whether the object is an item of a dict | +| [`PublishedParameter.is_list_item`](compolyx.PublishedParameter.is_list_item.md#compolyx.PublishedParameter.is_list_item) | Specifies whether the object is an item of a list | | [`PublishedParameter.link_path`](compolyx.PublishedParameter.link_path.md#compolyx.PublishedParameter.link_path) | Root path of the current node in the tree for links to this object | | [`PublishedParameter.lower_limit`](compolyx.PublishedParameter.lower_limit.md#compolyx.PublishedParameter.lower_limit) | The lower limit for numeric values | | [`PublishedParameter.name`](compolyx.PublishedParameter.name.md#compolyx.PublishedParameter.name) | Name of object | @@ -26,20 +26,20 @@ Class to represent parameters which are linked to the Ansys Workbench applicatio | [`PublishedParameter.root_path`](compolyx.PublishedParameter.root_path.md#compolyx.PublishedParameter.root_path) | Root path of the current node in the tree | | [`PublishedParameter.source_object`](compolyx.PublishedParameter.source_object.md#compolyx.PublishedParameter.source_object) | | | [`PublishedParameter.source_property`](compolyx.PublishedParameter.source_property.md#compolyx.PublishedParameter.source_property) | | -| [`PublishedParameter.string_list`](compolyx.PublishedParameter.string_list.md#compolyx.PublishedParameter.string_list) | A list of possible values. | +| [`PublishedParameter.string_list`](compolyx.PublishedParameter.string_list.md#compolyx.PublishedParameter.string_list) | A list of possible values | | [`PublishedParameter.unit`](compolyx.PublishedParameter.unit.md#compolyx.PublishedParameter.unit) | The unit associated with the actual parameter value | | [`PublishedParameter.upper_limit`](compolyx.PublishedParameter.upper_limit.md#compolyx.PublishedParameter.upper_limit) | The upper limit for numeric values | | [`PublishedParameter.user_script`](compolyx.PublishedParameter.user_script.md#compolyx.PublishedParameter.user_script) | | -| [`PublishedParameter.value`](compolyx.PublishedParameter.value.md#compolyx.PublishedParameter.value) | The current parameter value. | -| [`PublishedParameter.wb_value`](compolyx.PublishedParameter.wb_value.md#compolyx.PublishedParameter.wb_value) | The parameter value as it is represented in the ANSYS workbench | +| [`PublishedParameter.value`](compolyx.PublishedParameter.value.md#compolyx.PublishedParameter.value) | The current parameter value | +| [`PublishedParameter.wb_value`](compolyx.PublishedParameter.wb_value.md#compolyx.PublishedParameter.wb_value) | The parameter value as it is represented in the ANSYS Workbench application | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`PublishedParameter.find_parent`](compolyx.PublishedParameter.find_parent.md#compolyx.PublishedParameter.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`PublishedParameter.get_source_str`](compolyx.PublishedParameter.get_source_str.md#compolyx.PublishedParameter.get_source_str)() | Returns the active source string. | +| [`PublishedParameter.find_parent`](compolyx.PublishedParameter.find_parent.md#compolyx.PublishedParameter.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`PublishedParameter.get_source_str`](compolyx.PublishedParameter.get_source_str.md#compolyx.PublishedParameter.get_source_str)() | Returns the active source string | | [`PublishedParameter.serialize`](compolyx.PublishedParameter.serialize.md#compolyx.PublishedParameter.serialize)() | Serialize to Python string | | [`PublishedParameter.update`](compolyx.PublishedParameter.update.md#compolyx.PublishedParameter.update)() | | | [`PublishedParameter.user_script_default`](compolyx.PublishedParameter.user_script_default.md#compolyx.PublishedParameter.user_script_default)() | | -| [`PublishedParameter.visit`](compolyx.PublishedParameter.visit.md#compolyx.PublishedParameter.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`PublishedParameter.visit`](compolyx.PublishedParameter.visit.md#compolyx.PublishedParameter.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.string_list.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.string_list.md index 68e7d602b4..cd8b7fce19 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.string_list.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.string_list.md @@ -4,4 +4,4 @@ #### *property* PublishedParameter.string_list -A list of possible values. List of objects if the property type is object, else list of strings +A list of possible values. List of objects if the property type is object, else list of strings. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.visit.md index 0cae1011e7..6580f97e91 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.PublishedParameter.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.changed.md index 2dc55c45d4..0551f43f1d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.changed.md @@ -4,4 +4,4 @@ #### *property* Rosette.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.enabled.md index f3a21982bf..0f30c61fa5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.enabled.md @@ -4,4 +4,4 @@ #### *property* Rosette.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.is_dict_item.md index e1da8632d2..834590c6d5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* Rosette.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.is_list_item.md index 88b74859d1..240b4aebf5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.is_list_item.md @@ -4,4 +4,4 @@ #### *property* Rosette.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.md index a3277a4d9c..4f052ecef3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.md @@ -18,48 +18,48 @@ Access: | Name | Description | |------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`Rosette.active`](compolyx.Rosette.active.md#compolyx.Rosette.active) | active status of object | -| [`Rosette.changed`](compolyx.Rosette.changed.md#compolyx.Rosette.changed) | Status boolean. | +| [`Rosette.active`](compolyx.Rosette.active.md#compolyx.Rosette.active) | Active status of object | +| [`Rosette.changed`](compolyx.Rosette.changed.md#compolyx.Rosette.changed) | Status boolean | | [`Rosette.dir1`](compolyx.Rosette.dir1.md#compolyx.Rosette.dir1) | Direction 1 of the Rosette | | [`Rosette.dir2`](compolyx.Rosette.dir2.md#compolyx.Rosette.dir2) | Direction 2 of the Rosette | | [`Rosette.edge_set`](compolyx.Rosette.edge_set.md#compolyx.Rosette.edge_set) | Edge Set for Rosette | -| [`Rosette.enabled`](compolyx.Rosette.enabled.md#compolyx.Rosette.enabled) | Whether this object is currently enabled or not. | +| [`Rosette.enabled`](compolyx.Rosette.enabled.md#compolyx.Rosette.enabled) | Whether this object is currently enabled or not | | [`Rosette.id`](compolyx.Rosette.id.md#compolyx.Rosette.id) | ID of object | | [`Rosette.is_dict_item`](compolyx.Rosette.is_dict_item.md#compolyx.Rosette.is_dict_item) | Specifies wether the object is an item of a dict | | [`Rosette.is_list_item`](compolyx.Rosette.is_list_item.md#compolyx.Rosette.is_list_item) | Specifies wether the object is an item of a list | | [`Rosette.link_path`](compolyx.Rosette.link_path.md#compolyx.Rosette.link_path) | Root path of the current node in the tree for links to this object | -| [`Rosette.locked`](compolyx.Rosette.locked.md#compolyx.Rosette.locked) | Rosette is generated from an imported rosette and cannot be changed. | +| [`Rosette.locked`](compolyx.Rosette.locked.md#compolyx.Rosette.locked) | Rosette is generated from an imported rosette and cannot be changed | | [`Rosette.name`](compolyx.Rosette.name.md#compolyx.Rosette.name) | Name of object | | [`Rosette.origin`](compolyx.Rosette.origin.md#compolyx.Rosette.origin) | Origin of the Rosette | | [`Rosette.parent`](compolyx.Rosette.parent.md#compolyx.Rosette.parent) | Parent object in tree | | [`Rosette.root_path`](compolyx.Rosette.root_path.md#compolyx.Rosette.root_path) | Root path of the current node in the tree | -| [`Rosette.rosette_type`](compolyx.Rosette.rosette_type.md#compolyx.Rosette.rosette_type) | Rosette Types can be: parallel,radial,cylindrical,spherical,edge_wise | +| [`Rosette.rosette_type`](compolyx.Rosette.rosette_type.md#compolyx.Rosette.rosette_type) | Rosette Types. Available options: parallel, radial, cylindrical, spherical, edge_wise | | [`Rosette.status`](compolyx.Rosette.status.md#compolyx.Rosette.status) | Status of the object | -| [`Rosette.status_changed`](compolyx.Rosette.status_changed.md#compolyx.Rosette.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`Rosette.status_changed`](compolyx.Rosette.status_changed.md#compolyx.Rosette.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`Rosette.uid`](compolyx.Rosette.uid.md#compolyx.Rosette.uid) | UID of object | -| [`Rosette.vertex`](compolyx.Rosette.vertex.md#compolyx.Rosette.vertex) | This will throw an error if the object has been removed from the graph. | +| [`Rosette.vertex`](compolyx.Rosette.vertex.md#compolyx.Rosette.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| -| [`Rosette.find_parent`](compolyx.Rosette.find_parent.md#compolyx.Rosette.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`Rosette.get_global_coordinates`](compolyx.Rosette.get_global_coordinates.md#compolyx.Rosette.get_global_coordinates)(coordinates) | Evaluates the global coordinates of a point given in local rosette coordinates: CYLINDRICAL, RADIAL, and SPHERICAL. | +| [`Rosette.find_parent`](compolyx.Rosette.find_parent.md#compolyx.Rosette.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`Rosette.get_global_coordinates`](compolyx.Rosette.get_global_coordinates.md#compolyx.Rosette.get_global_coordinates)(coordinates) | Evaluates the global coordinates of a point given in local rosette coordinates: CYLINDRICAL, RADIAL, and SPHERICAL | | [`Rosette.get_global_vector_components`](compolyx.Rosette.get_global_vector_components.md#compolyx.Rosette.get_global_vector_components)(vector) | Gets global vector components from local rosette vector components CYLINDRICAL, RADIAL and SPHERICAL coord sys type: Give phi and theta in RAD | -| [`Rosette.get_local_coordinates`](compolyx.Rosette.get_local_coordinates.md#compolyx.Rosette.get_local_coordinates)(coordinates) | Evaluates the local rosette coordinates of a point given in global coordinates: | -| [`Rosette.get_local_vector_components`](compolyx.Rosette.get_local_vector_components.md#compolyx.Rosette.get_local_vector_components)(vector) | Returns local rosette vector components from global vector components. | +| [`Rosette.get_local_coordinates`](compolyx.Rosette.get_local_coordinates.md#compolyx.Rosette.get_local_coordinates)(coordinates) | Evaluates the local rosette coordinates of a point given in global coordinates | +| [`Rosette.get_local_vector_components`](compolyx.Rosette.get_local_vector_components.md#compolyx.Rosette.get_local_vector_components)(vector) | Returns local rosette vector components from global vector components | | [`Rosette.get_short_description`](compolyx.Rosette.get_short_description.md#compolyx.Rosette.get_short_description)() | | -| [`Rosette.local_direction`](compolyx.Rosette.local_direction.md#compolyx.Rosette.local_direction)(point, angle) | Get local orientation for a given relative angle and position in space. | -| [`Rosette.obj_exists`](compolyx.Rosette.obj_exists.md#compolyx.Rosette.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. | -| [`Rosette.rotate`](compolyx.Rosette.rotate.md#compolyx.Rosette.rotate)(rot_x_angle_deg, ...) | Rotate the Rosette around its X, Y and Z axes as an intrisic rotation. | -| [`Rosette.serialize`](compolyx.Rosette.serialize.md#compolyx.Rosette.serialize)() | Serialize to Python string. | -| [`Rosette.serialize_name_and_id`](compolyx.Rosette.serialize_name_and_id.md#compolyx.Rosette.serialize_name_and_id)() | Helper function to serialize name and ID. | -| `Rosette.set_Xy`() | Sets dir2 orthogonal to dir1 as y- and x-axis. | -| `Rosette.set_Xz`() | Sets dir2 orthogonal to dir1 as z- and x-axis. | -| `Rosette.set_Yz`() | Sets dir2 orthogonal to dir1 as z- and y-axis. | -| [`Rosette.set_xY`](compolyx.Rosette.set_Xy.md#compolyx.Rosette.set_xY)() | Sets dir1 orthogonal to dir2 as x- and y-axis. | -| [`Rosette.set_xZ`](compolyx.Rosette.set_Xz.md#compolyx.Rosette.set_xZ)() | Sets dir1 orthogonal to dir2 as x- and z-axis. | -| [`Rosette.set_yZ`](compolyx.Rosette.set_Yz.md#compolyx.Rosette.set_yZ)() | Sets dir1 orthogonal to dir2 as y- and z-axis. | -| [`Rosette.translate`](compolyx.Rosette.translate.md#compolyx.Rosette.translate)(translation_x, ...) | Translate the rosette, either along its own axes or the global one depending on the type of translation. | +| [`Rosette.local_direction`](compolyx.Rosette.local_direction.md#compolyx.Rosette.local_direction)(point, angle) | Get local orientation for a given relative angle and position in space | +| [`Rosette.obj_exists`](compolyx.Rosette.obj_exists.md#compolyx.Rosette.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 | +| [`Rosette.rotate`](compolyx.Rosette.rotate.md#compolyx.Rosette.rotate)(rot_x_angle_deg, ...) | Rotate the Rosette around its X, Y and Z axes as an intrisic rotation | +| [`Rosette.serialize`](compolyx.Rosette.serialize.md#compolyx.Rosette.serialize)() | Serialize to Python string | +| [`Rosette.serialize_name_and_id`](compolyx.Rosette.serialize_name_and_id.md#compolyx.Rosette.serialize_name_and_id)() | Helper function to serialize name and ID | +| `Rosette.set_Xy`() | Sets dir2 orthogonal to dir1 as y- and x-axis | +| `Rosette.set_Xz`() | Sets dir2 orthogonal to dir1 as z- and x-axis | +| `Rosette.set_Yz`() | Sets dir2 orthogonal to dir1 as z- and y-axis | +| [`Rosette.set_xY`](compolyx.Rosette.set_Xy.md#compolyx.Rosette.set_xY)() | Sets dir1 orthogonal to dir2 as x- and y-axis | +| [`Rosette.set_xZ`](compolyx.Rosette.set_Xz.md#compolyx.Rosette.set_xZ)() | Sets dir1 orthogonal to dir2 as x- and z-axis | +| [`Rosette.set_yZ`](compolyx.Rosette.set_Yz.md#compolyx.Rosette.set_yZ)() | Sets dir1 orthogonal to dir2 as y- and z-axis | +| [`Rosette.translate`](compolyx.Rosette.translate.md#compolyx.Rosette.translate)(translation_x, ...) | Translate the rosette, either along its own axes or the global one depending on the type of translation | | [`Rosette.update`](compolyx.Rosette.update.md#compolyx.Rosette.update)() | | -| [`Rosette.visit`](compolyx.Rosette.visit.md#compolyx.Rosette.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`Rosette.visit`](compolyx.Rosette.visit.md#compolyx.Rosette.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.obj_exists.md index ce53bf3503..f035b8bca0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.obj_exists.md @@ -4,5 +4,5 @@ #### Rosette.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.rosette_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.rosette_type.md index 4de69c78cb..b7f16f9ac9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.rosette_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Rosette.rosette_type.md @@ -4,4 +4,4 @@ #### *property* Rosette.rosette_type -Rosette Types can be: parallel,radial,cylindrical,spherical,edge_wise +Available Rosette types: `parallel`, `radial`, `cylindrical`, `spherical`, and `edge_wise`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.is_dict_item.md index 053c2e1846..7c8ce03d0c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* SamplingPoint.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.is_list_item.md index 66bcd20016..e5386833d6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.is_list_item.md @@ -4,4 +4,4 @@ #### *property* SamplingPoint.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.md index 47f52e6543..48d79a5c5c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.md @@ -26,17 +26,17 @@ Key features: | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| -| [`SamplingPoint.active`](compolyx.SamplingPoint.active.md#compolyx.SamplingPoint.active) | active status of object | -| [`SamplingPoint.consider_coupling_effect`](compolyx.SamplingPoint.consider_coupling_effect.md#compolyx.SamplingPoint.consider_coupling_effect) | Whether to consider coupling effects (B-Matrix) for the calculation of the laminate engineering constants. | +| [`SamplingPoint.active`](compolyx.SamplingPoint.active.md#compolyx.SamplingPoint.active) | Active status of object | +| [`SamplingPoint.consider_coupling_effect`](compolyx.SamplingPoint.consider_coupling_effect.md#compolyx.SamplingPoint.consider_coupling_effect) | Whether to consider coupling effects (B-Matrix) for the calculation of the laminate engineering constants | | [`SamplingPoint.direction`](compolyx.SamplingPoint.direction.md#compolyx.SamplingPoint.direction) | Sampling Point Direction | | [`SamplingPoint.element_id`](compolyx.SamplingPoint.element_id.md#compolyx.SamplingPoint.element_id) | Element ID (label) of the Sampling Point | -| [`SamplingPoint.enabled`](compolyx.SamplingPoint.enabled.md#compolyx.SamplingPoint.enabled) | Whether this object is currently enabled. | -| [`SamplingPoint.graph_plot`](compolyx.SamplingPoint.graph_plot.md#compolyx.SamplingPoint.graph_plot) | Graph Plot object used to configure 2D plots. | +| [`SamplingPoint.enabled`](compolyx.SamplingPoint.enabled.md#compolyx.SamplingPoint.enabled) | Whether this object is currently enabled | +| [`SamplingPoint.graph_plot`](compolyx.SamplingPoint.graph_plot.md#compolyx.SamplingPoint.graph_plot) | Graph Plot object used to configure 2D plots | | [`SamplingPoint.id`](compolyx.SamplingPoint.id.md#compolyx.SamplingPoint.id) | ID of object | -| [`SamplingPoint.is_dict_item`](compolyx.SamplingPoint.is_dict_item.md#compolyx.SamplingPoint.is_dict_item) | Specifies wether the object is an item of a dict | -| [`SamplingPoint.is_list_item`](compolyx.SamplingPoint.is_list_item.md#compolyx.SamplingPoint.is_list_item) | Specifies wether the object is an item of a list | +| [`SamplingPoint.is_dict_item`](compolyx.SamplingPoint.is_dict_item.md#compolyx.SamplingPoint.is_dict_item) | Specifies whether the object is an item of a dict | +| [`SamplingPoint.is_list_item`](compolyx.SamplingPoint.is_list_item.md#compolyx.SamplingPoint.is_list_item) | Specifies whether the object is an item of a list | | [`SamplingPoint.link_path`](compolyx.SamplingPoint.link_path.md#compolyx.SamplingPoint.link_path) | Root path of the current node in the tree for links to this object | -| [`SamplingPoint.locked`](compolyx.SamplingPoint.locked.md#compolyx.SamplingPoint.locked) | Sampling Point is generated from an imported source and cannot be changed. | +| [`SamplingPoint.locked`](compolyx.SamplingPoint.locked.md#compolyx.SamplingPoint.locked) | Sampling Point is generated from an imported source and cannot be changed | | [`SamplingPoint.name`](compolyx.SamplingPoint.name.md#compolyx.SamplingPoint.name) | Name of object | | [`SamplingPoint.offset_is_middle`](compolyx.SamplingPoint.offset_is_middle.md#compolyx.SamplingPoint.offset_is_middle) | Whether to offset the reference surface to the mid-plane of the laminate. | | [`SamplingPoint.parent`](compolyx.SamplingPoint.parent.md#compolyx.SamplingPoint.parent) | Parent object in tree | @@ -50,21 +50,21 @@ Key features: | [`SamplingPoint.status_changed`](compolyx.SamplingPoint.status_changed.md#compolyx.SamplingPoint.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | | [`SamplingPoint.uid`](compolyx.SamplingPoint.uid.md#compolyx.SamplingPoint.uid) | UID of object | | [`SamplingPoint.use_default_reference_direction`](compolyx.SamplingPoint.use_default_reference_direction.md#compolyx.SamplingPoint.use_default_reference_direction) | Flag to use default reference direction | -| [`SamplingPoint.vertex`](compolyx.SamplingPoint.vertex.md#compolyx.SamplingPoint.vertex) | This will throw an error if the object has been removed from the graph. | +| [`SamplingPoint.vertex`](compolyx.SamplingPoint.vertex.md#compolyx.SamplingPoint.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`SamplingPoint.aligned`](compolyx.SamplingPoint.aligned.md#compolyx.SamplingPoint.aligned)() | Returns true if the sampling direction is aligned with the normal direction of the closest element. | -| [`SamplingPoint.capture_analysis_plot`](compolyx.SamplingPoint.capture_analysis_plot.md#compolyx.SamplingPoint.capture_analysis_plot)([path, size]) | Saves the sampling point analysis plot to a file. | -| [`SamplingPoint.clt_query`](compolyx.SamplingPoint.clt_query.md#compolyx.SamplingPoint.clt_query)([query, ...]) | Returns the properties of the classical laminate theory: | -| [`SamplingPoint.create_plot`](compolyx.SamplingPoint.create_plot.md#compolyx.SamplingPoint.create_plot)([query, ...]) | Generates 2D plots with the results of interest. | +| [`SamplingPoint.aligned`](compolyx.SamplingPoint.aligned.md#compolyx.SamplingPoint.aligned)() | Returns true if the sampling direction is aligned with the normal direction of the closest element | +| [`SamplingPoint.capture_analysis_plot`](compolyx.SamplingPoint.capture_analysis_plot.md#compolyx.SamplingPoint.capture_analysis_plot)([path, size]) | Saves the sampling point analysis plot to a file | +| [`SamplingPoint.clt_query`](compolyx.SamplingPoint.clt_query.md#compolyx.SamplingPoint.clt_query)([query, ...]) | Returns the properties of the classical laminate theory | +| [`SamplingPoint.create_plot`](compolyx.SamplingPoint.create_plot.md#compolyx.SamplingPoint.create_plot)([query, ...]) | Generates 2D plots with the results of interest | | [`SamplingPoint.export_laminate`](compolyx.SamplingPoint.export_laminate.md#compolyx.SamplingPoint.export_laminate)(filename[, ...]) | | -| [`SamplingPoint.find_parent`](compolyx.SamplingPoint.find_parent.md#compolyx.SamplingPoint.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`SamplingPoint.obj_exists`](compolyx.SamplingPoint.obj_exists.md#compolyx.SamplingPoint.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. | +| [`SamplingPoint.find_parent`](compolyx.SamplingPoint.find_parent.md#compolyx.SamplingPoint.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`SamplingPoint.obj_exists`](compolyx.SamplingPoint.obj_exists.md#compolyx.SamplingPoint.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 | | [`SamplingPoint.serialize`](compolyx.SamplingPoint.serialize.md#compolyx.SamplingPoint.serialize)() | | -| [`SamplingPoint.serialize_name_and_id`](compolyx.SamplingPoint.serialize_name_and_id.md#compolyx.SamplingPoint.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`SamplingPoint.serialize_name_and_id`](compolyx.SamplingPoint.serialize_name_and_id.md#compolyx.SamplingPoint.serialize_name_and_id)() | Helper function to serialize name and ID | | [`SamplingPoint.update`](compolyx.SamplingPoint.update.md#compolyx.SamplingPoint.update)() | | -| [`SamplingPoint.update_plot`](compolyx.SamplingPoint.update_plot.md#compolyx.SamplingPoint.update_plot)(offset_is_middle, ...) | Updates the 2D plot. | -| [`SamplingPoint.visit`](compolyx.SamplingPoint.visit.md#compolyx.SamplingPoint.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`SamplingPoint.update_plot`](compolyx.SamplingPoint.update_plot.md#compolyx.SamplingPoint.update_plot)(offset_is_middle, ...) | Updates the 2D plot | +| [`SamplingPoint.visit`](compolyx.SamplingPoint.visit.md#compolyx.SamplingPoint.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.obj_exists.md index f0cc7e95fd..4cad2e841c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SamplingPoint.obj_exists.md @@ -4,5 +4,5 @@ #### SamplingPoint.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.changed.md index c2b5f2fd5e..80b4f56103 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.changed.md @@ -4,4 +4,4 @@ #### *property* Scene.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.is_dict_item.md index d21611c88d..2820a6c30d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* Scene.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.is_list_item.md index d4445756bb..c8969d1b3d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.is_list_item.md @@ -4,4 +4,4 @@ #### *property* Scene.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.md index c2cbd625e3..3ef7110110 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.md @@ -14,33 +14,33 @@ Class to represent scene. | [`Scene.background`](compolyx.Scene.background.md#compolyx.Scene.background) | Background color | | [`Scene.background2`](compolyx.Scene.background2.md#compolyx.Scene.background2) | Background color 2 | | [`Scene.camera`](compolyx.Scene.camera.md#compolyx.Scene.camera) | Camera settings | -| [`Scene.changed`](compolyx.Scene.changed.md#compolyx.Scene.changed) | Status boolean. | +| [`Scene.changed`](compolyx.Scene.changed.md#compolyx.Scene.changed) | Status boolean | | [`Scene.continuous_pick_enabled`](compolyx.Scene.continuous_pick_enabled.md#compolyx.Scene.continuous_pick_enabled) | | | [`Scene.deformed`](compolyx.Scene.deformed.md#compolyx.Scene.deformed) | | -| [`Scene.descriptions_changed`](compolyx.Scene.descriptions_changed.md#compolyx.Scene.descriptions_changed) | Set to True if descriptions should be updated. | +| [`Scene.descriptions_changed`](compolyx.Scene.descriptions_changed.md#compolyx.Scene.descriptions_changed) | Set to True if descriptions should be updated | | [`Scene.display_data`](compolyx.Scene.display_data.md#compolyx.Scene.display_data) | | | [`Scene.event_snapshot`](compolyx.Scene.event_snapshot.md#compolyx.Scene.event_snapshot) | | | [`Scene.fit_to_window`](compolyx.Scene.fit_to_window.md#compolyx.Scene.fit_to_window) | Reset the zoom of the window | | [`Scene.foreground`](compolyx.Scene.foreground.md#compolyx.Scene.foreground) | Foreground color | | [`Scene.id`](compolyx.Scene.id.md#compolyx.Scene.id) | | -| [`Scene.is_dict_item`](compolyx.Scene.is_dict_item.md#compolyx.Scene.is_dict_item) | Specifies wether the object is an item of a dict | -| [`Scene.is_list_item`](compolyx.Scene.is_list_item.md#compolyx.Scene.is_list_item) | Specifies wether the object is an item of a list | +| [`Scene.is_dict_item`](compolyx.Scene.is_dict_item.md#compolyx.Scene.is_dict_item) | Specifies whether the object is an item of a dict | +| [`Scene.is_list_item`](compolyx.Scene.is_list_item.md#compolyx.Scene.is_list_item) | Specifies whether the object is an item of a list | | [`Scene.lighting_mode`](compolyx.Scene.lighting_mode.md#compolyx.Scene.lighting_mode) | | | [`Scene.link_path`](compolyx.Scene.link_path.md#compolyx.Scene.link_path) | Root path of the current node in the tree for links to this object | | [`Scene.logo_type`](compolyx.Scene.logo_type.md#compolyx.Scene.logo_type) | Logo type: default or black | -| [`Scene.mode`](compolyx.Scene.mode.md#compolyx.Scene.mode) | Current ACP mode (pre or post). | +| [`Scene.mode`](compolyx.Scene.mode.md#compolyx.Scene.mode) | Current ACP mode (pre) | | [`Scene.model`](compolyx.Scene.model.md#compolyx.Scene.model) | | | [`Scene.name`](compolyx.Scene.name.md#compolyx.Scene.name) | Name of object | | [`Scene.parent`](compolyx.Scene.parent.md#compolyx.Scene.parent) | Parent object in tree | | [`Scene.projection`](compolyx.Scene.projection.md#compolyx.Scene.projection) | Projection method: 'parallel' or 'perspective' | | [`Scene.root_path`](compolyx.Scene.root_path.md#compolyx.Scene.root_path) | Root path of the current node in the tree | -| [`Scene.scale_factor`](compolyx.Scene.scale_factor.md#compolyx.Scene.scale_factor) | Scale factor of the deformed mesh. | +| [`Scene.scale_factor`](compolyx.Scene.scale_factor.md#compolyx.Scene.scale_factor) | Scale factor of the deformed mesh | | [`Scene.show_contour_and_direction_in_front`](compolyx.Scene.show_contour_and_direction_in_front.md#compolyx.Scene.show_contour_and_direction_in_front) | | | [`Scene.show_draped_fiber_directions`](compolyx.Scene.show_draped_fiber_directions.md#compolyx.Scene.show_draped_fiber_directions) | | | [`Scene.show_draped_transverse_directions`](compolyx.Scene.show_draped_transverse_directions.md#compolyx.Scene.show_draped_transverse_directions) | | | [`Scene.show_edges`](compolyx.Scene.show_edges.md#compolyx.Scene.show_edges) | | | [`Scene.show_element_selection_through_mesh`](compolyx.Scene.show_element_selection_through_mesh.md#compolyx.Scene.show_element_selection_through_mesh) | | -| [`Scene.show_element_type`](compolyx.Scene.show_element_type.md#compolyx.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_element_type`](compolyx.Scene.show_element_type.md#compolyx.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 that only analysis plies have solid elements. | | [`Scene.show_fiber_directions`](compolyx.Scene.show_fiber_directions.md#compolyx.Scene.show_fiber_directions) | | | [`Scene.show_global_coordinate_system`](compolyx.Scene.show_global_coordinate_system.md#compolyx.Scene.show_global_coordinate_system) | Toggle visibility of global coordinate system marker | | [`Scene.show_labeled_bounding_box`](compolyx.Scene.show_labeled_bounding_box.md#compolyx.Scene.show_labeled_bounding_box) | Toggle visibility of labeled bounding box | @@ -61,8 +61,8 @@ Class to represent scene. | [`Scene.static_plots`](compolyx.Scene.static_plots.md#compolyx.Scene.static_plots) | | | [`Scene.status`](compolyx.Scene.status.md#compolyx.Scene.status) | Status of the object | | [`Scene.title`](compolyx.Scene.title.md#compolyx.Scene.title) | Scene title | -| [`Scene.uptodate`](compolyx.Scene.uptodate.md#compolyx.Scene.uptodate) | Apply a view to the scene. | -| [`Scene.view`](compolyx.Scene.view.md#compolyx.Scene.view) | Apply a view to the scene. | +| [`Scene.uptodate`](compolyx.Scene.uptodate.md#compolyx.Scene.uptodate) | Apply a view to the scene | +| [`Scene.view`](compolyx.Scene.view.md#compolyx.Scene.view) | Apply a view to the scene | ### Methods @@ -70,10 +70,10 @@ Class to represent scene. |-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`Scene.connect`](compolyx.Scene.connect.md#compolyx.Scene.connect)() | | | [`Scene.disconnect`](compolyx.Scene.disconnect.md#compolyx.Scene.disconnect)() | | -| [`Scene.find_parent`](compolyx.Scene.find_parent.md#compolyx.Scene.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`Scene.find_parent`](compolyx.Scene.find_parent.md#compolyx.Scene.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`Scene.get_display_data_for`](compolyx.Scene.get_display_data_for.md#compolyx.Scene.get_display_data_for)(obj) | | -| [`Scene.save_snapshot`](compolyx.Scene.save_snapshot.md#compolyx.Scene.save_snapshot)(path[, width, height, ...]) | Create a snapshot of the scene. | -| [`Scene.serialize`](compolyx.Scene.serialize.md#compolyx.Scene.serialize)() | Serialize to Python string. | +| [`Scene.save_snapshot`](compolyx.Scene.save_snapshot.md#compolyx.Scene.save_snapshot)(path[, width, height, ...]) | Create a snapshot of the scene | +| [`Scene.serialize`](compolyx.Scene.serialize.md#compolyx.Scene.serialize)() | Serialize to Python string | | [`Scene.update`](compolyx.Scene.update.md#compolyx.Scene.update)() | | -| [`Scene.update_direction_display_data`](compolyx.Scene.update_direction_display_data.md#compolyx.Scene.update_direction_display_data)(entities) | Function syncronizes the following direction plots with the added/removed entities given: - "orientations" - "ref_directions" - "fiber_directions" - "draped_fiber_directions" | -| [`Scene.visit`](compolyx.Scene.visit.md#compolyx.Scene.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`Scene.update_direction_display_data`](compolyx.Scene.update_direction_display_data.md#compolyx.Scene.update_direction_display_data)(entities) | Function syncronizes the following direction plots with the added/removed entities given: "orientations," "ref_directions," "fiber_directions," "draped_fiber_directions" | +| [`Scene.visit`](compolyx.Scene.visit.md#compolyx.Scene.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.mode.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.mode.md index cc869a5882..1a000a1de5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.mode.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.mode.md @@ -4,4 +4,4 @@ #### *property* Scene.mode -Current ACP mode (pre or post). +Current ACP mode (pre). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.projection.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.projection.md index 27310cbabf..6935a25592 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.projection.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.projection.md @@ -4,4 +4,4 @@ #### *property* Scene.projection -Projection method: ‘parallel’ or ‘perspective’ +Projection method: `parallel` or `perspective` diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.save_snapshot.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.save_snapshot.md index 7b3bf19e22..cf9e17cc01 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.save_snapshot.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.save_snapshot.md @@ -10,4 +10,4 @@ Create a snapshot of the scene. - path: File path. - width: Width in pixels of the snapshot. - height: Height in pixels of the snapshot. - - draw_background: Boolean for whether to draw the background. If ‘False’, the background is white. + - draw_background: Boolean for whether to draw the background. If `False`, the background is white. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.uptodate.md index abf93f819f..6afcba7d7f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Scene.uptodate.md @@ -4,4 +4,4 @@ #### *property* Scene.uptodate -Apply a view to the scene. Write only +Apply a view to the scene. Write only. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.enabled.md index d14252ad33..42c7ad1f0d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.enabled.md @@ -4,4 +4,4 @@ #### *property* Script.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.is_dict_item.md index 91eb351e86..c1b20aaaa8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* Script.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.is_list_item.md index 4e64ca5d95..495832eaf8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.is_list_item.md @@ -4,4 +4,4 @@ #### *property* Script.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.md index 8c4b3e1ed6..3ef5d0fdc7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.md @@ -10,27 +10,27 @@ Class to represent user-defined scripts operating on the input parameters. | Name | Description | |---------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------| -| [`Script.active`](compolyx.Script.active.md#compolyx.Script.active) | Whether the script should run or not. | -| [`Script.enabled`](compolyx.Script.enabled.md#compolyx.Script.enabled) | Whether this object is currently enabled or not. | -| [`Script.is_dict_item`](compolyx.Script.is_dict_item.md#compolyx.Script.is_dict_item) | Specifies wether the object is an item of a dict | -| [`Script.is_list_item`](compolyx.Script.is_list_item.md#compolyx.Script.is_list_item) | Specifies wether the object is an item of a list | +| [`Script.active`](compolyx.Script.active.md#compolyx.Script.active) | Whether the script should run or not | +| [`Script.enabled`](compolyx.Script.enabled.md#compolyx.Script.enabled) | Whether this object is currently enabled or not | +| [`Script.is_dict_item`](compolyx.Script.is_dict_item.md#compolyx.Script.is_dict_item) | Specifies whether the object is an item of a dict | +| [`Script.is_list_item`](compolyx.Script.is_list_item.md#compolyx.Script.is_list_item) | Specifies whether the object is an item of a list | | [`Script.link_path`](compolyx.Script.link_path.md#compolyx.Script.link_path) | Root path of the current node in the tree for links to this object | | [`Script.name`](compolyx.Script.name.md#compolyx.Script.name) | Name of object | | [`Script.parent`](compolyx.Script.parent.md#compolyx.Script.parent) | Parent object in tree | | [`Script.root_path`](compolyx.Script.root_path.md#compolyx.Script.root_path) | Root path of the current node in the tree | -| [`Script.source`](compolyx.Script.source.md#compolyx.Script.source) | Source code of the user-defined script. | -| [`Script.status`](compolyx.Script.status.md#compolyx.Script.status) | String status indicating if the object is up-to-date. | -| [`Script.status_changed`](compolyx.Script.status_changed.md#compolyx.Script.status_changed) | Specifies if the object has changed, for the purposes of notifying workbench. | -| [`Script.update_mode`](compolyx.Script.update_mode.md#compolyx.Script.update_mode) | Defines which changes cause the script to become out-of-date. | -| [`Script.uptodate`](compolyx.Script.uptodate.md#compolyx.Script.uptodate) | Whether the script execution is up to date. | +| [`Script.source`](compolyx.Script.source.md#compolyx.Script.source) | Source code of the user-defined script | +| [`Script.status`](compolyx.Script.status.md#compolyx.Script.status) | String status indicating if the object is up-to-date | +| [`Script.status_changed`](compolyx.Script.status_changed.md#compolyx.Script.status_changed) | Specifies if the object has changed, for the purposes of notifying the Workbench application. | +| [`Script.update_mode`](compolyx.Script.update_mode.md#compolyx.Script.update_mode) | Defines which changes cause the script to become out-of-date | +| [`Script.uptodate`](compolyx.Script.uptodate.md#compolyx.Script.uptodate) | Whether the script execution is up to date | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`Script.find_parent`](compolyx.Script.find_parent.md#compolyx.Script.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`Script.find_parent`](compolyx.Script.find_parent.md#compolyx.Script.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`Script.run`](compolyx.Script.run.md#compolyx.Script.run)() | | | [`Script.serialize`](compolyx.Script.serialize.md#compolyx.Script.serialize)() | Serialize to Python string | | [`Script.source_default`](compolyx.Script.source_default.md#compolyx.Script.source_default)() | | | [`Script.update`](compolyx.Script.update.md#compolyx.Script.update)() | | -| [`Script.visit`](compolyx.Script.visit.md#compolyx.Script.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`Script.visit`](compolyx.Script.visit.md#compolyx.Script.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.update_mode.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.update_mode.md index 0718e7fee5..22985435c1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.update_mode.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.update_mode.md @@ -4,4 +4,4 @@ #### *property* Script.update_mode -Defines which changes cause the script to become out-of-date. Can be either ‘manual’ (run only when manually triggered), ‘on_triggers’ (run when a parameter or the script itself changes), or ‘always’ (run with every update). +Defines which changes cause the script to become out-of-date. Available options: `manual` (run only when manually triggered), `on_triggers` (run when a parameter or the script itself changes), or `always` (run with every update). diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.uptodate.md index 20ba43ec04..e0d66d90fa 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.uptodate.md @@ -4,4 +4,4 @@ #### *property* Script.uptodate -Whether the script execution is up to date. +Whether the script execution is up-to-date. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.visit.md index aa6276297c..af0557113f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Script.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.changed.md index 55e0c44231..0d0f5efe28 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.changed.md @@ -4,4 +4,4 @@ #### *property* SectionCut.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.extrusion_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.extrusion_type.md index dc39a55aec..eb49068ea6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.extrusion_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.extrusion_type.md @@ -4,4 +4,4 @@ #### *property* SectionCut.extrusion_type -Section Cut Types can be: wire_frame,surface_normal,surface_sweep_based +Available Section Cut types: `wire_frame`, `surface_normal`, and `surface_sweep_based`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.md index 685a759a9e..18c46a46c7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.md @@ -10,50 +10,50 @@ Section cut class showing the layup in the cutting plane. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| -| [`SectionCut.active`](compolyx.SectionCut.active.md#compolyx.SectionCut.active) | Whether a section cut is computed on update or not. | -| [`SectionCut.changed`](compolyx.SectionCut.changed.md#compolyx.SectionCut.changed) | Status boolean. | +| [`SectionCut.active`](compolyx.SectionCut.active.md#compolyx.SectionCut.active) | Whether a section cut is computed on update or not | +| [`SectionCut.changed`](compolyx.SectionCut.changed.md#compolyx.SectionCut.changed) | Status boolean | | [`SectionCut.color_table`](compolyx.SectionCut.color_table.md#compolyx.SectionCut.color_table) | | | [`SectionCut.core_scale_factor`](compolyx.SectionCut.core_scale_factor.md#compolyx.SectionCut.core_scale_factor) | Get/set the core scale factor | | [`SectionCut.display_data`](compolyx.SectionCut.display_data.md#compolyx.SectionCut.display_data) | Section cut plots | | [`SectionCut.elastic_measures`](compolyx.SectionCut.elastic_measures.md#compolyx.SectionCut.elastic_measures) | Cross-sectional Measures of Elasticity | -| [`SectionCut.element_labels`](compolyx.SectionCut.element_labels.md#compolyx.SectionCut.element_labels) | Label of elements within ex1 array. | +| [`SectionCut.element_labels`](compolyx.SectionCut.element_labels.md#compolyx.SectionCut.element_labels) | Label of elements within ex1 array | | [`SectionCut.element_nodes`](compolyx.SectionCut.element_nodes.md#compolyx.SectionCut.element_nodes) | Coincidence list | -| [`SectionCut.element_types`](compolyx.SectionCut.element_types.md#compolyx.SectionCut.element_types) | Element types within ex1 array. | -| [`SectionCut.enabled`](compolyx.SectionCut.enabled.md#compolyx.SectionCut.enabled) | Whether this object is currently enabled or not. | -| [`SectionCut.extrusion_type`](compolyx.SectionCut.extrusion_type.md#compolyx.SectionCut.extrusion_type) | Section Cut Types can be: wire_frame,surface_normal,surface_sweep_based | +| [`SectionCut.element_types`](compolyx.SectionCut.element_types.md#compolyx.SectionCut.element_types) | Element types within ex1 array | +| [`SectionCut.enabled`](compolyx.SectionCut.enabled.md#compolyx.SectionCut.enabled) | Whether this object is currently enabled or not | +| [`SectionCut.extrusion_type`](compolyx.SectionCut.extrusion_type.md#compolyx.SectionCut.extrusion_type) | Section Cut. Available types: wire_frame, surface_normal, surface_sweep_based | | [`SectionCut.geometric_measures`](compolyx.SectionCut.geometric_measures.md#compolyx.SectionCut.geometric_measures) | Cross-sectional Measures of Geometry | | [`SectionCut.id`](compolyx.SectionCut.id.md#compolyx.SectionCut.id) | ID of object | | [`SectionCut.in_plane_reference_direction1`](compolyx.SectionCut.in_plane_reference_direction1.md#compolyx.SectionCut.in_plane_reference_direction1) | Reference direction for cross-sectional measures | | [`SectionCut.in_plane_reference_direction2`](compolyx.SectionCut.in_plane_reference_direction2.md#compolyx.SectionCut.in_plane_reference_direction2) | Reference direction for cross-sectional measures | | [`SectionCut.intersection_type`](compolyx.SectionCut.intersection_type.md#compolyx.SectionCut.intersection_type) | Intersection Types can be: normal_to_surface,in_plane | -| [`SectionCut.is_dict_item`](compolyx.SectionCut.is_dict_item.md#compolyx.SectionCut.is_dict_item) | Specifies wether the object is an item of a dict | -| [`SectionCut.is_list_item`](compolyx.SectionCut.is_list_item.md#compolyx.SectionCut.is_list_item) | Specifies wether the object is an item of a list | +| [`SectionCut.is_dict_item`](compolyx.SectionCut.is_dict_item.md#compolyx.SectionCut.is_dict_item) | Specifies whether the object is an item of a dict | +| [`SectionCut.is_list_item`](compolyx.SectionCut.is_list_item.md#compolyx.SectionCut.is_list_item) | Specifies whether the object is an item of a list | | [`SectionCut.link_path`](compolyx.SectionCut.link_path.md#compolyx.SectionCut.link_path) | Root path of the current node in the tree for links to this object | -| [`SectionCut.locked`](compolyx.SectionCut.locked.md#compolyx.SectionCut.locked) | Section cut was imported and cannot be changed. | +| [`SectionCut.locked`](compolyx.SectionCut.locked.md#compolyx.SectionCut.locked) | Section cut was imported and cannot be changed | | [`SectionCut.mass_measures`](compolyx.SectionCut.mass_measures.md#compolyx.SectionCut.mass_measures) | Cross-sectional Measures of Mass | | [`SectionCut.name`](compolyx.SectionCut.name.md#compolyx.SectionCut.name) | Name of object | -| [`SectionCut.node_labels`](compolyx.SectionCut.node_labels.md#compolyx.SectionCut.node_labels) | Label of nodes within nx1 array. | -| [`SectionCut.nodes`](compolyx.SectionCut.nodes.md#compolyx.SectionCut.nodes) | Returns nodes of this mesh as nx3 array. | +| [`SectionCut.node_labels`](compolyx.SectionCut.node_labels.md#compolyx.SectionCut.node_labels) | Label of nodes within nx1 array | +| [`SectionCut.nodes`](compolyx.SectionCut.nodes.md#compolyx.SectionCut.nodes) | Returns nodes of this mesh as nx3 array | | [`SectionCut.normal`](compolyx.SectionCut.normal.md#compolyx.SectionCut.normal) | Get/set the plane normal | | [`SectionCut.number_of_interpolation_points`](compolyx.SectionCut.number_of_interpolation_points.md#compolyx.SectionCut.number_of_interpolation_points) | User-defined number of interpolation points. | | [`SectionCut.origin`](compolyx.SectionCut.origin.md#compolyx.SectionCut.origin) | Get/set the plane origin | | [`SectionCut.parent`](compolyx.SectionCut.parent.md#compolyx.SectionCut.parent) | Parent object in tree | | [`SectionCut.root_path`](compolyx.SectionCut.root_path.md#compolyx.SectionCut.root_path) | Root path of the current node in the tree | | [`SectionCut.scale_factor`](compolyx.SectionCut.scale_factor.md#compolyx.SectionCut.scale_factor) | Scale factor used for visualization of section cuts | -| [`SectionCut.scope_element_sets`](compolyx.SectionCut.scope_element_sets.md#compolyx.SectionCut.scope_element_sets) | Element Sets to which the Section Cut is scoped. | -| [`SectionCut.scope_entire_model`](compolyx.SectionCut.scope_entire_model.md#compolyx.SectionCut.scope_entire_model) | Whether the section cut is scoped to the entire model, or only selected element sets. | -| [`SectionCut.search_radius`](compolyx.SectionCut.search_radius.md#compolyx.SectionCut.search_radius) | User-defined search radius. | -| [`SectionCut.section_cut_type`](compolyx.SectionCut.section_cut_type.md#compolyx.SectionCut.section_cut_type) | Section Cut Types can be: modeling_ply_wise,production_ply_wise,analysis_ply_wise | +| [`SectionCut.scope_element_sets`](compolyx.SectionCut.scope_element_sets.md#compolyx.SectionCut.scope_element_sets) | Element Sets to which the Section Cut is scoped | +| [`SectionCut.scope_entire_model`](compolyx.SectionCut.scope_entire_model.md#compolyx.SectionCut.scope_entire_model) | Whether the section cut is scoped to the entire model, or only selected element sets | +| [`SectionCut.search_radius`](compolyx.SectionCut.search_radius.md#compolyx.SectionCut.search_radius) | User-defined search radius | +| [`SectionCut.section_cut_type`](compolyx.SectionCut.section_cut_type.md#compolyx.SectionCut.section_cut_type) | Section Cut. Available options: modeling_ply_wise, production_ply_wise, analysis_ply_wise | | [`SectionCut.status`](compolyx.SectionCut.status.md#compolyx.SectionCut.status) | Status of the object | -| [`SectionCut.status_changed`](compolyx.SectionCut.status_changed.md#compolyx.SectionCut.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`SectionCut.status_changed`](compolyx.SectionCut.status_changed.md#compolyx.SectionCut.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`SectionCut.surface_display_data`](compolyx.SectionCut.surface_display_data.md#compolyx.SectionCut.surface_display_data) | Section cut surface plot | | [`SectionCut.surface_mesh`](compolyx.SectionCut.surface_mesh.md#compolyx.SectionCut.surface_mesh) | Section cut line surface mesh | -| [`SectionCut.tolerance`](compolyx.SectionCut.tolerance.md#compolyx.SectionCut.tolerance) | Tolerance used to generate the surface section cut. | +| [`SectionCut.tolerance`](compolyx.SectionCut.tolerance.md#compolyx.SectionCut.tolerance) | Tolerance used to generate the surface section cut | | [`SectionCut.uid`](compolyx.SectionCut.uid.md#compolyx.SectionCut.uid) | UID of object | -| [`SectionCut.use_default_lut_settings`](compolyx.SectionCut.use_default_lut_settings.md#compolyx.SectionCut.use_default_lut_settings) | Boolean whether to use the dault settings of the LookUp Table. | -| [`SectionCut.use_default_tolerance`](compolyx.SectionCut.use_default_tolerance.md#compolyx.SectionCut.use_default_tolerance) | Whether to use the default feature tolerance. | -| [`SectionCut.vertex`](compolyx.SectionCut.vertex.md#compolyx.SectionCut.vertex) | This will throw an error if the object has been removed from the graph. | -| [`SectionCut.vtk_element_data`](compolyx.SectionCut.vtk_element_data.md#compolyx.SectionCut.vtk_element_data) | Returns mesh coincidence data in the format needed by VTK. | +| [`SectionCut.use_default_lut_settings`](compolyx.SectionCut.use_default_lut_settings.md#compolyx.SectionCut.use_default_lut_settings) | Boolean whether to use the dault settings of the LookUp Table | +| [`SectionCut.use_default_tolerance`](compolyx.SectionCut.use_default_tolerance.md#compolyx.SectionCut.use_default_tolerance) | Whether to use the default feature tolerance | +| [`SectionCut.vertex`](compolyx.SectionCut.vertex.md#compolyx.SectionCut.vertex) | This will throw an error if the object has been removed from the graph | +| [`SectionCut.vtk_element_data`](compolyx.SectionCut.vtk_element_data.md#compolyx.SectionCut.vtk_element_data) | Returns mesh coincidence data in the format needed by VTK | | [`SectionCut.wireframe_display_data`](compolyx.SectionCut.wireframe_display_data.md#compolyx.SectionCut.wireframe_display_data) | Section cut wireframe plot | | [`SectionCut.wireframe_mesh`](compolyx.SectionCut.wireframe_mesh.md#compolyx.SectionCut.wireframe_mesh) | Section cut line wireframe mesh | @@ -61,17 +61,17 @@ Section cut class showing the layup in the cutting plane. | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`SectionCut.compute_equivalent_beam_properties`](compolyx.SectionCut.compute_equivalent_beam_properties.md#compolyx.SectionCut.compute_equivalent_beam_properties)([...]) | Compute the equivalent beam properties of the section cut. | -| [`SectionCut.export_surface_section_cut`](compolyx.SectionCut.export_surface_section_cut.md#compolyx.SectionCut.export_surface_section_cut)(path) | Exports the suface section cut to BECAS or ANSYS Mechanical APDL. | -| [`SectionCut.find_parent`](compolyx.SectionCut.find_parent.md#compolyx.SectionCut.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`SectionCut.from_global_to_local`](compolyx.SectionCut.from_global_to_local.md#compolyx.SectionCut.from_global_to_local)(global_coords) | Transforms global coordinates into the local coordinate system of the section cut. | -| [`SectionCut.from_local_to_global`](compolyx.SectionCut.from_local_to_global.md#compolyx.SectionCut.from_local_to_global)(local_coords) | Transforms local coordinates into the global coordinate system. | -| [`SectionCut.get_sectional_stiffness_behavior`](compolyx.SectionCut.get_sectional_stiffness_behavior.md#compolyx.SectionCut.get_sectional_stiffness_behavior)(...) | Returns the sectional stiffness values for a given matrix. | -| [`SectionCut.get_sectype_command_from_sectional_properties`](compolyx.SectionCut.get_sectype_command_from_sectional_properties.md#compolyx.SectionCut.get_sectype_command_from_sectional_properties)(...) | Convert the equivalent stiffness and mass matrix into an Ansys sectype command. | +| [`SectionCut.compute_equivalent_beam_properties`](compolyx.SectionCut.compute_equivalent_beam_properties.md#compolyx.SectionCut.compute_equivalent_beam_properties)([...]) | Compute the equivalent beam properties of the section cut | +| [`SectionCut.export_surface_section_cut`](compolyx.SectionCut.export_surface_section_cut.md#compolyx.SectionCut.export_surface_section_cut)(path) | Exports the suface section cut to BECAS or ANSYS Mechanical APDL | +| [`SectionCut.find_parent`](compolyx.SectionCut.find_parent.md#compolyx.SectionCut.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`SectionCut.from_global_to_local`](compolyx.SectionCut.from_global_to_local.md#compolyx.SectionCut.from_global_to_local)(global_coords) | Transforms global coordinates into the local coordinate system of the section cut | +| [`SectionCut.from_local_to_global`](compolyx.SectionCut.from_local_to_global.md#compolyx.SectionCut.from_local_to_global)(local_coords) | Transforms local coordinates into the global coordinate system | +| [`SectionCut.get_sectional_stiffness_behavior`](compolyx.SectionCut.get_sectional_stiffness_behavior.md#compolyx.SectionCut.get_sectional_stiffness_behavior)(...) | Returns the sectional stiffness values for a given matrix | +| [`SectionCut.get_sectype_command_from_sectional_properties`](compolyx.SectionCut.get_sectype_command_from_sectional_properties.md#compolyx.SectionCut.get_sectype_command_from_sectional_properties)(...) | Convert the equivalent stiffness and mass matrix into an Ansys sectype command | | [`SectionCut.get_short_description`](compolyx.SectionCut.get_short_description.md#compolyx.SectionCut.get_short_description)() | | -| [`SectionCut.get_transformed_sectional_properties_matrix`](compolyx.SectionCut.get_transformed_sectional_properties_matrix.md#compolyx.SectionCut.get_transformed_sectional_properties_matrix)(...) | Transform the global mass or stiffness matrix to the given point and rotate it by the given angle, for a specific format. | -| [`SectionCut.obj_exists`](compolyx.SectionCut.obj_exists.md#compolyx.SectionCut.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. | +| [`SectionCut.get_transformed_sectional_properties_matrix`](compolyx.SectionCut.get_transformed_sectional_properties_matrix.md#compolyx.SectionCut.get_transformed_sectional_properties_matrix)(...) | Transform the global mass or stiffness matrix to the given point and rotate it by the given angle, for a specific format | +| [`SectionCut.obj_exists`](compolyx.SectionCut.obj_exists.md#compolyx.SectionCut.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 | | [`SectionCut.serialize`](compolyx.SectionCut.serialize.md#compolyx.SectionCut.serialize)() | | -| [`SectionCut.serialize_name_and_id`](compolyx.SectionCut.serialize_name_and_id.md#compolyx.SectionCut.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`SectionCut.serialize_name_and_id`](compolyx.SectionCut.serialize_name_and_id.md#compolyx.SectionCut.serialize_name_and_id)() | Helper function to serialize name and ID | | [`SectionCut.update`](compolyx.SectionCut.update.md#compolyx.SectionCut.update)() | | -| [`SectionCut.visit`](compolyx.SectionCut.visit.md#compolyx.SectionCut.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`SectionCut.visit`](compolyx.SectionCut.visit.md#compolyx.SectionCut.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.obj_exists.md index 76427a5596..addd944575 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.obj_exists.md @@ -4,5 +4,5 @@ #### SectionCut.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.section_cut_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.section_cut_type.md index 807a4484bc..bac691dfb2 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.section_cut_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SectionCut.section_cut_type.md @@ -4,4 +4,4 @@ #### *property* SectionCut.section_cut_type -Section Cut Types can be: modeling_ply_wise,production_ply_wise,analysis_ply_wise +Available Section Cut types: `modeling_ply_wise`, `production_ply_wise`, and `analysis_ply_wise`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.is_dict_item.md index ec3b8bf051..2c7c33ad2c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* Sensor.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.is_list_item.md index 49d0ae3f91..006e061460 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.is_list_item.md @@ -4,4 +4,4 @@ #### *property* Sensor.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.md index 5844cd06a1..04e0cf0fa2 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.md @@ -10,14 +10,14 @@ Sensor object for meassuring areas, prices, weights, and centers of gravity. | Name | Description | |------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`Sensor.active`](compolyx.Sensor.active.md#compolyx.Sensor.active) | Whether the sensor is computed on update or not. | +| [`Sensor.active`](compolyx.Sensor.active.md#compolyx.Sensor.active) | Whether the sensor is computed on update or not | | [`Sensor.area`](compolyx.Sensor.area.md#compolyx.Sensor.area) | Area covered by all Entities of the Sensor | | [`Sensor.center_of_gravity`](compolyx.Sensor.center_of_gravity.md#compolyx.Sensor.center_of_gravity) | Center of Gravity over all Entities of the Sensor | -| [`Sensor.enabled`](compolyx.Sensor.enabled.md#compolyx.Sensor.enabled) | Whether this object is currently enabled or not. | +| [`Sensor.enabled`](compolyx.Sensor.enabled.md#compolyx.Sensor.enabled) | Whether this object is currently enabled or not | | [`Sensor.entities`](compolyx.Sensor.entities.md#compolyx.Sensor.entities) | Entities of the Sensor | | [`Sensor.id`](compolyx.Sensor.id.md#compolyx.Sensor.id) | ID of object | -| [`Sensor.is_dict_item`](compolyx.Sensor.is_dict_item.md#compolyx.Sensor.is_dict_item) | Specifies wether the object is an item of a dict | -| [`Sensor.is_list_item`](compolyx.Sensor.is_list_item.md#compolyx.Sensor.is_list_item) | Specifies wether the object is an item of a list | +| [`Sensor.is_dict_item`](compolyx.Sensor.is_dict_item.md#compolyx.Sensor.is_dict_item) | Specifies whether the object is an item of a dict | +| [`Sensor.is_list_item`](compolyx.Sensor.is_list_item.md#compolyx.Sensor.is_list_item) | Specifies whether the object is an item of a list | | [`Sensor.link_path`](compolyx.Sensor.link_path.md#compolyx.Sensor.link_path) | Root path of the current node in the tree for links to this object | | [`Sensor.locked`](compolyx.Sensor.locked.md#compolyx.Sensor.locked) | Sensor cut was imported and cannot be changed. | | [`Sensor.modeling_ply_area`](compolyx.Sensor.modeling_ply_area.md#compolyx.Sensor.modeling_ply_area) | Cumulated area of all modeling-plies involved | @@ -28,21 +28,21 @@ Sensor object for meassuring areas, prices, weights, and centers of gravity. | [`Sensor.root_path`](compolyx.Sensor.root_path.md#compolyx.Sensor.root_path) | Root path of the current node in the tree | | [`Sensor.sensor_type`](compolyx.Sensor.sensor_type.md#compolyx.Sensor.sensor_type) | Sensor type. | | [`Sensor.status`](compolyx.Sensor.status.md#compolyx.Sensor.status) | Status of the object | -| [`Sensor.status_changed`](compolyx.Sensor.status_changed.md#compolyx.Sensor.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`Sensor.status_changed`](compolyx.Sensor.status_changed.md#compolyx.Sensor.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`Sensor.uid`](compolyx.Sensor.uid.md#compolyx.Sensor.uid) | UID of object | -| [`Sensor.vertex`](compolyx.Sensor.vertex.md#compolyx.Sensor.vertex) | This will throw an error if the object has been removed from the graph. | +| [`Sensor.vertex`](compolyx.Sensor.vertex.md#compolyx.Sensor.vertex) | This will throw an error if the object has been removed from the graph | | [`Sensor.weight`](compolyx.Sensor.weight.md#compolyx.Sensor.weight) | Weight over all Entities of the Sensor | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`Sensor.add_entity`](compolyx.Sensor.add_entity.md#compolyx.Sensor.add_entity)(entity) | Add entity to sensor. | -| [`Sensor.clear_entities`](compolyx.Sensor.clear_entities.md#compolyx.Sensor.clear_entities)() | Clear all entities of this sensor. | -| [`Sensor.find_parent`](compolyx.Sensor.find_parent.md#compolyx.Sensor.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`Sensor.obj_exists`](compolyx.Sensor.obj_exists.md#compolyx.Sensor.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. | +| [`Sensor.add_entity`](compolyx.Sensor.add_entity.md#compolyx.Sensor.add_entity)(entity) | Add entity to sensor | +| [`Sensor.clear_entities`](compolyx.Sensor.clear_entities.md#compolyx.Sensor.clear_entities)() | Clear all entities of this sensor | +| [`Sensor.find_parent`](compolyx.Sensor.find_parent.md#compolyx.Sensor.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`Sensor.obj_exists`](compolyx.Sensor.obj_exists.md#compolyx.Sensor.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 | | [`Sensor.remove_entity`](compolyx.Sensor.remove_entity.md#compolyx.Sensor.remove_entity)(entity) | Remove entity from sensor. | | [`Sensor.serialize`](compolyx.Sensor.serialize.md#compolyx.Sensor.serialize)() | | -| [`Sensor.serialize_name_and_id`](compolyx.Sensor.serialize_name_and_id.md#compolyx.Sensor.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`Sensor.serialize_name_and_id`](compolyx.Sensor.serialize_name_and_id.md#compolyx.Sensor.serialize_name_and_id)() | Helper function to serialize name and ID | | [`Sensor.update`](compolyx.Sensor.update.md#compolyx.Sensor.update)() | | -| [`Sensor.visit`](compolyx.Sensor.visit.md#compolyx.Sensor.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`Sensor.visit`](compolyx.Sensor.visit.md#compolyx.Sensor.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.obj_exists.md index 15f1599024..2732b9a538 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.obj_exists.md @@ -4,5 +4,5 @@ #### Sensor.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.sensor_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.sensor_type.md index 07908dd31c..01636ed87e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.sensor_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Sensor.sensor_type.md @@ -4,4 +4,4 @@ #### *property* Sensor.sensor_type -Sensor type. Allowed string values: sensor_by_area, sensor_by_plies, sensor_by_material and sensor_by_solid_model. +Sensor type. Available string values: `sensor_by_area`, `sensor_by_plies`, `sensor_by_material`, and `sensor_by_solid_model`. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.is_dict_item.md index d11851e75a..f79e7e06b1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* SnapToGeometry.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.is_list_item.md index af66d2834f..d8606098b8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.is_list_item.md @@ -4,4 +4,4 @@ #### *property* SnapToGeometry.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.md index de1cbfc200..ac3f78c7fb 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.md @@ -11,31 +11,31 @@ SnapToGeometry guide class | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| | [`SnapToGeometry.active`](compolyx.SnapToGeometry.active.md#compolyx.SnapToGeometry.active) | Snap-To Geometry active | -| [`SnapToGeometry.cad_geometry`](compolyx.SnapToGeometry.cad_geometry.md#compolyx.SnapToGeometry.cad_geometry) | Associated Geometry. | +| [`SnapToGeometry.cad_geometry`](compolyx.SnapToGeometry.cad_geometry.md#compolyx.SnapToGeometry.cad_geometry) | Associated Geometry | | [`SnapToGeometry.elements`](compolyx.SnapToGeometry.elements.md#compolyx.SnapToGeometry.elements) | List of affected shell elements | -| [`SnapToGeometry.enabled`](compolyx.SnapToGeometry.enabled.md#compolyx.SnapToGeometry.enabled) | Whether this object is currently enabled or not. | +| [`SnapToGeometry.enabled`](compolyx.SnapToGeometry.enabled.md#compolyx.SnapToGeometry.enabled) | Whether this object is currently enabled or not | | [`SnapToGeometry.id`](compolyx.SnapToGeometry.id.md#compolyx.SnapToGeometry.id) | ID of object | -| [`SnapToGeometry.is_dict_item`](compolyx.SnapToGeometry.is_dict_item.md#compolyx.SnapToGeometry.is_dict_item) | Specifies wether the object is an item of a dict | -| [`SnapToGeometry.is_list_item`](compolyx.SnapToGeometry.is_list_item.md#compolyx.SnapToGeometry.is_list_item) | Specifies wether the object is an item of a list | +| [`SnapToGeometry.is_dict_item`](compolyx.SnapToGeometry.is_dict_item.md#compolyx.SnapToGeometry.is_dict_item) | Specifies whether the object is an item of a dict | +| [`SnapToGeometry.is_list_item`](compolyx.SnapToGeometry.is_list_item.md#compolyx.SnapToGeometry.is_list_item) | Specifies whether the object is an item of a list | | [`SnapToGeometry.link_path`](compolyx.SnapToGeometry.link_path.md#compolyx.SnapToGeometry.link_path) | Root path of the current node in the tree for links to this object | | [`SnapToGeometry.name`](compolyx.SnapToGeometry.name.md#compolyx.SnapToGeometry.name) | Name of object | -| [`SnapToGeometry.orientation`](compolyx.SnapToGeometry.orientation.md#compolyx.SnapToGeometry.orientation) | Orientation. | +| [`SnapToGeometry.orientation`](compolyx.SnapToGeometry.orientation.md#compolyx.SnapToGeometry.orientation) | Orientation | | [`SnapToGeometry.oriented_selection_set`](compolyx.SnapToGeometry.oriented_selection_set.md#compolyx.SnapToGeometry.oriented_selection_set) | | | [`SnapToGeometry.parent`](compolyx.SnapToGeometry.parent.md#compolyx.SnapToGeometry.parent) | Parent object in tree | | [`SnapToGeometry.root_path`](compolyx.SnapToGeometry.root_path.md#compolyx.SnapToGeometry.root_path) | Root path of the current node in the tree | | [`SnapToGeometry.status`](compolyx.SnapToGeometry.status.md#compolyx.SnapToGeometry.status) | Status of the object | -| [`SnapToGeometry.status_changed`](compolyx.SnapToGeometry.status_changed.md#compolyx.SnapToGeometry.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`SnapToGeometry.status_changed`](compolyx.SnapToGeometry.status_changed.md#compolyx.SnapToGeometry.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`SnapToGeometry.uid`](compolyx.SnapToGeometry.uid.md#compolyx.SnapToGeometry.uid) | UID of object | -| [`SnapToGeometry.vertex`](compolyx.SnapToGeometry.vertex.md#compolyx.SnapToGeometry.vertex) | This will throw an error if the object has been removed from the graph. | +| [`SnapToGeometry.vertex`](compolyx.SnapToGeometry.vertex.md#compolyx.SnapToGeometry.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`SnapToGeometry.find_parent`](compolyx.SnapToGeometry.find_parent.md#compolyx.SnapToGeometry.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`SnapToGeometry.find_parent`](compolyx.SnapToGeometry.find_parent.md#compolyx.SnapToGeometry.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`SnapToGeometry.from_obj`](compolyx.SnapToGeometry.from_obj.md#compolyx.SnapToGeometry.from_obj)(obj, org_obj) | | -| [`SnapToGeometry.obj_exists`](compolyx.SnapToGeometry.obj_exists.md#compolyx.SnapToGeometry.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. | +| [`SnapToGeometry.obj_exists`](compolyx.SnapToGeometry.obj_exists.md#compolyx.SnapToGeometry.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 | | [`SnapToGeometry.serialize`](compolyx.SnapToGeometry.serialize.md#compolyx.SnapToGeometry.serialize)() | | -| [`SnapToGeometry.serialize_name_and_id`](compolyx.SnapToGeometry.serialize_name_and_id.md#compolyx.SnapToGeometry.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`SnapToGeometry.serialize_name_and_id`](compolyx.SnapToGeometry.serialize_name_and_id.md#compolyx.SnapToGeometry.serialize_name_and_id)() | Helper function to serialize name and ID | | [`SnapToGeometry.update`](compolyx.SnapToGeometry.update.md#compolyx.SnapToGeometry.update)() | | -| [`SnapToGeometry.visit`](compolyx.SnapToGeometry.visit.md#compolyx.SnapToGeometry.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`SnapToGeometry.visit`](compolyx.SnapToGeometry.visit.md#compolyx.SnapToGeometry.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.obj_exists.md index 3395747cfa..07dbdbc6f7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.obj_exists.md @@ -4,5 +4,5 @@ #### SnapToGeometry.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.orientation.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.orientation.md index c96c90fea3..6f90d1bfcc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.orientation.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SnapToGeometry.orientation.md @@ -4,4 +4,4 @@ #### *property* SnapToGeometry.orientation -Orientation. Allowed string values: [‘top’, ‘bottom’, ‘undefined’] +Orientation. Available string values: [`top`, `bottom`, `undefined`] diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.enabled.md index 6cd5a86add..124ed43a12 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.enabled.md @@ -4,4 +4,4 @@ #### *property* SolidElementSet.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.is_dict_item.md index 8802b09fd3..85c97ac636 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* SolidElementSet.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.is_list_item.md index 1ee4c59d20..9a63da4296 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.is_list_item.md @@ -4,4 +4,4 @@ #### *property* SolidElementSet.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.locked.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.locked.md index d241c6b9b4..2040be20a1 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.locked.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.locked.md @@ -4,4 +4,4 @@ #### *property* SolidElementSet.locked -Returns true if the object is locked (nor editable, neither deletable) +Returns true if the object is locked (not editable, nor deletable) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.md index 458ba3a73c..12b51a0750 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.md @@ -4,38 +4,38 @@ ### *class* compolyx.SolidElementSet(graph, obj=None, parent=None) -Solid element set class -Element Set of a solid model +Solid element set class. +Element Set of a solid model. ### Attributes | Name | Description | |------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`SolidElementSet.active`](compolyx.SolidElementSet.active.md#compolyx.SolidElementSet.active) | active status of object | -| [`SolidElementSet.element_labels`](compolyx.SolidElementSet.element_labels.md#compolyx.SolidElementSet.element_labels) | List of solid elements which are linked to this element set. | -| [`SolidElementSet.enabled`](compolyx.SolidElementSet.enabled.md#compolyx.SolidElementSet.enabled) | Whether this object is currently enabled or not. | +| [`SolidElementSet.active`](compolyx.SolidElementSet.active.md#compolyx.SolidElementSet.active) | Active status of object | +| [`SolidElementSet.element_labels`](compolyx.SolidElementSet.element_labels.md#compolyx.SolidElementSet.element_labels) | List of solid elements which are linked to this element set | +| [`SolidElementSet.enabled`](compolyx.SolidElementSet.enabled.md#compolyx.SolidElementSet.enabled) | Whether this object is currently enabled or not | | [`SolidElementSet.id`](compolyx.SolidElementSet.id.md#compolyx.SolidElementSet.id) | ID of object | -| [`SolidElementSet.is_dict_item`](compolyx.SolidElementSet.is_dict_item.md#compolyx.SolidElementSet.is_dict_item) | Specifies wether the object is an item of a dict | -| [`SolidElementSet.is_list_item`](compolyx.SolidElementSet.is_list_item.md#compolyx.SolidElementSet.is_list_item) | Specifies wether the object is an item of a list | +| [`SolidElementSet.is_dict_item`](compolyx.SolidElementSet.is_dict_item.md#compolyx.SolidElementSet.is_dict_item) | Specifies whether the object is an item of a dict | +| [`SolidElementSet.is_list_item`](compolyx.SolidElementSet.is_list_item.md#compolyx.SolidElementSet.is_list_item) | Specifies whether the object is an item of a list | | [`SolidElementSet.link_path`](compolyx.SolidElementSet.link_path.md#compolyx.SolidElementSet.link_path) | Root path of the current node in the tree for links to this object | -| [`SolidElementSet.locked`](compolyx.SolidElementSet.locked.md#compolyx.SolidElementSet.locked) | Returns true if the object is locked (nor editable, neither deletable) | +| [`SolidElementSet.locked`](compolyx.SolidElementSet.locked.md#compolyx.SolidElementSet.locked) | Returns true if the object is locked (not editable, nor deletable) | | [`SolidElementSet.name`](compolyx.SolidElementSet.name.md#compolyx.SolidElementSet.name) | Name of object | | [`SolidElementSet.parent`](compolyx.SolidElementSet.parent.md#compolyx.SolidElementSet.parent) | Parent object in tree | | [`SolidElementSet.root_path`](compolyx.SolidElementSet.root_path.md#compolyx.SolidElementSet.root_path) | Root path of the current node in the tree | | [`SolidElementSet.size`](compolyx.SolidElementSet.size.md#compolyx.SolidElementSet.size) | Number of entities | | [`SolidElementSet.status`](compolyx.SolidElementSet.status.md#compolyx.SolidElementSet.status) | Status of the object | -| [`SolidElementSet.status_changed`](compolyx.SolidElementSet.status_changed.md#compolyx.SolidElementSet.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`SolidElementSet.status_changed`](compolyx.SolidElementSet.status_changed.md#compolyx.SolidElementSet.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`SolidElementSet.uid`](compolyx.SolidElementSet.uid.md#compolyx.SolidElementSet.uid) | UID of object | -| [`SolidElementSet.vertex`](compolyx.SolidElementSet.vertex.md#compolyx.SolidElementSet.vertex) | This will throw an error if the object has been removed from the graph. | +| [`SolidElementSet.vertex`](compolyx.SolidElementSet.vertex.md#compolyx.SolidElementSet.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`SolidElementSet.find_parent`](compolyx.SolidElementSet.find_parent.md#compolyx.SolidElementSet.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`SolidElementSet.find_parent`](compolyx.SolidElementSet.find_parent.md#compolyx.SolidElementSet.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`SolidElementSet.get_short_description`](compolyx.SolidElementSet.get_short_description.md#compolyx.SolidElementSet.get_short_description)() | | -| [`SolidElementSet.obj_exists`](compolyx.SolidElementSet.obj_exists.md#compolyx.SolidElementSet.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. | +| [`SolidElementSet.obj_exists`](compolyx.SolidElementSet.obj_exists.md#compolyx.SolidElementSet.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 | | [`SolidElementSet.serialize`](compolyx.SolidElementSet.serialize.md#compolyx.SolidElementSet.serialize)() | Serialize to Python string | -| [`SolidElementSet.serialize_name_and_id`](compolyx.SolidElementSet.serialize_name_and_id.md#compolyx.SolidElementSet.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`SolidElementSet.serialize_name_and_id`](compolyx.SolidElementSet.serialize_name_and_id.md#compolyx.SolidElementSet.serialize_name_and_id)() | Helper function to serialize name and ID | | [`SolidElementSet.update`](compolyx.SolidElementSet.update.md#compolyx.SolidElementSet.update)() | | -| [`SolidElementSet.visit`](compolyx.SolidElementSet.visit.md#compolyx.SolidElementSet.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`SolidElementSet.visit`](compolyx.SolidElementSet.visit.md#compolyx.SolidElementSet.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.obj_exists.md index 6b27614578..a681069728 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidElementSet.obj_exists.md @@ -4,5 +4,5 @@ #### SolidElementSet.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.changed.md index 566186e361..27114455da 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.changed.md @@ -4,4 +4,4 @@ #### *property* SolidModel.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.create_cut_off_geometry_obj.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.create_cut_off_geometry_obj.md index c334e9192b..43684f415d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.create_cut_off_geometry_obj.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.create_cut_off_geometry_obj.md @@ -10,6 +10,6 @@ Create a new cut-off geometry object. - name: The name of the object. - id: The ID of the object. - cad_geometry: A geometry to snap to. - - orientation: Valid options: “up” and “down”. + - orientation: Available options: `up` and `down`. * **Returns:** Cut-off geometry. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.drop_off_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.drop_off_type.md index 2a040b95f0..493ddaabc9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.drop_off_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.drop_off_type.md @@ -4,4 +4,4 @@ #### *property* SolidModel.drop_off_type -Drop-off type. Allowed string values: [‘inside_ply’, ‘outside_ply’] +Drop-off type. Available string values: [‘inside_ply’, ‘outside_ply’] diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.ex_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.ex_type.md index 2ea758ac5a..337eace1f3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.ex_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.ex_type.md @@ -4,4 +4,4 @@ #### *property* SolidModel.ex_type -Extrusion type. Allowed string values: [‘monolithic’, ‘analysis_ply_wise’, ‘production_ply_wise’, ‘modeling_ply_wise’, ‘sandwich_wise’, ‘specify_thickness’, ‘material_wise’, ‘user_defined’] +Extrusion type. Available string values: [`monolithic`, `analysis_ply_wise`, `production_ply_wise`, `modeling_ply_wise`, `sandwich_wise`, `specify_thickness`, `material_wise`, `user_defined`] diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.is_dict_item.md index 9250001d2d..e021f15a5c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* SolidModel.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.is_list_item.md index 994edba82e..611d0c9b51 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.is_list_item.md @@ -4,4 +4,4 @@ #### *property* SolidModel.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.md index d09a84fac6..44f979fad5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.md @@ -12,36 +12,36 @@ Solid Model class |------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------| | [`SolidModel.active`](compolyx.SolidModel.active.md#compolyx.SolidModel.active) | Solid-Model active | | [`SolidModel.analysis_plies`](compolyx.SolidModel.analysis_plies.md#compolyx.SolidModel.analysis_plies) | Analysis Plies of the Solid Model | -| [`SolidModel.changed`](compolyx.SolidModel.changed.md#compolyx.SolidModel.changed) | Status boolean. | +| [`SolidModel.changed`](compolyx.SolidModel.changed.md#compolyx.SolidModel.changed) | Status boolean | | [`SolidModel.connect_butt_joined_plies`](compolyx.SolidModel.connect_butt_joined_plies.md#compolyx.SolidModel.connect_butt_joined_plies) | Do not make drop-offs between butt-joined plies if set to True | | [`SolidModel.coordinate_system_index`](compolyx.SolidModel.coordinate_system_index.md#compolyx.SolidModel.coordinate_system_index) | Coordinate System index | | [`SolidModel.cut_off_geometry_objs`](compolyx.SolidModel.cut_off_geometry_objs.md#compolyx.SolidModel.cut_off_geometry_objs) | Cut-Off Geometry objects | -| [`SolidModel.delete_bad_elements`](compolyx.SolidModel.delete_bad_elements.md#compolyx.SolidModel.delete_bad_elements) | Boolean whether to delete the erroneous elements. | -| [`SolidModel.disable_dropoff_sets_on_bottom`](compolyx.SolidModel.disable_dropoff_sets_on_bottom.md#compolyx.SolidModel.disable_dropoff_sets_on_bottom) | Elements where the drop-offs on bottom are disabled. | -| [`SolidModel.disable_dropoff_sets_on_top`](compolyx.SolidModel.disable_dropoff_sets_on_top.md#compolyx.SolidModel.disable_dropoff_sets_on_top) | Elements of where the drop-offs on top are disabled. | -| [`SolidModel.disable_dropoffs_on_bottom`](compolyx.SolidModel.disable_dropoffs_on_bottom.md#compolyx.SolidModel.disable_dropoffs_on_bottom) | Boolean whether to disable the drop-off elements on bottom surface. | -| [`SolidModel.disable_dropoffs_on_top`](compolyx.SolidModel.disable_dropoffs_on_top.md#compolyx.SolidModel.disable_dropoffs_on_top) | Boolean whether to disable the drop-off elements on top surface. | -| [`SolidModel.disable_numbering_updates`](compolyx.SolidModel.disable_numbering_updates.md#compolyx.SolidModel.disable_numbering_updates) | Debug option to disable all numbering updates. | -| [`SolidModel.disable_skin_components`](compolyx.SolidModel.disable_skin_components.md#compolyx.SolidModel.disable_skin_components) | Debug option to disable the creation of skin components. | +| [`SolidModel.delete_bad_elements`](compolyx.SolidModel.delete_bad_elements.md#compolyx.SolidModel.delete_bad_elements) | Boolean whether to delete the erroneous elements | +| [`SolidModel.disable_dropoff_sets_on_bottom`](compolyx.SolidModel.disable_dropoff_sets_on_bottom.md#compolyx.SolidModel.disable_dropoff_sets_on_bottom) | Elements where the drop-offs on bottom are disabled | +| [`SolidModel.disable_dropoff_sets_on_top`](compolyx.SolidModel.disable_dropoff_sets_on_top.md#compolyx.SolidModel.disable_dropoff_sets_on_top) | Elements of where the drop-offs on top are disabled | +| [`SolidModel.disable_dropoffs_on_bottom`](compolyx.SolidModel.disable_dropoffs_on_bottom.md#compolyx.SolidModel.disable_dropoffs_on_bottom) | Boolean whether to disable the drop-off elements on bottom surface | +| [`SolidModel.disable_dropoffs_on_top`](compolyx.SolidModel.disable_dropoffs_on_top.md#compolyx.SolidModel.disable_dropoffs_on_top) | Boolean whether to disable the drop-off elements on top surface | +| [`SolidModel.disable_numbering_updates`](compolyx.SolidModel.disable_numbering_updates.md#compolyx.SolidModel.disable_numbering_updates) | Debug option to disable all numbering updates | +| [`SolidModel.disable_skin_components`](compolyx.SolidModel.disable_skin_components.md#compolyx.SolidModel.disable_skin_components) | Debug option to disable the creation of skin components | | [`SolidModel.drop_hanging_nodes`](compolyx.SolidModel.drop_hanging_nodes.md#compolyx.SolidModel.drop_hanging_nodes) | If the hanging nodes are exported or dropped | -| [`SolidModel.drop_off_type`](compolyx.SolidModel.drop_off_type.md#compolyx.SolidModel.drop_off_type) | Drop-off type. | +| [`SolidModel.drop_off_type`](compolyx.SolidModel.drop_off_type.md#compolyx.SolidModel.drop_off_type) | Drop-off type | | [`SolidModel.element_index`](compolyx.SolidModel.element_index.md#compolyx.SolidModel.element_index) | Element offset index | -| [`SolidModel.element_sets`](compolyx.SolidModel.element_sets.md#compolyx.SolidModel.element_sets) | Element Set(s) of the solid model. | -| [`SolidModel.enabled`](compolyx.SolidModel.enabled.md#compolyx.SolidModel.enabled) | Whether this object is currently enabled or not. | -| [`SolidModel.ex_type`](compolyx.SolidModel.ex_type.md#compolyx.SolidModel.ex_type) | Extrusion type. | +| [`SolidModel.element_sets`](compolyx.SolidModel.element_sets.md#compolyx.SolidModel.element_sets) | Element Set(s) of the solid model | +| [`SolidModel.enabled`](compolyx.SolidModel.enabled.md#compolyx.SolidModel.enabled) | Whether this object is currently enabled or not | +| [`SolidModel.ex_type`](compolyx.SolidModel.ex_type.md#compolyx.SolidModel.ex_type) | Extrusion type | | [`SolidModel.extrusion_guides`](compolyx.SolidModel.extrusion_guides.md#compolyx.SolidModel.extrusion_guides) | Extrusion Guides | -| [`SolidModel.global_cut_off_material`](compolyx.SolidModel.global_cut_off_material.md#compolyx.SolidModel.global_cut_off_material) | Global material of the cut-off elements. | -| [`SolidModel.global_drop_off_material`](compolyx.SolidModel.global_drop_off_material.md#compolyx.SolidModel.global_drop_off_material) | Global material of the drop-off elements. | +| [`SolidModel.global_cut_off_material`](compolyx.SolidModel.global_cut_off_material.md#compolyx.SolidModel.global_cut_off_material) | Global material of the cut-off elements | +| [`SolidModel.global_drop_off_material`](compolyx.SolidModel.global_drop_off_material.md#compolyx.SolidModel.global_drop_off_material) | Global material of the drop-off elements | | [`SolidModel.id`](compolyx.SolidModel.id.md#compolyx.SolidModel.id) | ID of object | -| [`SolidModel.is_dict_item`](compolyx.SolidModel.is_dict_item.md#compolyx.SolidModel.is_dict_item) | Specifies wether the object is an item of a dict | -| [`SolidModel.is_list_item`](compolyx.SolidModel.is_list_item.md#compolyx.SolidModel.is_list_item) | Specifies wether the object is an item of a list | +| [`SolidModel.is_dict_item`](compolyx.SolidModel.is_dict_item.md#compolyx.SolidModel.is_dict_item) | Specifies whether the object is an item of a dict | +| [`SolidModel.is_list_item`](compolyx.SolidModel.is_list_item.md#compolyx.SolidModel.is_list_item) | Specifies whether the object is an item of a list | | [`SolidModel.is_uptodate`](compolyx.SolidModel.is_uptodate.md#compolyx.SolidModel.is_uptodate) | Update status of the object | | [`SolidModel.link_path`](compolyx.SolidModel.link_path.md#compolyx.SolidModel.link_path) | Root path of the current node in the tree for links to this object | -| [`SolidModel.locked`](compolyx.SolidModel.locked.md#compolyx.SolidModel.locked) | Solid Model is generated from an imported source and cannot be changed. | +| [`SolidModel.locked`](compolyx.SolidModel.locked.md#compolyx.SolidModel.locked) | Solid Model is generated from an imported source and cannot be changed | | [`SolidModel.material_index`](compolyx.SolidModel.material_index.md#compolyx.SolidModel.material_index) | Material index | -| [`SolidModel.max_thickness`](compolyx.SolidModel.max_thickness.md#compolyx.SolidModel.max_thickness) | Maximum thickness of solid elements. | +| [`SolidModel.max_thickness`](compolyx.SolidModel.max_thickness.md#compolyx.SolidModel.max_thickness) | Maximum thickness of solid elements | | [`SolidModel.mesh_components`](compolyx.SolidModel.mesh_components.md#compolyx.SolidModel.mesh_components) | Element Sets of the solid mesh | -| [`SolidModel.minimum_volume`](compolyx.SolidModel.minimum_volume.md#compolyx.SolidModel.minimum_volume) | Defines the minimum volume of each solid element. | +| [`SolidModel.minimum_volume`](compolyx.SolidModel.minimum_volume.md#compolyx.SolidModel.minimum_volume) | Defines the minimum volume of each solid element | | [`SolidModel.name`](compolyx.SolidModel.name.md#compolyx.SolidModel.name) | Name of object | | [`SolidModel.node_index`](compolyx.SolidModel.node_index.md#compolyx.SolidModel.node_index) | Node offset index | | [`SolidModel.num_coordinate_systems`](compolyx.SolidModel.num_coordinate_systems.md#compolyx.SolidModel.num_coordinate_systems) | | @@ -49,17 +49,17 @@ Solid Model class | [`SolidModel.num_solid_elements`](compolyx.SolidModel.num_solid_elements.md#compolyx.SolidModel.num_solid_elements) | | | [`SolidModel.num_solid_nodes`](compolyx.SolidModel.num_solid_nodes.md#compolyx.SolidModel.num_solid_nodes) | | | [`SolidModel.num_solid_sections`](compolyx.SolidModel.num_solid_sections.md#compolyx.SolidModel.num_solid_sections) | | -| [`SolidModel.offset_type`](compolyx.SolidModel.offset_type.md#compolyx.SolidModel.offset_type) | Offset type. | +| [`SolidModel.offset_type`](compolyx.SolidModel.offset_type.md#compolyx.SolidModel.offset_type) | Offset type | | [`SolidModel.parent`](compolyx.SolidModel.parent.md#compolyx.SolidModel.parent) | Parent object in tree | -| [`SolidModel.ply_group_pointers`](compolyx.SolidModel.ply_group_pointers.md#compolyx.SolidModel.ply_group_pointers) | Ply group pointers for user defined extrusion. | +| [`SolidModel.ply_group_pointers`](compolyx.SolidModel.ply_group_pointers.md#compolyx.SolidModel.ply_group_pointers) | Ply group pointers for user defined extrusion | | [`SolidModel.root_path`](compolyx.SolidModel.root_path.md#compolyx.SolidModel.root_path) | Root path of the current node in the tree | | [`SolidModel.section_index`](compolyx.SolidModel.section_index.md#compolyx.SolidModel.section_index) | Section offset index | | [`SolidModel.skip_elements_without_plies`](compolyx.SolidModel.skip_elements_without_plies.md#compolyx.SolidModel.skip_elements_without_plies) | Enable this option to automatically skip elements without plies from the region of extrusion | | [`SolidModel.snap_to_geometry_objs`](compolyx.SolidModel.snap_to_geometry_objs.md#compolyx.SolidModel.snap_to_geometry_objs) | Snap to Geometry objects | | [`SolidModel.status`](compolyx.SolidModel.status.md#compolyx.SolidModel.status) | Status of the object | -| [`SolidModel.status_changed`](compolyx.SolidModel.status_changed.md#compolyx.SolidModel.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`SolidModel.transfer_all_sets`](compolyx.SolidModel.transfer_all_sets.md#compolyx.SolidModel.transfer_all_sets) | Whether to transfer all edge and element sets to the solid model or not. | -| [`SolidModel.transferred_edge_sets`](compolyx.SolidModel.transferred_edge_sets.md#compolyx.SolidModel.transferred_edge_sets) | Edge sets to transfer to solid model. | +| [`SolidModel.status_changed`](compolyx.SolidModel.status_changed.md#compolyx.SolidModel.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`SolidModel.transfer_all_sets`](compolyx.SolidModel.transfer_all_sets.md#compolyx.SolidModel.transfer_all_sets) | Whether to transfer all edge and element sets to the solid model or not | +| [`SolidModel.transferred_edge_sets`](compolyx.SolidModel.transferred_edge_sets.md#compolyx.SolidModel.transferred_edge_sets) | Edge sets to transfer to solid model | | [`SolidModel.transferred_element_sets`](compolyx.SolidModel.transferred_element_sets.md#compolyx.SolidModel.transferred_element_sets) | Element sets to transfer to solid model. | | [`SolidModel.uid`](compolyx.SolidModel.uid.md#compolyx.SolidModel.uid) | UID of object | | [`SolidModel.use_default_coordinate_system_index`](compolyx.SolidModel.use_default_coordinate_system_index.md#compolyx.SolidModel.use_default_coordinate_system_index) | Use consecutive coordinate system numbering | @@ -69,7 +69,7 @@ Solid Model class | [`SolidModel.use_default_section_index`](compolyx.SolidModel.use_default_section_index.md#compolyx.SolidModel.use_default_section_index) | Use consecutive section numbering | | [`SolidModel.use_solid_model_prefix`](compolyx.SolidModel.use_solid_model_prefix.md#compolyx.SolidModel.use_solid_model_prefix) | If the solid model name is used as a prefix for all components exported to the \*cdb file | | [`SolidModel.use_solsh_elements`](compolyx.SolidModel.use_solsh_elements.md#compolyx.SolidModel.use_solsh_elements) | If selected solid-shell elements are written to the \*cdb file | -| [`SolidModel.vertex`](compolyx.SolidModel.vertex.md#compolyx.SolidModel.vertex) | This will throw an error if the object has been removed from the graph. | +| [`SolidModel.vertex`](compolyx.SolidModel.vertex.md#compolyx.SolidModel.vertex) | This will throw an error if the object has been removed from the graph | | [`SolidModel.warping_limit`](compolyx.SolidModel.warping_limit.md#compolyx.SolidModel.warping_limit) | Defines the maximum allowable warping limit. | | [`SolidModel.write_degenerated_elements`](compolyx.SolidModel.write_degenerated_elements.md#compolyx.SolidModel.write_degenerated_elements) | If set to false no drop-off and cut-off elements are written to the \*cdb file | @@ -83,17 +83,17 @@ Solid Model class | [`SolidModel.clear_disable_dropoff_sets_on_bottom`](compolyx.SolidModel.clear_disable_dropoff_sets_on_bottom.md#compolyx.SolidModel.clear_disable_dropoff_sets_on_bottom)() | Clear sets where the drop-offs on bottom are disabled | | [`SolidModel.clear_disable_dropoff_sets_on_top`](compolyx.SolidModel.clear_disable_dropoff_sets_on_top.md#compolyx.SolidModel.clear_disable_dropoff_sets_on_top)() | Clear sets where the drop-offs on top are disabled | | [`SolidModel.clear_element_sets`](compolyx.SolidModel.clear_element_sets.md#compolyx.SolidModel.clear_element_sets)() | Clear Element Sets of Solid Model | -| [`SolidModel.clear_generated_data`](compolyx.SolidModel.clear_generated_data.md#compolyx.SolidModel.clear_generated_data)() | Function clears generated solid model but keeps all definitions. | +| [`SolidModel.clear_generated_data`](compolyx.SolidModel.clear_generated_data.md#compolyx.SolidModel.clear_generated_data)() | Function clears generated solid model but keeps all definitions | | [`SolidModel.copy_cut_off_geometry_obj`](compolyx.SolidModel.copy_cut_off_geometry_obj.md#compolyx.SolidModel.copy_cut_off_geometry_obj)(source) | Copy a Cut-Off Geometry | | [`SolidModel.copy_extrusion_guide`](compolyx.SolidModel.copy_extrusion_guide.md#compolyx.SolidModel.copy_extrusion_guide)(source) | Copy a Extrusion Guide | | [`SolidModel.copy_snap_to_geometry_obj`](compolyx.SolidModel.copy_snap_to_geometry_obj.md#compolyx.SolidModel.copy_snap_to_geometry_obj)(source) | Copy a Snap-To Geometry | -| [`SolidModel.create_cut_off_geometry_obj`](compolyx.SolidModel.create_cut_off_geometry_obj.md#compolyx.SolidModel.create_cut_off_geometry_obj)(name) | Create a new cut-off geometry object. | -| [`SolidModel.create_extrusion_guide`](compolyx.SolidModel.create_extrusion_guide.md#compolyx.SolidModel.create_extrusion_guide)(name[, ...]) | Create a new extrusion guide. | -| [`SolidModel.create_snap_to_geometry_obj`](compolyx.SolidModel.create_snap_to_geometry_obj.md#compolyx.SolidModel.create_snap_to_geometry_obj)(name) | Create a new snap-to-geometry object. | +| [`SolidModel.create_cut_off_geometry_obj`](compolyx.SolidModel.create_cut_off_geometry_obj.md#compolyx.SolidModel.create_cut_off_geometry_obj)(name) | Create a new cut-off geometry object | +| [`SolidModel.create_extrusion_guide`](compolyx.SolidModel.create_extrusion_guide.md#compolyx.SolidModel.create_extrusion_guide)(name[, ...]) | Create a new extrusion guide | +| [`SolidModel.create_snap_to_geometry_obj`](compolyx.SolidModel.create_snap_to_geometry_obj.md#compolyx.SolidModel.create_snap_to_geometry_obj)(name) | Create a new snap-to-geometry object | | [`SolidModel.export_skin`](compolyx.SolidModel.export_skin.md#compolyx.SolidModel.export_skin)(path[, midside_nodes]) | Creates a geometry file (STP or IGES) of the solid model based on the tessellated FE mesh | -| [`SolidModel.find_parent`](compolyx.SolidModel.find_parent.md#compolyx.SolidModel.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`SolidModel.find_parent`](compolyx.SolidModel.find_parent.md#compolyx.SolidModel.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`SolidModel.get_short_description`](compolyx.SolidModel.get_short_description.md#compolyx.SolidModel.get_short_description)() | | -| [`SolidModel.obj_exists`](compolyx.SolidModel.obj_exists.md#compolyx.SolidModel.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. | +| [`SolidModel.obj_exists`](compolyx.SolidModel.obj_exists.md#compolyx.SolidModel.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 | | [`SolidModel.remove_element_set`](compolyx.SolidModel.remove_element_set.md#compolyx.SolidModel.remove_element_set)(element_set) | Remove Element Set from the solid model | | [`SolidModel.remove_global_cut_off_material`](compolyx.SolidModel.remove_global_cut_off_material.md#compolyx.SolidModel.remove_global_cut_off_material)() | Removes the global cutoff material of the SolidModel | | [`SolidModel.remove_global_drop_off_material`](compolyx.SolidModel.remove_global_drop_off_material.md#compolyx.SolidModel.remove_global_drop_off_material)() | Removes the global dropoff material of the SolidModel | @@ -101,9 +101,9 @@ Solid Model class | [`SolidModel.serialize`](compolyx.SolidModel.serialize.md#compolyx.SolidModel.serialize)() | | | [`SolidModel.serialize_name_and_id`](compolyx.SolidModel.serialize_name_and_id.md#compolyx.SolidModel.serialize_name_and_id)() | Helper function to serialize name and ID. | | [`SolidModel.shell_elements`](compolyx.SolidModel.shell_elements.md#compolyx.SolidModel.shell_elements)() | Function returns the shell elements where this extrusion operates on | -| [`SolidModel.solid_elements`](compolyx.SolidModel.solid_elements.md#compolyx.SolidModel.solid_elements)(...) | * **Parameters:** | +| [`SolidModel.solid_elements`](compolyx.SolidModel.solid_elements.md#compolyx.SolidModel.solid_elements)(...) | | | [`SolidModel.update`](compolyx.SolidModel.update.md#compolyx.SolidModel.update)() | | -| [`SolidModel.visit`](compolyx.SolidModel.visit.md#compolyx.SolidModel.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | -| [`SolidModel.write_h5_and_cdb_file`](compolyx.SolidModel.write_h5_and_cdb_file.md#compolyx.SolidModel.write_h5_and_cdb_file)(path, ...) | Writes the .h5 and .cdb file for ANSYS Workbench application. | +| [`SolidModel.visit`](compolyx.SolidModel.visit.md#compolyx.SolidModel.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | +| [`SolidModel.write_h5_and_cdb_file`](compolyx.SolidModel.write_h5_and_cdb_file.md#compolyx.SolidModel.write_h5_and_cdb_file)(path, ...) | Writes the .h5 and .cdb file for ANSYS Workbench application | | [`SolidModel.write_lsdyna_solid_model`](compolyx.SolidModel.write_lsdyna_solid_model.md#compolyx.SolidModel.write_lsdyna_solid_model)(path[, ...]) | Export solid model as FE model for LS Dyna | -| [`SolidModel.write_solid_model`](compolyx.SolidModel.write_solid_model.md#compolyx.SolidModel.write_solid_model)(path) | Export solid model as FE model for ANSYS. | +| [`SolidModel.write_solid_model`](compolyx.SolidModel.write_solid_model.md#compolyx.SolidModel.write_solid_model)(path) | Export solid model as FE model for ANSYS | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.obj_exists.md index b459df4a4a..a92878a3e4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.obj_exists.md @@ -4,5 +4,5 @@ #### SolidModel.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.offset_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.offset_type.md index 982ab95637..c826358d16 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.offset_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SolidModel.offset_type.md @@ -4,4 +4,4 @@ #### *property* SolidModel.offset_type -Offset type. Allowed string values: [‘shell_normal’, ‘surface_normal’] +Offset type. Available string values: [‘shell_normal’, ‘surface_normal’] diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.enabled.md index a2511328cb..cd9894dbd4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.enabled.md @@ -4,4 +4,4 @@ #### *property* SphericalSelectionRule.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.md index fa966f5cb5..a4868d2b78 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.md @@ -10,39 +10,39 @@ Spherical selection rule. | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`SphericalSelectionRule.active`](compolyx.SphericalSelectionRule.active.md#compolyx.SphericalSelectionRule.active) | active status of object | +| [`SphericalSelectionRule.active`](compolyx.SphericalSelectionRule.active.md#compolyx.SphericalSelectionRule.active) | Active status of object | | [`SphericalSelectionRule.changed`](compolyx.SphericalSelectionRule.changed.md#compolyx.SphericalSelectionRule.changed) | Triggers Observable to dispatch changed message | | [`SphericalSelectionRule.direction_in_global_coordinates`](compolyx.SphericalSelectionRule.direction_in_global_coordinates.md#compolyx.SphericalSelectionRule.direction_in_global_coordinates) | Direction of the rule in global coordinates | -| [`SphericalSelectionRule.enabled`](compolyx.SphericalSelectionRule.enabled.md#compolyx.SphericalSelectionRule.enabled) | Whether this object is currently enabled or not. | -| [`SphericalSelectionRule.extent`](compolyx.SphericalSelectionRule.extent.md#compolyx.SphericalSelectionRule.extent) | extent of the rule | +| [`SphericalSelectionRule.enabled`](compolyx.SphericalSelectionRule.enabled.md#compolyx.SphericalSelectionRule.enabled) | Whether this object is currently enabled or not | +| [`SphericalSelectionRule.extent`](compolyx.SphericalSelectionRule.extent.md#compolyx.SphericalSelectionRule.extent) | Extent of the rule | | [`SphericalSelectionRule.id`](compolyx.SphericalSelectionRule.id.md#compolyx.SphericalSelectionRule.id) | ID of object | -| [`SphericalSelectionRule.include_rule_type`](compolyx.SphericalSelectionRule.include_rule_type.md#compolyx.SphericalSelectionRule.include_rule_type) | include type | -| [`SphericalSelectionRule.is_dict_item`](compolyx.SphericalSelectionRule.is_dict_item.md#compolyx.SphericalSelectionRule.is_dict_item) | Specifies wether the object is an item of a dict | -| [`SphericalSelectionRule.is_list_item`](compolyx.SphericalSelectionRule.is_list_item.md#compolyx.SphericalSelectionRule.is_list_item) | Specifies wether the object is an item of a list | +| [`SphericalSelectionRule.include_rule_type`](compolyx.SphericalSelectionRule.include_rule_type.md#compolyx.SphericalSelectionRule.include_rule_type) | Include type | +| [`SphericalSelectionRule.is_dict_item`](compolyx.SphericalSelectionRule.is_dict_item.md#compolyx.SphericalSelectionRule.is_dict_item) | Specifies whether the object is an item of a dict | +| [`SphericalSelectionRule.is_list_item`](compolyx.SphericalSelectionRule.is_list_item.md#compolyx.SphericalSelectionRule.is_list_item) | Specifies whether the object is an item of a list | | [`SphericalSelectionRule.link_path`](compolyx.SphericalSelectionRule.link_path.md#compolyx.SphericalSelectionRule.link_path) | Root path of the current node in the tree for links to this object | | [`SphericalSelectionRule.name`](compolyx.SphericalSelectionRule.name.md#compolyx.SphericalSelectionRule.name) | Name of object | | [`SphericalSelectionRule.origin`](compolyx.SphericalSelectionRule.origin.md#compolyx.SphericalSelectionRule.origin) | Origin of the Sphere. | | [`SphericalSelectionRule.origin_in_global_coordinates`](compolyx.SphericalSelectionRule.origin_in_global_coordinates.md#compolyx.SphericalSelectionRule.origin_in_global_coordinates) | Origin of the rule in global coordinates | | [`SphericalSelectionRule.parent`](compolyx.SphericalSelectionRule.parent.md#compolyx.SphericalSelectionRule.parent) | Parent object in tree | | [`SphericalSelectionRule.radius`](compolyx.SphericalSelectionRule.radius.md#compolyx.SphericalSelectionRule.radius) | Sphere Radius | -| [`SphericalSelectionRule.relative_rule_type`](compolyx.SphericalSelectionRule.relative_rule_type.md#compolyx.SphericalSelectionRule.relative_rule_type) | relative type | +| [`SphericalSelectionRule.relative_rule_type`](compolyx.SphericalSelectionRule.relative_rule_type.md#compolyx.SphericalSelectionRule.relative_rule_type) | Relative type | | [`SphericalSelectionRule.root_path`](compolyx.SphericalSelectionRule.root_path.md#compolyx.SphericalSelectionRule.root_path) | Root path of the current node in the tree | | [`SphericalSelectionRule.rosette`](compolyx.SphericalSelectionRule.rosette.md#compolyx.SphericalSelectionRule.rosette) | Rosette of the used for origin and direction | | [`SphericalSelectionRule.status`](compolyx.SphericalSelectionRule.status.md#compolyx.SphericalSelectionRule.status) | Status of the object | | [`SphericalSelectionRule.status_changed`](compolyx.SphericalSelectionRule.status_changed.md#compolyx.SphericalSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | | [`SphericalSelectionRule.uid`](compolyx.SphericalSelectionRule.uid.md#compolyx.SphericalSelectionRule.uid) | UID of object | | [`SphericalSelectionRule.use_global_coordinate_system`](compolyx.SphericalSelectionRule.use_global_coordinate_system.md#compolyx.SphericalSelectionRule.use_global_coordinate_system) | Use global coordinate system for origin and direction | -| [`SphericalSelectionRule.vertex`](compolyx.SphericalSelectionRule.vertex.md#compolyx.SphericalSelectionRule.vertex) | This will throw an error if the object has been removed from the graph. | +| [`SphericalSelectionRule.vertex`](compolyx.SphericalSelectionRule.vertex.md#compolyx.SphericalSelectionRule.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`SphericalSelectionRule.find_parent`](compolyx.SphericalSelectionRule.find_parent.md#compolyx.SphericalSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`SphericalSelectionRule.find_parent`](compolyx.SphericalSelectionRule.find_parent.md#compolyx.SphericalSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`SphericalSelectionRule.get_short_description`](compolyx.SphericalSelectionRule.get_short_description.md#compolyx.SphericalSelectionRule.get_short_description)() | | -| [`SphericalSelectionRule.obj_exists`](compolyx.SphericalSelectionRule.obj_exists.md#compolyx.SphericalSelectionRule.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. | -| [`SphericalSelectionRule.serialize`](compolyx.SphericalSelectionRule.serialize.md#compolyx.SphericalSelectionRule.serialize)() | Serialize to Python string. | -| [`SphericalSelectionRule.serialize_name_and_id`](compolyx.SphericalSelectionRule.serialize_name_and_id.md#compolyx.SphericalSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`SphericalSelectionRule.obj_exists`](compolyx.SphericalSelectionRule.obj_exists.md#compolyx.SphericalSelectionRule.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 | +| [`SphericalSelectionRule.serialize`](compolyx.SphericalSelectionRule.serialize.md#compolyx.SphericalSelectionRule.serialize)() | Serialize to Python string | +| [`SphericalSelectionRule.serialize_name_and_id`](compolyx.SphericalSelectionRule.serialize_name_and_id.md#compolyx.SphericalSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID | | [`SphericalSelectionRule.serialize_rule_types`](compolyx.SphericalSelectionRule.serialize_rule_types.md#compolyx.SphericalSelectionRule.serialize_rule_types)() | | | [`SphericalSelectionRule.update`](compolyx.SphericalSelectionRule.update.md#compolyx.SphericalSelectionRule.update)() | | -| [`SphericalSelectionRule.visit`](compolyx.SphericalSelectionRule.visit.md#compolyx.SphericalSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`SphericalSelectionRule.visit`](compolyx.SphericalSelectionRule.visit.md#compolyx.SphericalSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.obj_exists.md index 6fcf8a68b2..e90ead2b2c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SphericalSelectionRule.obj_exists.md @@ -4,5 +4,5 @@ #### SphericalSelectionRule.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.enabled.md index f3b543e568..fa7099017f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.enabled.md @@ -4,4 +4,4 @@ #### *property* Stackup.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.md index efa7ad5bb2..38b93f9cff 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.md @@ -10,50 +10,50 @@ Class to represent stackup. | Name | Description | |------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`Stackup.active`](compolyx.Stackup.active.md#compolyx.Stackup.active) | active status of object | +| [`Stackup.active`](compolyx.Stackup.active.md#compolyx.Stackup.active) | Active status of object | | [`Stackup.area_price`](compolyx.Stackup.area_price.md#compolyx.Stackup.area_price) | Price per area of the Stackup | | [`Stackup.area_weight`](compolyx.Stackup.area_weight.md#compolyx.Stackup.area_weight) | Area weight of the Stackup | -| [`Stackup.cut_off_material`](compolyx.Stackup.cut_off_material.md#compolyx.Stackup.cut_off_material) | Cut-off material used in cut-off areas of this Stackup. | -| [`Stackup.cut_off_material_handling`](compolyx.Stackup.cut_off_material_handling.md#compolyx.Stackup.cut_off_material_handling) | Type defining how cut-off material is used in cut-off areas of this stackup. | -| [`Stackup.draping_material_model`](compolyx.Stackup.draping_material_model.md#compolyx.Stackup.draping_material_model) | Draping material model. | +| [`Stackup.cut_off_material`](compolyx.Stackup.cut_off_material.md#compolyx.Stackup.cut_off_material) | Cut-off material used in cut-off areas of this Stackup | +| [`Stackup.cut_off_material_handling`](compolyx.Stackup.cut_off_material_handling.md#compolyx.Stackup.cut_off_material_handling) | Type defining how cut-off material is used in cut-off areas of this stackup | +| [`Stackup.draping_material_model`](compolyx.Stackup.draping_material_model.md#compolyx.Stackup.draping_material_model) | Draping material model | | [`Stackup.draping_ud_coefficient`](compolyx.Stackup.draping_ud_coefficient.md#compolyx.Stackup.draping_ud_coefficient) | UD Draping Coefficient | -| [`Stackup.drop_off_material`](compolyx.Stackup.drop_off_material.md#compolyx.Stackup.drop_off_material) | Drop-off material used in drop-off areas of this Stackup. | -| [`Stackup.drop_off_material_handling`](compolyx.Stackup.drop_off_material_handling.md#compolyx.Stackup.drop_off_material_handling) | Type defining how drop-off material is used in drop-off areas of this stackup. | -| [`Stackup.enabled`](compolyx.Stackup.enabled.md#compolyx.Stackup.enabled) | Whether this object is currently enabled or not. | +| [`Stackup.drop_off_material`](compolyx.Stackup.drop_off_material.md#compolyx.Stackup.drop_off_material) | Drop-off material used in drop-off areas of this Stackup | +| [`Stackup.drop_off_material_handling`](compolyx.Stackup.drop_off_material_handling.md#compolyx.Stackup.drop_off_material_handling) | Type defining how drop-off material is used in drop-off areas of this stackup | +| [`Stackup.enabled`](compolyx.Stackup.enabled.md#compolyx.Stackup.enabled) | Whether this object is currently enabled or not | | [`Stackup.fabrics`](compolyx.Stackup.fabrics.md#compolyx.Stackup.fabrics) | Fabrics property of the Stackup | -| [`Stackup.graph_plot`](compolyx.Stackup.graph_plot.md#compolyx.Stackup.graph_plot) | Graph Plot object used to configure 2D plots. | +| [`Stackup.graph_plot`](compolyx.Stackup.graph_plot.md#compolyx.Stackup.graph_plot) | Graph Plot object used to configure 2D plots | | [`Stackup.id`](compolyx.Stackup.id.md#compolyx.Stackup.id) | ID of object | -| [`Stackup.is_dict_item`](compolyx.Stackup.is_dict_item.md#compolyx.Stackup.is_dict_item) | Specifies wether the object is an item of a dict | -| [`Stackup.is_list_item`](compolyx.Stackup.is_list_item.md#compolyx.Stackup.is_list_item) | Specifies wether the object is an item of a list | -| [`Stackup.layup_sequence`](compolyx.Stackup.layup_sequence.md#compolyx.Stackup.layup_sequence) | Layup Sequence of the Stackup can be 'Top-Down' or 'Bottom-Up' | +| [`Stackup.is_dict_item`](compolyx.Stackup.is_dict_item.md#compolyx.Stackup.is_dict_item) | Specifies whether the object is an item of a dict | +| [`Stackup.is_list_item`](compolyx.Stackup.is_list_item.md#compolyx.Stackup.is_list_item) | Specifies whether the object is an item of a list | +| [`Stackup.layup_sequence`](compolyx.Stackup.layup_sequence.md#compolyx.Stackup.layup_sequence) | Layup Sequence of the Stackup. Available options: `Top-Down` or `Bottom-Up` | | [`Stackup.link_path`](compolyx.Stackup.link_path.md#compolyx.Stackup.link_path) | Root path of the current node in the tree for links to this object | | [`Stackup.name`](compolyx.Stackup.name.md#compolyx.Stackup.name) | Name of object | | [`Stackup.parent`](compolyx.Stackup.parent.md#compolyx.Stackup.parent) | Parent object in tree | | [`Stackup.root_path`](compolyx.Stackup.root_path.md#compolyx.Stackup.root_path) | Root path of the current node in the tree | | [`Stackup.status`](compolyx.Stackup.status.md#compolyx.Stackup.status) | Status of the object | -| [`Stackup.status_changed`](compolyx.Stackup.status_changed.md#compolyx.Stackup.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`Stackup.symmetry`](compolyx.Stackup.symmetry.md#compolyx.Stackup.symmetry) | Symmetry of the Stackup can be 'No Symmetry', 'Even Symmetry' or 'Odd Symmetry' | +| [`Stackup.status_changed`](compolyx.Stackup.status_changed.md#compolyx.Stackup.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`Stackup.symmetry`](compolyx.Stackup.symmetry.md#compolyx.Stackup.symmetry) | Symmetry of the Stackup. Available options: `No Symmetry`, `Even Symmetry`, or `Odd Symmetry` | | [`Stackup.thickness`](compolyx.Stackup.thickness.md#compolyx.Stackup.thickness) | Thickness of the Stackup | | [`Stackup.uid`](compolyx.Stackup.uid.md#compolyx.Stackup.uid) | UID of object | -| [`Stackup.vertex`](compolyx.Stackup.vertex.md#compolyx.Stackup.vertex) | This will throw an error if the object has been removed from the graph. | +| [`Stackup.vertex`](compolyx.Stackup.vertex.md#compolyx.Stackup.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`Stackup.add_fabric`](compolyx.Stackup.add_fabric.md#compolyx.Stackup.add_fabric)(fabric[, angle]) | Add fabric at end of fabrics of the stackup. | -| [`Stackup.capture_analysis_plot`](compolyx.Stackup.capture_analysis_plot.md#compolyx.Stackup.capture_analysis_plot)([path, size]) | Saves the 2D polar plot to a file. | -| [`Stackup.clear_fabrics`](compolyx.Stackup.clear_fabrics.md#compolyx.Stackup.clear_fabrics)() | Clear all fabrics. | -| [`Stackup.clt_query`](compolyx.Stackup.clt_query.md#compolyx.Stackup.clt_query)([query]) | Returns the properties of the classical laminate theory. | -| [`Stackup.create_plot`](compolyx.Stackup.create_plot.md#compolyx.Stackup.create_plot)([query, core_scale_factor]) | Generates 2D plots with the results of interest. | -| [`Stackup.find_parent`](compolyx.Stackup.find_parent.md#compolyx.Stackup.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`Stackup.get_ordered_fabrics`](compolyx.Stackup.get_ordered_fabrics.md#compolyx.Stackup.get_ordered_fabrics)() | Returns all fabrics and orientations including symmetry and layup sequence option. | -| [`Stackup.insert_fabric`](compolyx.Stackup.insert_fabric.md#compolyx.Stackup.insert_fabric)(pos, fabric, angle) | Insert fabric at given position. | -| [`Stackup.is_constant`](compolyx.Stackup.is_constant.md#compolyx.Stackup.is_constant)() | Returns true if all engineering constants and strength limits of the assigned fabrics are constant. | -| [`Stackup.obj_exists`](compolyx.Stackup.obj_exists.md#compolyx.Stackup.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. | -| [`Stackup.remove_fabric`](compolyx.Stackup.remove_fabric.md#compolyx.Stackup.remove_fabric)(pos) | Remove fabric from position. | -| [`Stackup.serialize`](compolyx.Stackup.serialize.md#compolyx.Stackup.serialize)() | Serialize to Python string. | -| [`Stackup.serialize_name_and_id`](compolyx.Stackup.serialize_name_and_id.md#compolyx.Stackup.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`Stackup.add_fabric`](compolyx.Stackup.add_fabric.md#compolyx.Stackup.add_fabric)(fabric[, angle]) | Add fabric at end of fabrics of the stackup | +| [`Stackup.capture_analysis_plot`](compolyx.Stackup.capture_analysis_plot.md#compolyx.Stackup.capture_analysis_plot)([path, size]) | Saves the 2D polar plot to a file | +| [`Stackup.clear_fabrics`](compolyx.Stackup.clear_fabrics.md#compolyx.Stackup.clear_fabrics)() | Clear all fabrics | +| [`Stackup.clt_query`](compolyx.Stackup.clt_query.md#compolyx.Stackup.clt_query)([query]) | Returns the properties of the classical laminate theory | +| [`Stackup.create_plot`](compolyx.Stackup.create_plot.md#compolyx.Stackup.create_plot)([query, core_scale_factor]) | Generates 2D plots with the results of interest | +| [`Stackup.find_parent`](compolyx.Stackup.find_parent.md#compolyx.Stackup.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`Stackup.get_ordered_fabrics`](compolyx.Stackup.get_ordered_fabrics.md#compolyx.Stackup.get_ordered_fabrics)() | Returns all fabrics and orientations including symmetry and layup sequence option | +| [`Stackup.insert_fabric`](compolyx.Stackup.insert_fabric.md#compolyx.Stackup.insert_fabric)(pos, fabric, angle) | Insert fabric at given position | +| [`Stackup.is_constant`](compolyx.Stackup.is_constant.md#compolyx.Stackup.is_constant)() | Returns true if all engineering constants and strength limits of the assigned fabrics are constant | +| [`Stackup.obj_exists`](compolyx.Stackup.obj_exists.md#compolyx.Stackup.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 | +| [`Stackup.remove_fabric`](compolyx.Stackup.remove_fabric.md#compolyx.Stackup.remove_fabric)(pos) | Remove fabric from position | +| [`Stackup.serialize`](compolyx.Stackup.serialize.md#compolyx.Stackup.serialize)() | Serialize to Python string | +| [`Stackup.serialize_name_and_id`](compolyx.Stackup.serialize_name_and_id.md#compolyx.Stackup.serialize_name_and_id)() | Helper function to serialize name and ID | | [`Stackup.update`](compolyx.Stackup.update.md#compolyx.Stackup.update)() | | -| [`Stackup.update_plot`](compolyx.Stackup.update_plot.md#compolyx.Stackup.update_plot)() | updates the data of the 2D plot. | -| [`Stackup.visit`](compolyx.Stackup.visit.md#compolyx.Stackup.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`Stackup.update_plot`](compolyx.Stackup.update_plot.md#compolyx.Stackup.update_plot)() | updates the data of the 2D plot | +| [`Stackup.visit`](compolyx.Stackup.visit.md#compolyx.Stackup.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.symmetry.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.symmetry.md index 1f53db97bb..8366a15869 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.symmetry.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.Stackup.symmetry.md @@ -4,4 +4,4 @@ #### *property* Stackup.symmetry -Symmetry of the Stackup can be ‘No Symmetry’, ‘Even Symmetry’ or ‘Odd Symmetry’ +Symmetry of the Stackup. Available options: ‘No Symmetry’, ‘Even Symmetry’ and ‘Odd Symmetry’. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.enabled.md index c3a9e875bc..58b6c96c3d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.enabled.md @@ -4,4 +4,4 @@ #### *property* SubLaminate.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.is_dict_item.md index e5ba1a523f..22f0e79bd4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* SubLaminate.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.is_list_item.md index a37be47f59..7af4e4ff9a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.is_list_item.md @@ -4,4 +4,4 @@ #### *property* SubLaminate.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.layup_sequence.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.layup_sequence.md index c4e67e672d..7f50076634 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.layup_sequence.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.layup_sequence.md @@ -4,4 +4,4 @@ #### *property* SubLaminate.layup_sequence -Layup Sequence of the Sub Laminate can be ‘Top-Down’ or ‘Bottom-Up’ +Layup Sequence of the Sub Laminate. Available options: ‘Top-Down’ or ‘Bottom-Up’ diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.md index 9b6652fb0d..9eb4ccf499 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.md @@ -10,45 +10,45 @@ Class to represent sublaminate. | Name | Description | |------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| -| [`SubLaminate.active`](compolyx.SubLaminate.active.md#compolyx.SubLaminate.active) | active status of object | +| [`SubLaminate.active`](compolyx.SubLaminate.active.md#compolyx.SubLaminate.active) | Active status of object | | [`SubLaminate.area_price`](compolyx.SubLaminate.area_price.md#compolyx.SubLaminate.area_price) | Price per area of the Sub Laminate | | [`SubLaminate.area_weight`](compolyx.SubLaminate.area_weight.md#compolyx.SubLaminate.area_weight) | Area weight of the Sub Laminate | -| [`SubLaminate.enabled`](compolyx.SubLaminate.enabled.md#compolyx.SubLaminate.enabled) | Whether this object is currently enabled or not. | +| [`SubLaminate.enabled`](compolyx.SubLaminate.enabled.md#compolyx.SubLaminate.enabled) | Whether this object is currently enabled or not | | [`SubLaminate.fabrics`](compolyx.SubLaminate.fabrics.md#compolyx.SubLaminate.fabrics) | Fabrics property of the Sub Laminate | -| [`SubLaminate.graph_plot`](compolyx.SubLaminate.graph_plot.md#compolyx.SubLaminate.graph_plot) | Graph Plot object used to configure 2D plots. | +| [`SubLaminate.graph_plot`](compolyx.SubLaminate.graph_plot.md#compolyx.SubLaminate.graph_plot) | Graph Plot object used to configure 2D plots | | [`SubLaminate.id`](compolyx.SubLaminate.id.md#compolyx.SubLaminate.id) | ID of object | -| [`SubLaminate.is_dict_item`](compolyx.SubLaminate.is_dict_item.md#compolyx.SubLaminate.is_dict_item) | Specifies wether the object is an item of a dict | -| [`SubLaminate.is_list_item`](compolyx.SubLaminate.is_list_item.md#compolyx.SubLaminate.is_list_item) | Specifies wether the object is an item of a list | -| [`SubLaminate.layup_sequence`](compolyx.SubLaminate.layup_sequence.md#compolyx.SubLaminate.layup_sequence) | Layup Sequence of the Sub Laminate can be 'Top-Down' or 'Bottom-Up' | +| [`SubLaminate.is_dict_item`](compolyx.SubLaminate.is_dict_item.md#compolyx.SubLaminate.is_dict_item) | Specifies whether the object is an item of a dict | +| [`SubLaminate.is_list_item`](compolyx.SubLaminate.is_list_item.md#compolyx.SubLaminate.is_list_item) | Specifies whether the object is an item of a list | +| [`SubLaminate.layup_sequence`](compolyx.SubLaminate.layup_sequence.md#compolyx.SubLaminate.layup_sequence) | Layup Sequence of the Sub Laminate. Available options: `Top-Down` or `Bottom-Up` | | [`SubLaminate.link_path`](compolyx.SubLaminate.link_path.md#compolyx.SubLaminate.link_path) | Root path of the current node in the tree for links to this object | | [`SubLaminate.name`](compolyx.SubLaminate.name.md#compolyx.SubLaminate.name) | Name of object | | [`SubLaminate.parent`](compolyx.SubLaminate.parent.md#compolyx.SubLaminate.parent) | Parent object in tree | | [`SubLaminate.root_path`](compolyx.SubLaminate.root_path.md#compolyx.SubLaminate.root_path) | Root path of the current node in the tree | | [`SubLaminate.status`](compolyx.SubLaminate.status.md#compolyx.SubLaminate.status) | Status of the object | -| [`SubLaminate.status_changed`](compolyx.SubLaminate.status_changed.md#compolyx.SubLaminate.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`SubLaminate.symmetry`](compolyx.SubLaminate.symmetry.md#compolyx.SubLaminate.symmetry) | Symmetry of the Sub Laminate can be 'No Symmetry', 'Even Symmetry' or 'Odd Symmetry' | +| [`SubLaminate.status_changed`](compolyx.SubLaminate.status_changed.md#compolyx.SubLaminate.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`SubLaminate.symmetry`](compolyx.SubLaminate.symmetry.md#compolyx.SubLaminate.symmetry) | Symmetry of the Sub Laminate. Available options: `No Symmetry`, `Even Symmetry`, or `Odd Symmetry` | | [`SubLaminate.thickness`](compolyx.SubLaminate.thickness.md#compolyx.SubLaminate.thickness) | Thickness of the Sub Laminate | | [`SubLaminate.uid`](compolyx.SubLaminate.uid.md#compolyx.SubLaminate.uid) | UID of object | -| [`SubLaminate.vertex`](compolyx.SubLaminate.vertex.md#compolyx.SubLaminate.vertex) | This will throw an error if the object has been removed from the graph. | +| [`SubLaminate.vertex`](compolyx.SubLaminate.vertex.md#compolyx.SubLaminate.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`SubLaminate.add_fabric`](compolyx.SubLaminate.add_fabric.md#compolyx.SubLaminate.add_fabric)(fabric[, angle]) | Add fabric at end of fabrics list. | -| [`SubLaminate.capture_analysis_plot`](compolyx.SubLaminate.capture_analysis_plot.md#compolyx.SubLaminate.capture_analysis_plot)([path, size]) | Saves the 2D polar plot to a file. | -| [`SubLaminate.clear_fabrics`](compolyx.SubLaminate.clear_fabrics.md#compolyx.SubLaminate.clear_fabrics)() | Clear all fabrics. | -| [`SubLaminate.clt_query`](compolyx.SubLaminate.clt_query.md#compolyx.SubLaminate.clt_query)([query]) | Returns the properties of the classical laminate theory. | -| [`SubLaminate.create_plot`](compolyx.SubLaminate.create_plot.md#compolyx.SubLaminate.create_plot)([query, ...]) | Generates 2D plots with the results of interest. | -| [`SubLaminate.find_parent`](compolyx.SubLaminate.find_parent.md#compolyx.SubLaminate.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`SubLaminate.get_ordered_fabrics`](compolyx.SubLaminate.get_ordered_fabrics.md#compolyx.SubLaminate.get_ordered_fabrics)() | Returns a list with all sub-materials (fabrics and stackups) and orientations including symmetry and layup sequence option. | -| [`SubLaminate.get_ordered_sub_materials`](compolyx.SubLaminate.get_ordered_sub_materials.md#compolyx.SubLaminate.get_ordered_sub_materials)() | Returns a list with all fabrics and orientations including symmetry and layup sequence option. | -| [`SubLaminate.insert_fabric`](compolyx.SubLaminate.insert_fabric.md#compolyx.SubLaminate.insert_fabric)(pos, fabric, angle) | Insert fabric at given position. | -| [`SubLaminate.is_constant`](compolyx.SubLaminate.is_constant.md#compolyx.SubLaminate.is_constant)() | Returns true if all engineering constants and strength limits of the assigned fabrics are constant. | -| [`SubLaminate.obj_exists`](compolyx.SubLaminate.obj_exists.md#compolyx.SubLaminate.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. | -| [`SubLaminate.remove_fabric`](compolyx.SubLaminate.remove_fabric.md#compolyx.SubLaminate.remove_fabric)(pos) | Remove fabric from position. | -| [`SubLaminate.serialize`](compolyx.SubLaminate.serialize.md#compolyx.SubLaminate.serialize)() | Serialize to Python string. | -| [`SubLaminate.serialize_name_and_id`](compolyx.SubLaminate.serialize_name_and_id.md#compolyx.SubLaminate.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`SubLaminate.add_fabric`](compolyx.SubLaminate.add_fabric.md#compolyx.SubLaminate.add_fabric)(fabric[, angle]) | Add fabric at end of fabrics list | +| [`SubLaminate.capture_analysis_plot`](compolyx.SubLaminate.capture_analysis_plot.md#compolyx.SubLaminate.capture_analysis_plot)([path, size]) | Saves the 2D polar plot to a file | +| [`SubLaminate.clear_fabrics`](compolyx.SubLaminate.clear_fabrics.md#compolyx.SubLaminate.clear_fabrics)() | Clear all fabrics | +| [`SubLaminate.clt_query`](compolyx.SubLaminate.clt_query.md#compolyx.SubLaminate.clt_query)([query]) | Returns the properties of the classical laminate theory | +| [`SubLaminate.create_plot`](compolyx.SubLaminate.create_plot.md#compolyx.SubLaminate.create_plot)([query, ...]) | Generates 2D plots with the results of interest | +| [`SubLaminate.find_parent`](compolyx.SubLaminate.find_parent.md#compolyx.SubLaminate.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`SubLaminate.get_ordered_fabrics`](compolyx.SubLaminate.get_ordered_fabrics.md#compolyx.SubLaminate.get_ordered_fabrics)() | Returns a list with all sub-materials (fabrics and stackups) and orientations including symmetry and layup sequence option | +| [`SubLaminate.get_ordered_sub_materials`](compolyx.SubLaminate.get_ordered_sub_materials.md#compolyx.SubLaminate.get_ordered_sub_materials)() | Returns a list with all fabrics and orientations including symmetry and layup sequence option | +| [`SubLaminate.insert_fabric`](compolyx.SubLaminate.insert_fabric.md#compolyx.SubLaminate.insert_fabric)(pos, fabric, angle) | Insert fabric at given position | +| [`SubLaminate.is_constant`](compolyx.SubLaminate.is_constant.md#compolyx.SubLaminate.is_constant)() | Returns true if all engineering constants and strength limits of the assigned fabrics are constant | +| [`SubLaminate.obj_exists`](compolyx.SubLaminate.obj_exists.md#compolyx.SubLaminate.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 | +| [`SubLaminate.remove_fabric`](compolyx.SubLaminate.remove_fabric.md#compolyx.SubLaminate.remove_fabric)(pos) | Remove fabric from position | +| [`SubLaminate.serialize`](compolyx.SubLaminate.serialize.md#compolyx.SubLaminate.serialize)() | Serialize to Python string | +| [`SubLaminate.serialize_name_and_id`](compolyx.SubLaminate.serialize_name_and_id.md#compolyx.SubLaminate.serialize_name_and_id)() | Helper function to serialize name and ID | | [`SubLaminate.update`](compolyx.SubLaminate.update.md#compolyx.SubLaminate.update)() | | -| [`SubLaminate.update_plot`](compolyx.SubLaminate.update_plot.md#compolyx.SubLaminate.update_plot)() | Updates the data of the 2D plot. | -| [`SubLaminate.visit`](compolyx.SubLaminate.visit.md#compolyx.SubLaminate.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`SubLaminate.update_plot`](compolyx.SubLaminate.update_plot.md#compolyx.SubLaminate.update_plot)() | Updates the data of the 2D plot | +| [`SubLaminate.visit`](compolyx.SubLaminate.visit.md#compolyx.SubLaminate.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.obj_exists.md index a87d59b7c2..6932c59396 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.obj_exists.md @@ -4,5 +4,5 @@ #### SubLaminate.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.symmetry.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.symmetry.md index 86ac717433..9538dd203b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.symmetry.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.SubLaminate.symmetry.md @@ -4,4 +4,4 @@ #### *property* SubLaminate.symmetry -Symmetry of the Sub Laminate can be ‘No Symmetry’, ‘Even Symmetry’ or ‘Odd Symmetry’ +Symmetry of the Sub Laminate. Available options: ‘No Symmetry’, ‘Even Symmetry’ or ‘Odd Symmetry’ diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.enabled.md index 96e785c50f..563b60c339 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.enabled.md @@ -4,4 +4,4 @@ #### *property* TubeSelectionRule.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.is_dict_item.md index f42e5d94ff..51c5772494 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* TubeSelectionRule.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.is_list_item.md index 85029f7862..5e4af0a27a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.is_list_item.md @@ -4,4 +4,4 @@ #### *property* TubeSelectionRule.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.md index 2a8fb45254..1b452112b4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.md @@ -10,46 +10,46 @@ Tube selection rule. | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`TubeSelectionRule.active`](compolyx.TubeSelectionRule.active.md#compolyx.TubeSelectionRule.active) | active status of object | +| [`TubeSelectionRule.active`](compolyx.TubeSelectionRule.active.md#compolyx.TubeSelectionRule.active) | Active status of object | | [`TubeSelectionRule.changed`](compolyx.TubeSelectionRule.changed.md#compolyx.TubeSelectionRule.changed) | Triggers Observable to dispatch changed message | | [`TubeSelectionRule.display_data`](compolyx.TubeSelectionRule.display_data.md#compolyx.TubeSelectionRule.display_data) | The tube rule mesh plot | | [`TubeSelectionRule.edge_set`](compolyx.TubeSelectionRule.edge_set.md#compolyx.TubeSelectionRule.edge_set) | Edge Set for the Tube Selection Rule | -| [`TubeSelectionRule.enabled`](compolyx.TubeSelectionRule.enabled.md#compolyx.TubeSelectionRule.enabled) | Whether this object is currently enabled or not. | +| [`TubeSelectionRule.enabled`](compolyx.TubeSelectionRule.enabled.md#compolyx.TubeSelectionRule.enabled) | Whether this object is currently enabled or not | | [`TubeSelectionRule.extend_endings`](compolyx.TubeSelectionRule.extend_endings.md#compolyx.TubeSelectionRule.extend_endings) | Whether to extend the ending of the edge. | -| [`TubeSelectionRule.extent`](compolyx.TubeSelectionRule.extent.md#compolyx.TubeSelectionRule.extent) | extent of the rule | -| [`TubeSelectionRule.head`](compolyx.TubeSelectionRule.head.md#compolyx.TubeSelectionRule.head) | Defines the head of the tube. | -| [`TubeSelectionRule.head_extension`](compolyx.TubeSelectionRule.head_extension.md#compolyx.TubeSelectionRule.head_extension) | Specifies the length of the extension at the head of the tube. | +| [`TubeSelectionRule.extent`](compolyx.TubeSelectionRule.extent.md#compolyx.TubeSelectionRule.extent) | Extent of the rule | +| [`TubeSelectionRule.head`](compolyx.TubeSelectionRule.head.md#compolyx.TubeSelectionRule.head) | Defines the head of the tube | +| [`TubeSelectionRule.head_extension`](compolyx.TubeSelectionRule.head_extension.md#compolyx.TubeSelectionRule.head_extension) | Specifies the length of the extension at the head of the tube | | [`TubeSelectionRule.id`](compolyx.TubeSelectionRule.id.md#compolyx.TubeSelectionRule.id) | ID of object | -| [`TubeSelectionRule.include_rule_type`](compolyx.TubeSelectionRule.include_rule_type.md#compolyx.TubeSelectionRule.include_rule_type) | include type | +| [`TubeSelectionRule.include_rule_type`](compolyx.TubeSelectionRule.include_rule_type.md#compolyx.TubeSelectionRule.include_rule_type) | Include type | | [`TubeSelectionRule.inner_radius`](compolyx.TubeSelectionRule.inner_radius.md#compolyx.TubeSelectionRule.inner_radius) | Inner tube-radius | -| [`TubeSelectionRule.is_closed`](compolyx.TubeSelectionRule.is_closed.md#compolyx.TubeSelectionRule.is_closed) | Returns true if the edge set of this rule is closed. | -| [`TubeSelectionRule.is_dict_item`](compolyx.TubeSelectionRule.is_dict_item.md#compolyx.TubeSelectionRule.is_dict_item) | Specifies wether the object is an item of a dict | -| [`TubeSelectionRule.is_list_item`](compolyx.TubeSelectionRule.is_list_item.md#compolyx.TubeSelectionRule.is_list_item) | Specifies wether the object is an item of a list | +| [`TubeSelectionRule.is_closed`](compolyx.TubeSelectionRule.is_closed.md#compolyx.TubeSelectionRule.is_closed) | Returns true if the edge set of this rule is closed | +| [`TubeSelectionRule.is_dict_item`](compolyx.TubeSelectionRule.is_dict_item.md#compolyx.TubeSelectionRule.is_dict_item) | Specifies whether the object is an item of a dict | +| [`TubeSelectionRule.is_list_item`](compolyx.TubeSelectionRule.is_list_item.md#compolyx.TubeSelectionRule.is_list_item) | Specifies whether the object is an item of a list | | [`TubeSelectionRule.link_path`](compolyx.TubeSelectionRule.link_path.md#compolyx.TubeSelectionRule.link_path) | Root path of the current node in the tree for links to this object | | [`TubeSelectionRule.mesh`](compolyx.TubeSelectionRule.mesh.md#compolyx.TubeSelectionRule.mesh) | The mesh of the tube rule | | [`TubeSelectionRule.name`](compolyx.TubeSelectionRule.name.md#compolyx.TubeSelectionRule.name) | Name of object | -| [`TubeSelectionRule.nodes`](compolyx.TubeSelectionRule.nodes.md#compolyx.TubeSelectionRule.nodes) | Returns the nodes of this tube as nx3 array including the extensions. | +| [`TubeSelectionRule.nodes`](compolyx.TubeSelectionRule.nodes.md#compolyx.TubeSelectionRule.nodes) | Returns the nodes of this tube as nx3 array including the extensions | | [`TubeSelectionRule.outer_radius`](compolyx.TubeSelectionRule.outer_radius.md#compolyx.TubeSelectionRule.outer_radius) | Outer tube-radius | | [`TubeSelectionRule.parent`](compolyx.TubeSelectionRule.parent.md#compolyx.TubeSelectionRule.parent) | Parent object in tree | -| [`TubeSelectionRule.relative_rule_type`](compolyx.TubeSelectionRule.relative_rule_type.md#compolyx.TubeSelectionRule.relative_rule_type) | relative type | +| [`TubeSelectionRule.relative_rule_type`](compolyx.TubeSelectionRule.relative_rule_type.md#compolyx.TubeSelectionRule.relative_rule_type) | Relative type | | [`TubeSelectionRule.root_path`](compolyx.TubeSelectionRule.root_path.md#compolyx.TubeSelectionRule.root_path) | Root path of the current node in the tree | | [`TubeSelectionRule.status`](compolyx.TubeSelectionRule.status.md#compolyx.TubeSelectionRule.status) | Status of the object | -| [`TubeSelectionRule.status_changed`](compolyx.TubeSelectionRule.status_changed.md#compolyx.TubeSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`TubeSelectionRule.symmetrical_extension`](compolyx.TubeSelectionRule.symmetrical_extension.md#compolyx.TubeSelectionRule.symmetrical_extension) | Whether the extensions are equal on both ends or not. | -| [`TubeSelectionRule.tail_extension`](compolyx.TubeSelectionRule.tail_extension.md#compolyx.TubeSelectionRule.tail_extension) | Specifies the length of the extension at the tail of the the tube. | +| [`TubeSelectionRule.status_changed`](compolyx.TubeSelectionRule.status_changed.md#compolyx.TubeSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`TubeSelectionRule.symmetrical_extension`](compolyx.TubeSelectionRule.symmetrical_extension.md#compolyx.TubeSelectionRule.symmetrical_extension) | Whether the extensions are equal on both ends or not | +| [`TubeSelectionRule.tail_extension`](compolyx.TubeSelectionRule.tail_extension.md#compolyx.TubeSelectionRule.tail_extension) | Specifies the length of the extension at the tail of the the tube | | [`TubeSelectionRule.uid`](compolyx.TubeSelectionRule.uid.md#compolyx.TubeSelectionRule.uid) | UID of object | -| [`TubeSelectionRule.vertex`](compolyx.TubeSelectionRule.vertex.md#compolyx.TubeSelectionRule.vertex) | This will throw an error if the object has been removed from the graph. | +| [`TubeSelectionRule.vertex`](compolyx.TubeSelectionRule.vertex.md#compolyx.TubeSelectionRule.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`TubeSelectionRule.find_parent`](compolyx.TubeSelectionRule.find_parent.md#compolyx.TubeSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`TubeSelectionRule.get_nodes`](compolyx.TubeSelectionRule.get_nodes.md#compolyx.TubeSelectionRule.get_nodes)() | * **Return:**
List of nodes that define the central line of the tube. | +| [`TubeSelectionRule.find_parent`](compolyx.TubeSelectionRule.find_parent.md#compolyx.TubeSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`TubeSelectionRule.get_nodes`](compolyx.TubeSelectionRule.get_nodes.md#compolyx.TubeSelectionRule.get_nodes)() | * **Return:**
List of nodes that define the central line of the tube | | [`TubeSelectionRule.get_short_description`](compolyx.TubeSelectionRule.get_short_description.md#compolyx.TubeSelectionRule.get_short_description)() | | -| [`TubeSelectionRule.obj_exists`](compolyx.TubeSelectionRule.obj_exists.md#compolyx.TubeSelectionRule.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. | -| [`TubeSelectionRule.serialize`](compolyx.TubeSelectionRule.serialize.md#compolyx.TubeSelectionRule.serialize)() | Serialize to Python string. | -| [`TubeSelectionRule.serialize_name_and_id`](compolyx.TubeSelectionRule.serialize_name_and_id.md#compolyx.TubeSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`TubeSelectionRule.obj_exists`](compolyx.TubeSelectionRule.obj_exists.md#compolyx.TubeSelectionRule.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 | +| [`TubeSelectionRule.serialize`](compolyx.TubeSelectionRule.serialize.md#compolyx.TubeSelectionRule.serialize)() | Serialize to Python string | +| [`TubeSelectionRule.serialize_name_and_id`](compolyx.TubeSelectionRule.serialize_name_and_id.md#compolyx.TubeSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID | | [`TubeSelectionRule.serialize_rule_types`](compolyx.TubeSelectionRule.serialize_rule_types.md#compolyx.TubeSelectionRule.serialize_rule_types)() | | | [`TubeSelectionRule.update`](compolyx.TubeSelectionRule.update.md#compolyx.TubeSelectionRule.update)() | | -| [`TubeSelectionRule.visit`](compolyx.TubeSelectionRule.visit.md#compolyx.TubeSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`TubeSelectionRule.visit`](compolyx.TubeSelectionRule.visit.md#compolyx.TubeSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.obj_exists.md index 64e27ac16e..2db6080071 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.TubeSelectionRule.obj_exists.md @@ -4,5 +4,5 @@ #### TubeSelectionRule.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.enabled.md index bc3b4da556..bc76ae0fa4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.enabled.md @@ -4,4 +4,4 @@ #### *property* VariableOffsetSelectionRule.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.is_dict_item.md index dcaf82713d..331c6a31f6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* VariableOffsetSelectionRule.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.is_list_item.md index 6089344adb..168741e307 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.is_list_item.md @@ -4,4 +4,4 @@ #### *property* VariableOffsetSelectionRule.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.md index f6b2e8dbdb..83aff9c93e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.md @@ -8,19 +8,19 @@ | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`VariableOffsetSelectionRule.active`](compolyx.VariableOffsetSelectionRule.active.md#compolyx.VariableOffsetSelectionRule.active) | active status of object | +| [`VariableOffsetSelectionRule.active`](compolyx.VariableOffsetSelectionRule.active.md#compolyx.VariableOffsetSelectionRule.active) | Active status of object | | [`VariableOffsetSelectionRule.angles`](compolyx.VariableOffsetSelectionRule.angles.md#compolyx.VariableOffsetSelectionRule.angles) | Link to lookup table column with taper angles | | [`VariableOffsetSelectionRule.changed`](compolyx.VariableOffsetSelectionRule.changed.md#compolyx.VariableOffsetSelectionRule.changed) | Triggers Observable to dispatch changed message | | [`VariableOffsetSelectionRule.distance_along_edge`](compolyx.VariableOffsetSelectionRule.distance_along_edge.md#compolyx.VariableOffsetSelectionRule.distance_along_edge) | Whether to evaluate the distance along the edge or direction of the rule | | [`VariableOffsetSelectionRule.edge_set`](compolyx.VariableOffsetSelectionRule.edge_set.md#compolyx.VariableOffsetSelectionRule.edge_set) | Link to edge set | -| [`VariableOffsetSelectionRule.element_set`](compolyx.VariableOffsetSelectionRule.element_set.md#compolyx.VariableOffsetSelectionRule.element_set) | The element set on which the rule is applied. | -| [`VariableOffsetSelectionRule.enabled`](compolyx.VariableOffsetSelectionRule.enabled.md#compolyx.VariableOffsetSelectionRule.enabled) | Whether this object is currently enabled or not. | -| [`VariableOffsetSelectionRule.extent`](compolyx.VariableOffsetSelectionRule.extent.md#compolyx.VariableOffsetSelectionRule.extent) | extent of the rule | +| [`VariableOffsetSelectionRule.element_set`](compolyx.VariableOffsetSelectionRule.element_set.md#compolyx.VariableOffsetSelectionRule.element_set) | The element set on which the rule is applied | +| [`VariableOffsetSelectionRule.enabled`](compolyx.VariableOffsetSelectionRule.enabled.md#compolyx.VariableOffsetSelectionRule.enabled) | Whether this object is currently enabled or not | +| [`VariableOffsetSelectionRule.extent`](compolyx.VariableOffsetSelectionRule.extent.md#compolyx.VariableOffsetSelectionRule.extent) | Extent of the rule | | [`VariableOffsetSelectionRule.id`](compolyx.VariableOffsetSelectionRule.id.md#compolyx.VariableOffsetSelectionRule.id) | ID of object | -| [`VariableOffsetSelectionRule.include_rule_type`](compolyx.VariableOffsetSelectionRule.include_rule_type.md#compolyx.VariableOffsetSelectionRule.include_rule_type) | include type | -| [`VariableOffsetSelectionRule.inherit_from_lookup_table`](compolyx.VariableOffsetSelectionRule.inherit_from_lookup_table.md#compolyx.VariableOffsetSelectionRule.inherit_from_lookup_table) | Whether to inherit the Look-Up Table object properties. | -| [`VariableOffsetSelectionRule.is_dict_item`](compolyx.VariableOffsetSelectionRule.is_dict_item.md#compolyx.VariableOffsetSelectionRule.is_dict_item) | Specifies wether the object is an item of a dict | -| [`VariableOffsetSelectionRule.is_list_item`](compolyx.VariableOffsetSelectionRule.is_list_item.md#compolyx.VariableOffsetSelectionRule.is_list_item) | Specifies wether the object is an item of a list | +| [`VariableOffsetSelectionRule.include_rule_type`](compolyx.VariableOffsetSelectionRule.include_rule_type.md#compolyx.VariableOffsetSelectionRule.include_rule_type) | Include type | +| [`VariableOffsetSelectionRule.inherit_from_lookup_table`](compolyx.VariableOffsetSelectionRule.inherit_from_lookup_table.md#compolyx.VariableOffsetSelectionRule.inherit_from_lookup_table) | Whether to inherit the Look-Up Table object properties | +| [`VariableOffsetSelectionRule.is_dict_item`](compolyx.VariableOffsetSelectionRule.is_dict_item.md#compolyx.VariableOffsetSelectionRule.is_dict_item) | Specifies whether the object is an item of a dict | +| [`VariableOffsetSelectionRule.is_list_item`](compolyx.VariableOffsetSelectionRule.is_list_item.md#compolyx.VariableOffsetSelectionRule.is_list_item) | Specifies whether the object is an item of a list | | [`VariableOffsetSelectionRule.link_path`](compolyx.VariableOffsetSelectionRule.link_path.md#compolyx.VariableOffsetSelectionRule.link_path) | Root path of the current node in the tree for links to this object | | [`VariableOffsetSelectionRule.name`](compolyx.VariableOffsetSelectionRule.name.md#compolyx.VariableOffsetSelectionRule.name) | Name of object | | [`VariableOffsetSelectionRule.offsets`](compolyx.VariableOffsetSelectionRule.offsets.md#compolyx.VariableOffsetSelectionRule.offsets) | Link to lookup table column with offsets | @@ -30,20 +30,20 @@ | [`VariableOffsetSelectionRule.relative_rule_type`](compolyx.VariableOffsetSelectionRule.relative_rule_type.md#compolyx.VariableOffsetSelectionRule.relative_rule_type) | relative type | | [`VariableOffsetSelectionRule.root_path`](compolyx.VariableOffsetSelectionRule.root_path.md#compolyx.VariableOffsetSelectionRule.root_path) | Root path of the current node in the tree | | [`VariableOffsetSelectionRule.status`](compolyx.VariableOffsetSelectionRule.status.md#compolyx.VariableOffsetSelectionRule.status) | Status of the object | -| [`VariableOffsetSelectionRule.status_changed`](compolyx.VariableOffsetSelectionRule.status_changed.md#compolyx.VariableOffsetSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`VariableOffsetSelectionRule.status_changed`](compolyx.VariableOffsetSelectionRule.status_changed.md#compolyx.VariableOffsetSelectionRule.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`VariableOffsetSelectionRule.uid`](compolyx.VariableOffsetSelectionRule.uid.md#compolyx.VariableOffsetSelectionRule.uid) | UID of object | | [`VariableOffsetSelectionRule.use_offset_correction`](compolyx.VariableOffsetSelectionRule.use_offset_correction.md#compolyx.VariableOffsetSelectionRule.use_offset_correction) | Use offset correction on mesh | -| [`VariableOffsetSelectionRule.vertex`](compolyx.VariableOffsetSelectionRule.vertex.md#compolyx.VariableOffsetSelectionRule.vertex) | This will throw an error if the object has been removed from the graph. | +| [`VariableOffsetSelectionRule.vertex`](compolyx.VariableOffsetSelectionRule.vertex.md#compolyx.VariableOffsetSelectionRule.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`VariableOffsetSelectionRule.find_parent`](compolyx.VariableOffsetSelectionRule.find_parent.md#compolyx.VariableOffsetSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`VariableOffsetSelectionRule.find_parent`](compolyx.VariableOffsetSelectionRule.find_parent.md#compolyx.VariableOffsetSelectionRule.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`VariableOffsetSelectionRule.get_short_description`](compolyx.VariableOffsetSelectionRule.get_short_description.md#compolyx.VariableOffsetSelectionRule.get_short_description)() | | -| [`VariableOffsetSelectionRule.obj_exists`](compolyx.VariableOffsetSelectionRule.obj_exists.md#compolyx.VariableOffsetSelectionRule.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. | -| [`VariableOffsetSelectionRule.serialize`](compolyx.VariableOffsetSelectionRule.serialize.md#compolyx.VariableOffsetSelectionRule.serialize)() | Serialize to Python string. | -| [`VariableOffsetSelectionRule.serialize_name_and_id`](compolyx.VariableOffsetSelectionRule.serialize_name_and_id.md#compolyx.VariableOffsetSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`VariableOffsetSelectionRule.obj_exists`](compolyx.VariableOffsetSelectionRule.obj_exists.md#compolyx.VariableOffsetSelectionRule.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 | +| [`VariableOffsetSelectionRule.serialize`](compolyx.VariableOffsetSelectionRule.serialize.md#compolyx.VariableOffsetSelectionRule.serialize)() | Serialize to Python string | +| [`VariableOffsetSelectionRule.serialize_name_and_id`](compolyx.VariableOffsetSelectionRule.serialize_name_and_id.md#compolyx.VariableOffsetSelectionRule.serialize_name_and_id)() | Helper function to serialize name and ID | | [`VariableOffsetSelectionRule.serialize_rule_types`](compolyx.VariableOffsetSelectionRule.serialize_rule_types.md#compolyx.VariableOffsetSelectionRule.serialize_rule_types)() | | | [`VariableOffsetSelectionRule.update`](compolyx.VariableOffsetSelectionRule.update.md#compolyx.VariableOffsetSelectionRule.update)() | | -| [`VariableOffsetSelectionRule.visit`](compolyx.VariableOffsetSelectionRule.visit.md#compolyx.VariableOffsetSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`VariableOffsetSelectionRule.visit`](compolyx.VariableOffsetSelectionRule.visit.md#compolyx.VariableOffsetSelectionRule.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.obj_exists.md index 2941621a70..55dcd60b47 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.obj_exists.md @@ -4,5 +4,5 @@ #### VariableOffsetSelectionRule.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.visit.md index b198474cb8..3ce6774383 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VariableOffsetSelectionRule.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.View.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.View.is_dict_item.md index 4bf7822472..56869ebb52 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.View.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.View.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* View.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.View.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.View.is_list_item.md index 3a3a51eeea..ab09fe1977 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.View.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.View.is_list_item.md @@ -4,4 +4,4 @@ #### *property* View.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.View.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.View.md index 3e4ddb742f..f2419f8360 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.View.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.View.md @@ -18,23 +18,23 @@ Access: | Name | Description | |---------------------------------------------------------------------------------------|--------------------------------------------------------------------| -| [`View.is_dict_item`](compolyx.View.is_dict_item.md#compolyx.View.is_dict_item) | Specifies wether the object is an item of a dict | -| [`View.is_list_item`](compolyx.View.is_list_item.md#compolyx.View.is_list_item) | Specifies wether the object is an item of a list | +| [`View.is_dict_item`](compolyx.View.is_dict_item.md#compolyx.View.is_dict_item) | Specifies whether the object is an item of a dict | +| [`View.is_list_item`](compolyx.View.is_list_item.md#compolyx.View.is_list_item) | Specifies whether the object is an item of a list | | [`View.link_path`](compolyx.View.link_path.md#compolyx.View.link_path) | Root path of the current node in the tree for links to this object | -| [`View.locked`](compolyx.View.locked.md#compolyx.View.locked) | A View which is imported from an other source can not be modified. | +| [`View.locked`](compolyx.View.locked.md#compolyx.View.locked) | A View which is imported from an other source can not be modified | | [`View.name`](compolyx.View.name.md#compolyx.View.name) | Name of object | | [`View.orientation`](compolyx.View.orientation.md#compolyx.View.orientation) | Get/set the view orientation | -| [`View.parallel_scale`](compolyx.View.parallel_scale.md#compolyx.View.parallel_scale) | Get/set the view parallel perspective scale factor. | +| [`View.parallel_scale`](compolyx.View.parallel_scale.md#compolyx.View.parallel_scale) | Get/set the view parallel perspective scale factor | | [`View.parent`](compolyx.View.parent.md#compolyx.View.parent) | Parent object in tree | | [`View.position`](compolyx.View.position.md#compolyx.View.position) | Get/set the view position | | [`View.projection`](compolyx.View.projection.md#compolyx.View.projection) | Get/set the projection method parallel or perspective | | [`View.root_path`](compolyx.View.root_path.md#compolyx.View.root_path) | Root path of the current node in the tree | -| [`View.rotation_point`](compolyx.View.rotation_point.md#compolyx.View.rotation_point) | Get/set the view rotation point. | +| [`View.rotation_point`](compolyx.View.rotation_point.md#compolyx.View.rotation_point) | Get/set the view rotation point | ### Methods | Name | Description | |--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`View.find_parent`](compolyx.View.find_parent.md#compolyx.View.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`View.serialize`](compolyx.View.serialize.md#compolyx.View.serialize)() | Serialize to Python string. | -| [`View.visit`](compolyx.View.visit.md#compolyx.View.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`View.find_parent`](compolyx.View.find_parent.md#compolyx.View.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`View.serialize`](compolyx.View.serialize.md#compolyx.View.serialize)() | Serialize to Python string | +| [`View.visit`](compolyx.View.visit.md#compolyx.View.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.View.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.View.visit.md index 602e058cbb..6c76138e35 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.View.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.View.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.cad_references.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.cad_references.md index 5310421a60..2f48909390 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.cad_references.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.cad_references.md @@ -4,4 +4,4 @@ #### *property* VirtualGeometry.cad_references -Dictionary of all cad references. +Dictionary of all CAD references. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.enabled.md index cfd5dd6412..3bf541d7f8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.enabled.md @@ -4,4 +4,4 @@ #### *property* VirtualGeometry.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.is_dict_item.md index 6595466cc3..c6ea853e95 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* VirtualGeometry.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.is_list_item.md index 865607a1e3..7fe852684c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.is_list_item.md @@ -4,4 +4,4 @@ #### *property* VirtualGeometry.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.md index 8f3bd24425..7bd69cb1c2 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.md @@ -10,37 +10,37 @@ ComPoLyX class to represent VirtualGeometry. | Name | Description | |------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [`VirtualGeometry.active`](compolyx.VirtualGeometry.active.md#compolyx.VirtualGeometry.active) | active status of object | -| [`VirtualGeometry.cad_geometry`](compolyx.VirtualGeometry.cad_geometry.md#compolyx.VirtualGeometry.cad_geometry) | Returns the linked CADGeometry. | -| [`VirtualGeometry.cad_references`](compolyx.VirtualGeometry.cad_references.md#compolyx.VirtualGeometry.cad_references) | Dictionary of all cad references. | -| [`VirtualGeometry.dimension`](compolyx.VirtualGeometry.dimension.md#compolyx.VirtualGeometry.dimension) | Highest dimension of all cad references. | -| [`VirtualGeometry.enabled`](compolyx.VirtualGeometry.enabled.md#compolyx.VirtualGeometry.enabled) | Whether this object is currently enabled or not. | +| [`VirtualGeometry.active`](compolyx.VirtualGeometry.active.md#compolyx.VirtualGeometry.active) | Active status of object | +| [`VirtualGeometry.cad_geometry`](compolyx.VirtualGeometry.cad_geometry.md#compolyx.VirtualGeometry.cad_geometry) | Returns the linked CADGeometry | +| [`VirtualGeometry.cad_references`](compolyx.VirtualGeometry.cad_references.md#compolyx.VirtualGeometry.cad_references) | Dictionary of all cad references | +| [`VirtualGeometry.dimension`](compolyx.VirtualGeometry.dimension.md#compolyx.VirtualGeometry.dimension) | Highest dimension of all cad references | +| [`VirtualGeometry.enabled`](compolyx.VirtualGeometry.enabled.md#compolyx.VirtualGeometry.enabled) | Whether this object is currently enabled or not | | [`VirtualGeometry.id`](compolyx.VirtualGeometry.id.md#compolyx.VirtualGeometry.id) | ID of object | -| [`VirtualGeometry.is_dict_item`](compolyx.VirtualGeometry.is_dict_item.md#compolyx.VirtualGeometry.is_dict_item) | Specifies wether the object is an item of a dict | -| [`VirtualGeometry.is_list_item`](compolyx.VirtualGeometry.is_list_item.md#compolyx.VirtualGeometry.is_list_item) | Specifies wether the object is an item of a list | +| [`VirtualGeometry.is_dict_item`](compolyx.VirtualGeometry.is_dict_item.md#compolyx.VirtualGeometry.is_dict_item) | Specifies whether the object is an item of a dict | +| [`VirtualGeometry.is_list_item`](compolyx.VirtualGeometry.is_list_item.md#compolyx.VirtualGeometry.is_list_item) | Specifies whether the object is an item of a list | | [`VirtualGeometry.link_path`](compolyx.VirtualGeometry.link_path.md#compolyx.VirtualGeometry.link_path) | Root path of the current node in the tree for links to this object | | [`VirtualGeometry.name`](compolyx.VirtualGeometry.name.md#compolyx.VirtualGeometry.name) | Name of object | | [`VirtualGeometry.parent`](compolyx.VirtualGeometry.parent.md#compolyx.VirtualGeometry.parent) | Parent object in tree | | [`VirtualGeometry.root_path`](compolyx.VirtualGeometry.root_path.md#compolyx.VirtualGeometry.root_path) | Root path of the current node in the tree | | [`VirtualGeometry.status`](compolyx.VirtualGeometry.status.md#compolyx.VirtualGeometry.status) | Status of the object | -| [`VirtualGeometry.status_changed`](compolyx.VirtualGeometry.status_changed.md#compolyx.VirtualGeometry.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`VirtualGeometry.sub_shapes`](compolyx.VirtualGeometry.sub_shapes.md#compolyx.VirtualGeometry.sub_shapes) | Sub components of the VirtualGeometry. | +| [`VirtualGeometry.status_changed`](compolyx.VirtualGeometry.status_changed.md#compolyx.VirtualGeometry.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`VirtualGeometry.sub_shapes`](compolyx.VirtualGeometry.sub_shapes.md#compolyx.VirtualGeometry.sub_shapes) | Sub components of the VirtualGeometry | | [`VirtualGeometry.uid`](compolyx.VirtualGeometry.uid.md#compolyx.VirtualGeometry.uid) | UID of object | -| [`VirtualGeometry.vertex`](compolyx.VirtualGeometry.vertex.md#compolyx.VirtualGeometry.vertex) | This will throw an error if the object has been removed from the graph. | +| [`VirtualGeometry.vertex`](compolyx.VirtualGeometry.vertex.md#compolyx.VirtualGeometry.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`VirtualGeometry.add`](compolyx.VirtualGeometry.add.md#compolyx.VirtualGeometry.add)(shape) | Creates a new CADReference object for the given shape. | -| [`VirtualGeometry.clear_cad_references`](compolyx.VirtualGeometry.clear_cad_references.md#compolyx.VirtualGeometry.clear_cad_references)() | Clear all linked references (VirtualGeometry becomes empty). | -| [`VirtualGeometry.create_cad_reference`](compolyx.VirtualGeometry.create_cad_reference.md#compolyx.VirtualGeometry.create_cad_reference)([name, ...]) | Creates a new CAD reference and links it with the virtual geometry. | -| [`VirtualGeometry.find_parent`](compolyx.VirtualGeometry.find_parent.md#compolyx.VirtualGeometry.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`VirtualGeometry.add`](compolyx.VirtualGeometry.add.md#compolyx.VirtualGeometry.add)(shape) | Creates a new CADReference object for the given shape | +| [`VirtualGeometry.clear_cad_references`](compolyx.VirtualGeometry.clear_cad_references.md#compolyx.VirtualGeometry.clear_cad_references)() | Clear all linked references (VirtualGeometry becomes empty) | +| [`VirtualGeometry.create_cad_reference`](compolyx.VirtualGeometry.create_cad_reference.md#compolyx.VirtualGeometry.create_cad_reference)([name, ...]) | Creates a new CAD reference and links it with the virtual geometry | +| [`VirtualGeometry.find_parent`](compolyx.VirtualGeometry.find_parent.md#compolyx.VirtualGeometry.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`VirtualGeometry.get_short_description`](compolyx.VirtualGeometry.get_short_description.md#compolyx.VirtualGeometry.get_short_description)() | | -| [`VirtualGeometry.obj_exists`](compolyx.VirtualGeometry.obj_exists.md#compolyx.VirtualGeometry.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. | -| [`VirtualGeometry.remove`](compolyx.VirtualGeometry.remove.md#compolyx.VirtualGeometry.remove)(shape) | Removes the CADReference object for the given shape. | -| [`VirtualGeometry.serialize`](compolyx.VirtualGeometry.serialize.md#compolyx.VirtualGeometry.serialize)() | Serialize to Python string. | -| [`VirtualGeometry.serialize_name_and_id`](compolyx.VirtualGeometry.serialize_name_and_id.md#compolyx.VirtualGeometry.serialize_name_and_id)() | Helper function to serialize name and ID. | -| [`VirtualGeometry.set`](compolyx.VirtualGeometry.set.md#compolyx.VirtualGeometry.set)(shapes) | Clears the existing CAD References and creates a new one for each given shape. | +| [`VirtualGeometry.obj_exists`](compolyx.VirtualGeometry.obj_exists.md#compolyx.VirtualGeometry.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 | +| [`VirtualGeometry.remove`](compolyx.VirtualGeometry.remove.md#compolyx.VirtualGeometry.remove)(shape) | Removes the CADReference object for the given shape | +| [`VirtualGeometry.serialize`](compolyx.VirtualGeometry.serialize.md#compolyx.VirtualGeometry.serialize)() | Serialize to Python string | +| [`VirtualGeometry.serialize_name_and_id`](compolyx.VirtualGeometry.serialize_name_and_id.md#compolyx.VirtualGeometry.serialize_name_and_id)() | Helper function to serialize name and ID | +| [`VirtualGeometry.set`](compolyx.VirtualGeometry.set.md#compolyx.VirtualGeometry.set)(shapes) | Clears the existing CAD References and creates a new one for each given shape | | [`VirtualGeometry.update`](compolyx.VirtualGeometry.update.md#compolyx.VirtualGeometry.update)() | | -| [`VirtualGeometry.visit`](compolyx.VirtualGeometry.visit.md#compolyx.VirtualGeometry.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`VirtualGeometry.visit`](compolyx.VirtualGeometry.visit.md#compolyx.VirtualGeometry.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.obj_exists.md index fe91ce789f..72d6a05feb 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.obj_exists.md @@ -4,5 +4,5 @@ #### VirtualGeometry.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.visit.md index fc4ef063ca..bbf80c3edc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.VirtualGeometry.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.add_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.add_data_scope_entity.md index 1e12bc15ba..cc20525b50 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.add_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.add_data_scope_entity.md @@ -7,7 +7,7 @@ Add 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be added. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be added. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** : Add the Element Set “My_ESet” to a my_plot: diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.enabled.md index cf3e91b03e..108af0f588 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.enabled.md @@ -4,4 +4,4 @@ #### *property* AngleData.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.get_ply_offsets.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.get_ply_offsets.md index f94274b09c..a4098af6e6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.get_ply_offsets.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.get_ply_offsets.md @@ -17,9 +17,9 @@ Get the offset between plies and reference surface. ] The scope of the data is evaluated as the intersection of - > - data_scope of plot - > - visible_scope defined by visible - > - selection_scope defined by selected + - data_scope of plot + - visible_scope defined by visible + - selection_scope defined by selected **Example:** : Get the ply-offsets for the current ply-wise plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected: diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.is_dict_item.md index 70d37c6a87..633ddda5b3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* AngleData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.is_list_item.md index 1cf1c36790..6458b65660 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* AngleData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.md index 86f5ab2a85..8064cd2ee5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.md @@ -8,23 +8,23 @@ | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| [`AngleData.active`](compolyx.plot_data.AngleData.active.md#compolyx.plot_data.AngleData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data. | +| [`AngleData.active`](compolyx.plot_data.AngleData.active.md#compolyx.plot_data.AngleData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data | | [`AngleData.active_display_data`](compolyx.plot_data.AngleData.active_display_data.md#compolyx.plot_data.AngleData.active_display_data) | Returns a dictionary containing display data for this plot owned by the active scene | | [`AngleData.all_display_data`](compolyx.plot_data.AngleData.all_display_data.md#compolyx.plot_data.AngleData.all_display_data) | Returns a list of all display data classes in existence for this object | -| [`AngleData.changed`](compolyx.plot_data.AngleData.changed.md#compolyx.plot_data.AngleData.changed) | Status boolean. | +| [`AngleData.changed`](compolyx.plot_data.AngleData.changed.md#compolyx.plot_data.AngleData.changed) | Status boolean | | [`AngleData.color_table`](compolyx.plot_data.AngleData.color_table.md#compolyx.plot_data.AngleData.color_table) | | -| [`AngleData.component`](compolyx.plot_data.AngleData.component.md#compolyx.plot_data.AngleData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction. | +| [`AngleData.component`](compolyx.plot_data.AngleData.component.md#compolyx.plot_data.AngleData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction | | [`AngleData.components`](compolyx.plot_data.AngleData.components.md#compolyx.plot_data.AngleData.components) | Return the possible component set on this plot type | -| [`AngleData.data_scope`](compolyx.plot_data.AngleData.data_scope.md#compolyx.plot_data.AngleData.data_scope) | Data scope of the plot where results will be evaluated. | +| [`AngleData.data_scope`](compolyx.plot_data.AngleData.data_scope.md#compolyx.plot_data.AngleData.data_scope) | Data scope of the plot where results will be evaluated | | [`AngleData.definition_id`](compolyx.plot_data.AngleData.definition_id.md#compolyx.plot_data.AngleData.definition_id) | | -| [`AngleData.description_changed`](compolyx.plot_data.AngleData.description_changed.md#compolyx.plot_data.AngleData.description_changed) | Status boolean. | -| [`AngleData.enabled`](compolyx.plot_data.AngleData.enabled.md#compolyx.plot_data.AngleData.enabled) | Whether this object is currently enabled or not. | -| [`AngleData.eval_position`](compolyx.plot_data.AngleData.eval_position.md#compolyx.plot_data.AngleData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal. | -| [`AngleData.has_element_wise`](compolyx.plot_data.AngleData.has_element_wise.md#compolyx.plot_data.AngleData.has_element_wise) | Whether the plot offers element-wise data. | -| [`AngleData.has_ply_wise`](compolyx.plot_data.AngleData.has_ply_wise.md#compolyx.plot_data.AngleData.has_ply_wise) | Whether the plot offers ply-wise data. | +| [`AngleData.description_changed`](compolyx.plot_data.AngleData.description_changed.md#compolyx.plot_data.AngleData.description_changed) | Status boolean | +| [`AngleData.enabled`](compolyx.plot_data.AngleData.enabled.md#compolyx.plot_data.AngleData.enabled) | Whether this object is currently enabled or not | +| [`AngleData.eval_position`](compolyx.plot_data.AngleData.eval_position.md#compolyx.plot_data.AngleData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal | +| [`AngleData.has_element_wise`](compolyx.plot_data.AngleData.has_element_wise.md#compolyx.plot_data.AngleData.has_element_wise) | Whether the plot offers element-wise data | +| [`AngleData.has_ply_wise`](compolyx.plot_data.AngleData.has_ply_wise.md#compolyx.plot_data.AngleData.has_ply_wise) | Whether the plot offers ply-wise data | | [`AngleData.id`](compolyx.plot_data.AngleData.id.md#compolyx.plot_data.AngleData.id) | ID of object | -| [`AngleData.is_dict_item`](compolyx.plot_data.AngleData.is_dict_item.md#compolyx.plot_data.AngleData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`AngleData.is_list_item`](compolyx.plot_data.AngleData.is_list_item.md#compolyx.plot_data.AngleData.is_list_item) | Specifies wether the object is an item of a list | +| [`AngleData.is_dict_item`](compolyx.plot_data.AngleData.is_dict_item.md#compolyx.plot_data.AngleData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`AngleData.is_list_item`](compolyx.plot_data.AngleData.is_list_item.md#compolyx.plot_data.AngleData.is_list_item) | Specifies whether the object is an item of a list | | [`AngleData.link_path`](compolyx.plot_data.AngleData.link_path.md#compolyx.plot_data.AngleData.link_path) | Root path of the current node in the tree for links to this object | | [`AngleData.locked`](compolyx.plot_data.AngleData.locked.md#compolyx.plot_data.AngleData.locked) | Returns the locked status of the plot | | [`AngleData.minmax`](compolyx.plot_data.AngleData.minmax.md#compolyx.plot_data.AngleData.minmax) | Min and max value of current data | @@ -32,44 +32,44 @@ | [`AngleData.name`](compolyx.plot_data.AngleData.name.md#compolyx.plot_data.AngleData.name) | Name of object | | [`AngleData.parent`](compolyx.plot_data.AngleData.parent.md#compolyx.plot_data.AngleData.parent) | Parent object in tree | | [`AngleData.ply_offset_scale_factor`](compolyx.plot_data.AngleData.ply_offset_scale_factor.md#compolyx.plot_data.AngleData.ply_offset_scale_factor) | Offset scale factor | -| [`AngleData.ply_wise`](compolyx.plot_data.AngleData.ply_wise.md#compolyx.plot_data.AngleData.ply_wise) | Whether to plot ply-wise or element-wise. | +| [`AngleData.ply_wise`](compolyx.plot_data.AngleData.ply_wise.md#compolyx.plot_data.AngleData.ply_wise) | Whether to plot ply-wise or element-wise | | [`AngleData.requires_solution`](compolyx.plot_data.AngleData.requires_solution.md#compolyx.plot_data.AngleData.requires_solution) | | | [`AngleData.root_path`](compolyx.plot_data.AngleData.root_path.md#compolyx.plot_data.AngleData.root_path) | Root path of the current node in the tree | -| [`AngleData.scope_entire_model`](compolyx.plot_data.AngleData.scope_entire_model.md#compolyx.plot_data.AngleData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope. | +| [`AngleData.scope_entire_model`](compolyx.plot_data.AngleData.scope_entire_model.md#compolyx.plot_data.AngleData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope | | [`AngleData.show_on_section_cuts`](compolyx.plot_data.AngleData.show_on_section_cuts.md#compolyx.plot_data.AngleData.show_on_section_cuts) | | -| [`AngleData.show_on_solids`](compolyx.plot_data.AngleData.show_on_solids.md#compolyx.plot_data.AngleData.show_on_solids) | Whether to plot results on solid or shell elements. | +| [`AngleData.show_on_solids`](compolyx.plot_data.AngleData.show_on_solids.md#compolyx.plot_data.AngleData.show_on_solids) | Whether to plot results on solid or shell elements | | [`AngleData.show_ply_offsets`](compolyx.plot_data.AngleData.show_ply_offsets.md#compolyx.plot_data.AngleData.show_ply_offsets) | | -| [`AngleData.solution`](compolyx.plot_data.AngleData.solution.md#compolyx.plot_data.AngleData.solution) | Solution underlying the plot. | -| [`AngleData.solution_set`](compolyx.plot_data.AngleData.solution_set.md#compolyx.plot_data.AngleData.solution_set) | Solution Set selection. | +| [`AngleData.solution`](compolyx.plot_data.AngleData.solution.md#compolyx.plot_data.AngleData.solution) | Solution underlying the plot | +| [`AngleData.solution_set`](compolyx.plot_data.AngleData.solution_set.md#compolyx.plot_data.AngleData.solution_set) | Solution Set selection | | [`AngleData.spot`](compolyx.plot_data.AngleData.spot.md#compolyx.plot_data.AngleData.spot) | Not applicable to an angle plot | | [`AngleData.spots`](compolyx.plot_data.AngleData.spots.md#compolyx.plot_data.AngleData.spots) | Return the possible spot set on this plot type | | [`AngleData.status`](compolyx.plot_data.AngleData.status.md#compolyx.plot_data.AngleData.status) | Status of the object | -| [`AngleData.status_changed`](compolyx.plot_data.AngleData.status_changed.md#compolyx.plot_data.AngleData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`AngleData.status_changed`](compolyx.plot_data.AngleData.status_changed.md#compolyx.plot_data.AngleData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`AngleData.uid`](compolyx.plot_data.AngleData.uid.md#compolyx.plot_data.AngleData.uid) | UID of object | -| [`AngleData.updated`](compolyx.plot_data.AngleData.updated.md#compolyx.plot_data.AngleData.updated) | Status boolean. | -| [`AngleData.uptodate`](compolyx.plot_data.AngleData.uptodate.md#compolyx.plot_data.AngleData.uptodate) | Whether the plot is uptodate. | -| [`AngleData.vertex`](compolyx.plot_data.AngleData.vertex.md#compolyx.plot_data.AngleData.vertex) | This will throw an error if the object has been removed from the graph. | +| [`AngleData.updated`](compolyx.plot_data.AngleData.updated.md#compolyx.plot_data.AngleData.updated) | Status boolean | +| [`AngleData.uptodate`](compolyx.plot_data.AngleData.uptodate.md#compolyx.plot_data.AngleData.uptodate) | Whether the plot is up-to-date | +| [`AngleData.vertex`](compolyx.plot_data.AngleData.vertex.md#compolyx.plot_data.AngleData.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`AngleData.add_data_scope_entity`](compolyx.plot_data.AngleData.add_data_scope_entity.md#compolyx.plot_data.AngleData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot. | -| [`AngleData.clear_data_scope`](compolyx.plot_data.AngleData.clear_data_scope.md#compolyx.plot_data.AngleData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. | -| [`AngleData.display_data_create`](compolyx.plot_data.AngleData.display_data_create.md#compolyx.plot_data.AngleData.display_data_create)([parent]) | Function for internal use, not meant for scripting. | -| [`AngleData.find_parent`](compolyx.plot_data.AngleData.find_parent.md#compolyx.plot_data.AngleData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`AngleData.get_data`](compolyx.plot_data.AngleData.get_data.md#compolyx.plot_data.AngleData.get_data)([visible, selected]) | Get data of plot. | -| [`AngleData.get_deformations`](compolyx.plot_data.AngleData.get_deformations.md#compolyx.plot_data.AngleData.get_deformations)([visible, selected]) | Function used internally to query matching nodal deformations for a given plot. | +| [`AngleData.add_data_scope_entity`](compolyx.plot_data.AngleData.add_data_scope_entity.md#compolyx.plot_data.AngleData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot | +| [`AngleData.clear_data_scope`](compolyx.plot_data.AngleData.clear_data_scope.md#compolyx.plot_data.AngleData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once | +| [`AngleData.display_data_create`](compolyx.plot_data.AngleData.display_data_create.md#compolyx.plot_data.AngleData.display_data_create)([parent]) | Function for internal use, not meant for scripting | +| [`AngleData.find_parent`](compolyx.plot_data.AngleData.find_parent.md#compolyx.plot_data.AngleData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`AngleData.get_data`](compolyx.plot_data.AngleData.get_data.md#compolyx.plot_data.AngleData.get_data)([visible, selected]) | Get data of plot | +| [`AngleData.get_deformations`](compolyx.plot_data.AngleData.get_deformations.md#compolyx.plot_data.AngleData.get_deformations)([visible, selected]) | Function used internally to query matching nodal deformations for a given plot | | [`AngleData.get_element_indices`](compolyx.plot_data.AngleData.get_element_indices.md#compolyx.plot_data.AngleData.get_element_indices)([visible, ...]) | Get element indices (ACP internal element numbers starting from 0) of plot | -| [`AngleData.get_element_labels`](compolyx.plot_data.AngleData.get_element_labels.md#compolyx.plot_data.AngleData.get_element_labels)([visible, selected]) | Get element labels (element numbers as read from / written to mesh files) of plot. | -| [`AngleData.get_full_description`](compolyx.plot_data.AngleData.get_full_description.md#compolyx.plot_data.AngleData.get_full_description)() | This function returns information displayed together with the legend. | -| [`AngleData.get_ply_offsets`](compolyx.plot_data.AngleData.get_ply_offsets.md#compolyx.plot_data.AngleData.get_ply_offsets)([visible, selected]) | Get the offset between plies and reference surface. | -| [`AngleData.obj_exists`](compolyx.plot_data.AngleData.obj_exists.md#compolyx.plot_data.AngleData.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. | -| [`AngleData.remove_data_scope_entity`](compolyx.plot_data.AngleData.remove_data_scope_entity.md#compolyx.plot_data.AngleData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot. | +| [`AngleData.get_element_labels`](compolyx.plot_data.AngleData.get_element_labels.md#compolyx.plot_data.AngleData.get_element_labels)([visible, selected]) | Get element labels (element numbers as read from / written to mesh files) of plot | +| [`AngleData.get_full_description`](compolyx.plot_data.AngleData.get_full_description.md#compolyx.plot_data.AngleData.get_full_description)() | This function returns information displayed together with the legend | +| [`AngleData.get_ply_offsets`](compolyx.plot_data.AngleData.get_ply_offsets.md#compolyx.plot_data.AngleData.get_ply_offsets)([visible, selected]) | Get the offset between plies and reference surface | +| [`AngleData.obj_exists`](compolyx.plot_data.AngleData.obj_exists.md#compolyx.plot_data.AngleData.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 | +| [`AngleData.remove_data_scope_entity`](compolyx.plot_data.AngleData.remove_data_scope_entity.md#compolyx.plot_data.AngleData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot | | [`AngleData.serialize`](compolyx.plot_data.AngleData.serialize.md#compolyx.plot_data.AngleData.serialize)() | Serialize to Python string | | [`AngleData.serialize_create_function`](compolyx.plot_data.AngleData.serialize_create_function.md#compolyx.plot_data.AngleData.serialize_create_function)() | | -| [`AngleData.serialize_name_and_id`](compolyx.plot_data.AngleData.serialize_name_and_id.md#compolyx.plot_data.AngleData.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`AngleData.serialize_name_and_id`](compolyx.plot_data.AngleData.serialize_name_and_id.md#compolyx.plot_data.AngleData.serialize_name_and_id)() | Helper function to serialize name and ID | | [`AngleData.serialize_properties`](compolyx.plot_data.AngleData.serialize_properties.md#compolyx.plot_data.AngleData.serialize_properties)() | Serialize to Python string | | [`AngleData.serialize_python_only_attributes`](compolyx.plot_data.AngleData.serialize_python_only_attributes.md#compolyx.plot_data.AngleData.serialize_python_only_attributes)() | | | [`AngleData.update`](compolyx.plot_data.AngleData.update.md#compolyx.plot_data.AngleData.update)() | | -| [`AngleData.visit`](compolyx.plot_data.AngleData.visit.md#compolyx.plot_data.AngleData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`AngleData.visit`](compolyx.plot_data.AngleData.visit.md#compolyx.plot_data.AngleData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.obj_exists.md index 6680aa547b..d53350b62a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.obj_exists.md @@ -4,5 +4,5 @@ #### AngleData.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.remove_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.remove_data_scope_entity.md index a9d5701a7a..5beb92aff9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.remove_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.remove_data_scope_entity.md @@ -7,7 +7,7 @@ Remove 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be removed. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be removed. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** : Remove the Element Set “My_ESet” from my_plot: diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.visit.md index 2a43599a07..e304b81049 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.AngleData.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.add_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.add_data_scope_entity.md index 90b89f4ced..aea13920c6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.add_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.add_data_scope_entity.md @@ -7,7 +7,7 @@ Add 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be added. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be added. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** : Add the Element Set “My_ESet” to a my_plot: diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.description_changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.description_changed.md index 490a96fcf1..614898e322 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.description_changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.description_changed.md @@ -4,4 +4,4 @@ #### *property* ContourData.description_changed -Status boolean. Set to true if the object’s description has been changed. Write only property +Status boolean. Set to true if the object’s description has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.enabled.md index 32ef06cf34..17f6e6d18e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.enabled.md @@ -4,4 +4,4 @@ #### *property* ContourData.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.get_ply_offsets.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.get_ply_offsets.md index 2b3969162a..3dfd1a1c2c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.get_ply_offsets.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.get_ply_offsets.md @@ -17,9 +17,9 @@ Get the offset between plies and reference surface. ] The scope of the data is evaluated as the intersection of - > - data_scope of plot - > - visible_scope defined by visible - > - selection_scope defined by selected + - data_scope of plot + - visible_scope defined by visible + - selection_scope defined by selected **Example:** : Get the ply-offsets for the current ply-wise plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected: diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.is_dict_item.md index 2891cc3f48..3c434b960d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ContourData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.is_list_item.md index 3cf2aeff55..c3e5d761ec 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ContourData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.md index 6cbe3c07e0..a370139576 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.md @@ -8,23 +8,23 @@ | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| [`ContourData.active`](compolyx.plot_data.ContourData.active.md#compolyx.plot_data.ContourData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data. | +| [`ContourData.active`](compolyx.plot_data.ContourData.active.md#compolyx.plot_data.ContourData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data | | [`ContourData.active_display_data`](compolyx.plot_data.ContourData.active_display_data.md#compolyx.plot_data.ContourData.active_display_data) | Returns a dictionary containing display data for this plot owned by the active scene | | [`ContourData.all_display_data`](compolyx.plot_data.ContourData.all_display_data.md#compolyx.plot_data.ContourData.all_display_data) | Returns a list of all display data classes in existence for this object | -| [`ContourData.changed`](compolyx.plot_data.ContourData.changed.md#compolyx.plot_data.ContourData.changed) | Status boolean. | +| [`ContourData.changed`](compolyx.plot_data.ContourData.changed.md#compolyx.plot_data.ContourData.changed) | Status boolean | | [`ContourData.color_table`](compolyx.plot_data.ContourData.color_table.md#compolyx.plot_data.ContourData.color_table) | | -| [`ContourData.component`](compolyx.plot_data.ContourData.component.md#compolyx.plot_data.ContourData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction. | +| [`ContourData.component`](compolyx.plot_data.ContourData.component.md#compolyx.plot_data.ContourData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction | | [`ContourData.components`](compolyx.plot_data.ContourData.components.md#compolyx.plot_data.ContourData.components) | Return the possible component set on this plot type | -| [`ContourData.data_scope`](compolyx.plot_data.ContourData.data_scope.md#compolyx.plot_data.ContourData.data_scope) | Data scope of the plot where results will be evaluated. | +| [`ContourData.data_scope`](compolyx.plot_data.ContourData.data_scope.md#compolyx.plot_data.ContourData.data_scope) | Data scope of the plot where results will be evaluated | | [`ContourData.definition_id`](compolyx.plot_data.ContourData.definition_id.md#compolyx.plot_data.ContourData.definition_id) | | | [`ContourData.description_changed`](compolyx.plot_data.ContourData.description_changed.md#compolyx.plot_data.ContourData.description_changed) | Status boolean. | -| [`ContourData.enabled`](compolyx.plot_data.ContourData.enabled.md#compolyx.plot_data.ContourData.enabled) | Whether this object is currently enabled or not. | -| [`ContourData.eval_position`](compolyx.plot_data.ContourData.eval_position.md#compolyx.plot_data.ContourData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal. | -| [`ContourData.has_element_wise`](compolyx.plot_data.ContourData.has_element_wise.md#compolyx.plot_data.ContourData.has_element_wise) | Whether the plot offers element-wise data. | -| [`ContourData.has_ply_wise`](compolyx.plot_data.ContourData.has_ply_wise.md#compolyx.plot_data.ContourData.has_ply_wise) | Whether the plot offers ply-wise data. | +| [`ContourData.enabled`](compolyx.plot_data.ContourData.enabled.md#compolyx.plot_data.ContourData.enabled) | Whether this object is currently enabled or not | +| [`ContourData.eval_position`](compolyx.plot_data.ContourData.eval_position.md#compolyx.plot_data.ContourData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal | +| [`ContourData.has_element_wise`](compolyx.plot_data.ContourData.has_element_wise.md#compolyx.plot_data.ContourData.has_element_wise) | Whether the plot offers element-wise data | +| [`ContourData.has_ply_wise`](compolyx.plot_data.ContourData.has_ply_wise.md#compolyx.plot_data.ContourData.has_ply_wise) | Whether the plot offers ply-wise data | | [`ContourData.id`](compolyx.plot_data.ContourData.id.md#compolyx.plot_data.ContourData.id) | ID of object | -| [`ContourData.is_dict_item`](compolyx.plot_data.ContourData.is_dict_item.md#compolyx.plot_data.ContourData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ContourData.is_list_item`](compolyx.plot_data.ContourData.is_list_item.md#compolyx.plot_data.ContourData.is_list_item) | Specifies wether the object is an item of a list | +| [`ContourData.is_dict_item`](compolyx.plot_data.ContourData.is_dict_item.md#compolyx.plot_data.ContourData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ContourData.is_list_item`](compolyx.plot_data.ContourData.is_list_item.md#compolyx.plot_data.ContourData.is_list_item) | Specifies whether the object is an item of a list | | [`ContourData.link_path`](compolyx.plot_data.ContourData.link_path.md#compolyx.plot_data.ContourData.link_path) | Root path of the current node in the tree for links to this object | | [`ContourData.locked`](compolyx.plot_data.ContourData.locked.md#compolyx.plot_data.ContourData.locked) | Returns the locked status of the plot | | [`ContourData.minmax`](compolyx.plot_data.ContourData.minmax.md#compolyx.plot_data.ContourData.minmax) | Min and max value of current data | @@ -32,43 +32,43 @@ | [`ContourData.name`](compolyx.plot_data.ContourData.name.md#compolyx.plot_data.ContourData.name) | Name of object | | [`ContourData.parent`](compolyx.plot_data.ContourData.parent.md#compolyx.plot_data.ContourData.parent) | Parent object in tree | | [`ContourData.ply_offset_scale_factor`](compolyx.plot_data.ContourData.ply_offset_scale_factor.md#compolyx.plot_data.ContourData.ply_offset_scale_factor) | Offset scale factor | -| [`ContourData.ply_wise`](compolyx.plot_data.ContourData.ply_wise.md#compolyx.plot_data.ContourData.ply_wise) | Whether to plot ply-wise or element-wise. | +| [`ContourData.ply_wise`](compolyx.plot_data.ContourData.ply_wise.md#compolyx.plot_data.ContourData.ply_wise) | Whether to plot ply-wise or element-wise | | [`ContourData.requires_solution`](compolyx.plot_data.ContourData.requires_solution.md#compolyx.plot_data.ContourData.requires_solution) | | | [`ContourData.root_path`](compolyx.plot_data.ContourData.root_path.md#compolyx.plot_data.ContourData.root_path) | Root path of the current node in the tree | -| [`ContourData.scope_entire_model`](compolyx.plot_data.ContourData.scope_entire_model.md#compolyx.plot_data.ContourData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope. | -| [`ContourData.show_on_solids`](compolyx.plot_data.ContourData.show_on_solids.md#compolyx.plot_data.ContourData.show_on_solids) | Whether to plot results on solid or shell elements. | +| [`ContourData.scope_entire_model`](compolyx.plot_data.ContourData.scope_entire_model.md#compolyx.plot_data.ContourData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope | +| [`ContourData.show_on_solids`](compolyx.plot_data.ContourData.show_on_solids.md#compolyx.plot_data.ContourData.show_on_solids) | Whether to plot results on solid or shell elements | | [`ContourData.show_ply_offsets`](compolyx.plot_data.ContourData.show_ply_offsets.md#compolyx.plot_data.ContourData.show_ply_offsets) | | -| [`ContourData.solution`](compolyx.plot_data.ContourData.solution.md#compolyx.plot_data.ContourData.solution) | Solution underlying the plot. | -| [`ContourData.solution_set`](compolyx.plot_data.ContourData.solution_set.md#compolyx.plot_data.ContourData.solution_set) | Solution Set selection. | -| [`ContourData.spot`](compolyx.plot_data.ContourData.spot.md#compolyx.plot_data.ContourData.spot) | Whether to plot data at bot, mid or top of the layer or laminate. | +| [`ContourData.solution`](compolyx.plot_data.ContourData.solution.md#compolyx.plot_data.ContourData.solution) | Solution underlying the plot | +| [`ContourData.solution_set`](compolyx.plot_data.ContourData.solution_set.md#compolyx.plot_data.ContourData.solution_set) | Solution Set selection | +| [`ContourData.spot`](compolyx.plot_data.ContourData.spot.md#compolyx.plot_data.ContourData.spot) | Whether to plot data at bot, mid or top of the layer or laminate | | [`ContourData.spots`](compolyx.plot_data.ContourData.spots.md#compolyx.plot_data.ContourData.spots) | Return the possible spot set on this plot type | | [`ContourData.status`](compolyx.plot_data.ContourData.status.md#compolyx.plot_data.ContourData.status) | Status of the object | -| [`ContourData.status_changed`](compolyx.plot_data.ContourData.status_changed.md#compolyx.plot_data.ContourData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`ContourData.status_changed`](compolyx.plot_data.ContourData.status_changed.md#compolyx.plot_data.ContourData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`ContourData.uid`](compolyx.plot_data.ContourData.uid.md#compolyx.plot_data.ContourData.uid) | UID of object | -| [`ContourData.updated`](compolyx.plot_data.ContourData.updated.md#compolyx.plot_data.ContourData.updated) | Status boolean. | -| [`ContourData.uptodate`](compolyx.plot_data.ContourData.uptodate.md#compolyx.plot_data.ContourData.uptodate) | Whether the plot is uptodate. | -| [`ContourData.vertex`](compolyx.plot_data.ContourData.vertex.md#compolyx.plot_data.ContourData.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ContourData.updated`](compolyx.plot_data.ContourData.updated.md#compolyx.plot_data.ContourData.updated) | Status boolean | +| [`ContourData.uptodate`](compolyx.plot_data.ContourData.uptodate.md#compolyx.plot_data.ContourData.uptodate) | Whether the plot is uptodate | +| [`ContourData.vertex`](compolyx.plot_data.ContourData.vertex.md#compolyx.plot_data.ContourData.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ContourData.add_data_scope_entity`](compolyx.plot_data.ContourData.add_data_scope_entity.md#compolyx.plot_data.ContourData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot. | -| [`ContourData.clear_data_scope`](compolyx.plot_data.ContourData.clear_data_scope.md#compolyx.plot_data.ContourData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. | -| [`ContourData.display_data_create`](compolyx.plot_data.ContourData.display_data_create.md#compolyx.plot_data.ContourData.display_data_create)([parent]) | Function for internal use, not meant for scripting. | -| [`ContourData.find_parent`](compolyx.plot_data.ContourData.find_parent.md#compolyx.plot_data.ContourData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`ContourData.get_data`](compolyx.plot_data.ContourData.get_data.md#compolyx.plot_data.ContourData.get_data)([visible, selected]) | Get data of plot. | -| [`ContourData.get_deformations`](compolyx.plot_data.ContourData.get_deformations.md#compolyx.plot_data.ContourData.get_deformations)([visible, selected]) | Function used internally to query matching nodal deformations for a given plot. | +| [`ContourData.add_data_scope_entity`](compolyx.plot_data.ContourData.add_data_scope_entity.md#compolyx.plot_data.ContourData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot | +| [`ContourData.clear_data_scope`](compolyx.plot_data.ContourData.clear_data_scope.md#compolyx.plot_data.ContourData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once | +| [`ContourData.display_data_create`](compolyx.plot_data.ContourData.display_data_create.md#compolyx.plot_data.ContourData.display_data_create)([parent]) | Function for internal use, not meant for scripting | +| [`ContourData.find_parent`](compolyx.plot_data.ContourData.find_parent.md#compolyx.plot_data.ContourData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`ContourData.get_data`](compolyx.plot_data.ContourData.get_data.md#compolyx.plot_data.ContourData.get_data)([visible, selected]) | Get data of plot | +| [`ContourData.get_deformations`](compolyx.plot_data.ContourData.get_deformations.md#compolyx.plot_data.ContourData.get_deformations)([visible, selected]) | Function used internally to query matching nodal deformations for a given plot | | [`ContourData.get_element_indices`](compolyx.plot_data.ContourData.get_element_indices.md#compolyx.plot_data.ContourData.get_element_indices)([visible, ...]) | Get element indices (ACP internal element numbers starting from 0) of plot | -| [`ContourData.get_element_labels`](compolyx.plot_data.ContourData.get_element_labels.md#compolyx.plot_data.ContourData.get_element_labels)([visible, ...]) | Get element labels (element numbers as read from / written to mesh files) of plot. | -| [`ContourData.get_full_description`](compolyx.plot_data.ContourData.get_full_description.md#compolyx.plot_data.ContourData.get_full_description)() | This function returns information displayed together with the legend. | -| [`ContourData.get_ply_offsets`](compolyx.plot_data.ContourData.get_ply_offsets.md#compolyx.plot_data.ContourData.get_ply_offsets)([visible, selected]) | Get the offset between plies and reference surface. | -| [`ContourData.obj_exists`](compolyx.plot_data.ContourData.obj_exists.md#compolyx.plot_data.ContourData.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. | -| [`ContourData.remove_data_scope_entity`](compolyx.plot_data.ContourData.remove_data_scope_entity.md#compolyx.plot_data.ContourData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot. | +| [`ContourData.get_element_labels`](compolyx.plot_data.ContourData.get_element_labels.md#compolyx.plot_data.ContourData.get_element_labels)([visible, ...]) | Get element labels (element numbers as read from / written to mesh files) of plot | +| [`ContourData.get_full_description`](compolyx.plot_data.ContourData.get_full_description.md#compolyx.plot_data.ContourData.get_full_description)() | This function returns information displayed together with the legend | +| [`ContourData.get_ply_offsets`](compolyx.plot_data.ContourData.get_ply_offsets.md#compolyx.plot_data.ContourData.get_ply_offsets)([visible, selected]) | Get the offset between plies and reference surface | +| [`ContourData.obj_exists`](compolyx.plot_data.ContourData.obj_exists.md#compolyx.plot_data.ContourData.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 | +| [`ContourData.remove_data_scope_entity`](compolyx.plot_data.ContourData.remove_data_scope_entity.md#compolyx.plot_data.ContourData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot | | [`ContourData.serialize`](compolyx.plot_data.ContourData.serialize.md#compolyx.plot_data.ContourData.serialize)() | Serialize to Python string | | [`ContourData.serialize_create_function`](compolyx.plot_data.ContourData.serialize_create_function.md#compolyx.plot_data.ContourData.serialize_create_function)() | | -| [`ContourData.serialize_name_and_id`](compolyx.plot_data.ContourData.serialize_name_and_id.md#compolyx.plot_data.ContourData.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ContourData.serialize_name_and_id`](compolyx.plot_data.ContourData.serialize_name_and_id.md#compolyx.plot_data.ContourData.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ContourData.serialize_properties`](compolyx.plot_data.ContourData.serialize_properties.md#compolyx.plot_data.ContourData.serialize_properties)() | Serialize to Python string | | [`ContourData.serialize_python_only_attributes`](compolyx.plot_data.ContourData.serialize_python_only_attributes.md#compolyx.plot_data.ContourData.serialize_python_only_attributes)() | | | [`ContourData.update`](compolyx.plot_data.ContourData.update.md#compolyx.plot_data.ContourData.update)() | | -| [`ContourData.visit`](compolyx.plot_data.ContourData.visit.md#compolyx.plot_data.ContourData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ContourData.visit`](compolyx.plot_data.ContourData.visit.md#compolyx.plot_data.ContourData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.obj_exists.md index 8dd86f44b3..b40586dd9c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.obj_exists.md @@ -4,5 +4,5 @@ #### ContourData.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.remove_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.remove_data_scope_entity.md index 4c97dbd4cd..76020e0bda 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.remove_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.remove_data_scope_entity.md @@ -7,7 +7,7 @@ Remove 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be removed. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be removed. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** : Remove the Element Set “My_ESet” from my_plot: diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.spot.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.spot.md index 3479a7f466..50323c6b6e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.spot.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.spot.md @@ -4,4 +4,4 @@ #### *property* ContourData.spot -Whether to plot data at bot, mid or top of the layer or laminate. +Whether to plot data at bot, mid, or top of the layer or laminate. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.uptodate.md index c7f9b7d092..0887942b3b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.uptodate.md @@ -4,4 +4,4 @@ #### *property* ContourData.uptodate -Whether the plot is uptodate. +Whether the plot is up-to-date. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.visit.md index a4ba250b2b..39bfd4e12f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ContourData.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.add_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.add_data_scope_entity.md index cba8cf0569..263df6b9cf 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.add_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.add_data_scope_entity.md @@ -7,7 +7,7 @@ Add 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be added. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be added. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** : Add the Element Set “My_ESet” to a my_plot: diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.description_changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.description_changed.md index 1596ecc5c1..de920dc3ea 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.description_changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.description_changed.md @@ -4,4 +4,4 @@ #### *property* DrapingData.description_changed -Status boolean. Set to true if the object’s description has been changed. Write only property +Status boolean. Set to true if the object’s description has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.enabled.md index 32dcfea859..7ac6dafbd9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.enabled.md @@ -4,4 +4,4 @@ #### *property* DrapingData.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.is_dict_item.md index e2d9ce0c61..45e1698e4e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* DrapingData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.is_list_item.md index ea9c9caeab..415a6682d4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* DrapingData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.md index fc2566c836..5cf2a2088d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.md @@ -8,64 +8,64 @@ | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| [`DrapingData.active`](compolyx.plot_data.DrapingData.active.md#compolyx.plot_data.DrapingData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data. | +| [`DrapingData.active`](compolyx.plot_data.DrapingData.active.md#compolyx.plot_data.DrapingData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data | | [`DrapingData.active_display_data`](compolyx.plot_data.DrapingData.active_display_data.md#compolyx.plot_data.DrapingData.active_display_data) | Returns a dictionary containing display data for this plot owned by the active scene | | [`DrapingData.all_display_data`](compolyx.plot_data.DrapingData.all_display_data.md#compolyx.plot_data.DrapingData.all_display_data) | Returns a list of all display data classes in existence for this object | -| [`DrapingData.changed`](compolyx.plot_data.DrapingData.changed.md#compolyx.plot_data.DrapingData.changed) | Status boolean. | +| [`DrapingData.changed`](compolyx.plot_data.DrapingData.changed.md#compolyx.plot_data.DrapingData.changed) | Status boolean | | [`DrapingData.color_table`](compolyx.plot_data.DrapingData.color_table.md#compolyx.plot_data.DrapingData.color_table) | | -| [`DrapingData.component`](compolyx.plot_data.DrapingData.component.md#compolyx.plot_data.DrapingData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction. | +| [`DrapingData.component`](compolyx.plot_data.DrapingData.component.md#compolyx.plot_data.DrapingData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction | | [`DrapingData.components`](compolyx.plot_data.DrapingData.components.md#compolyx.plot_data.DrapingData.components) | Return the possible component set on this plot type | -| [`DrapingData.data_scope`](compolyx.plot_data.DrapingData.data_scope.md#compolyx.plot_data.DrapingData.data_scope) | Data scope of the plot where results will be evaluated. | +| [`DrapingData.data_scope`](compolyx.plot_data.DrapingData.data_scope.md#compolyx.plot_data.DrapingData.data_scope) | Data scope of the plot where results will be evaluated | | [`DrapingData.definition_id`](compolyx.plot_data.DrapingData.definition_id.md#compolyx.plot_data.DrapingData.definition_id) | | -| [`DrapingData.description_changed`](compolyx.plot_data.DrapingData.description_changed.md#compolyx.plot_data.DrapingData.description_changed) | Status boolean. | -| [`DrapingData.enabled`](compolyx.plot_data.DrapingData.enabled.md#compolyx.plot_data.DrapingData.enabled) | Whether this object is currently enabled or not. | -| [`DrapingData.eval_position`](compolyx.plot_data.DrapingData.eval_position.md#compolyx.plot_data.DrapingData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal. | -| [`DrapingData.has_element_wise`](compolyx.plot_data.DrapingData.has_element_wise.md#compolyx.plot_data.DrapingData.has_element_wise) | Whether the plot offers element-wise data. | -| [`DrapingData.has_ply_wise`](compolyx.plot_data.DrapingData.has_ply_wise.md#compolyx.plot_data.DrapingData.has_ply_wise) | Whether the plot offers ply-wise data. | +| [`DrapingData.description_changed`](compolyx.plot_data.DrapingData.description_changed.md#compolyx.plot_data.DrapingData.description_changed) | Status boolean | +| [`DrapingData.enabled`](compolyx.plot_data.DrapingData.enabled.md#compolyx.plot_data.DrapingData.enabled) | Whether this object is currently enabled or not | +| [`DrapingData.eval_position`](compolyx.plot_data.DrapingData.eval_position.md#compolyx.plot_data.DrapingData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal | +| [`DrapingData.has_element_wise`](compolyx.plot_data.DrapingData.has_element_wise.md#compolyx.plot_data.DrapingData.has_element_wise) | Whether the plot offers element-wise data | +| [`DrapingData.has_ply_wise`](compolyx.plot_data.DrapingData.has_ply_wise.md#compolyx.plot_data.DrapingData.has_ply_wise) | Whether the plot offers ply-wise data | | [`DrapingData.id`](compolyx.plot_data.DrapingData.id.md#compolyx.plot_data.DrapingData.id) | ID of object | -| [`DrapingData.is_dict_item`](compolyx.plot_data.DrapingData.is_dict_item.md#compolyx.plot_data.DrapingData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`DrapingData.is_list_item`](compolyx.plot_data.DrapingData.is_list_item.md#compolyx.plot_data.DrapingData.is_list_item) | Specifies wether the object is an item of a list | +| [`DrapingData.is_dict_item`](compolyx.plot_data.DrapingData.is_dict_item.md#compolyx.plot_data.DrapingData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`DrapingData.is_list_item`](compolyx.plot_data.DrapingData.is_list_item.md#compolyx.plot_data.DrapingData.is_list_item) | Specifies whether the object is an item of a list | | [`DrapingData.link_path`](compolyx.plot_data.DrapingData.link_path.md#compolyx.plot_data.DrapingData.link_path) | Root path of the current node in the tree for links to this object | | [`DrapingData.locked`](compolyx.plot_data.DrapingData.locked.md#compolyx.plot_data.DrapingData.locked) | Returns the locked status of the plot | | [`DrapingData.name`](compolyx.plot_data.DrapingData.name.md#compolyx.plot_data.DrapingData.name) | Name of object | | [`DrapingData.parent`](compolyx.plot_data.DrapingData.parent.md#compolyx.plot_data.DrapingData.parent) | Parent object in tree | -| [`DrapingData.ply_wise`](compolyx.plot_data.DrapingData.ply_wise.md#compolyx.plot_data.DrapingData.ply_wise) | Whether to plot ply-wise or element-wise. | +| [`DrapingData.ply_wise`](compolyx.plot_data.DrapingData.ply_wise.md#compolyx.plot_data.DrapingData.ply_wise) | Whether to plot ply-wise or element-wise | | [`DrapingData.requires_solution`](compolyx.plot_data.DrapingData.requires_solution.md#compolyx.plot_data.DrapingData.requires_solution) | | | [`DrapingData.root_path`](compolyx.plot_data.DrapingData.root_path.md#compolyx.plot_data.DrapingData.root_path) | Root path of the current node in the tree | -| [`DrapingData.scope_entire_model`](compolyx.plot_data.DrapingData.scope_entire_model.md#compolyx.plot_data.DrapingData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope. | -| [`DrapingData.show_draping_mesh`](compolyx.plot_data.DrapingData.show_draping_mesh.md#compolyx.plot_data.DrapingData.show_draping_mesh) | Whether to plot the draping mesh. | -| [`DrapingData.show_flatwrap`](compolyx.plot_data.DrapingData.show_flatwrap.md#compolyx.plot_data.DrapingData.show_flatwrap) | Whether to plot the flatwrap. | -| [`DrapingData.show_on_solids`](compolyx.plot_data.DrapingData.show_on_solids.md#compolyx.plot_data.DrapingData.show_on_solids) | Whether to plot results on solid or shell elements. | -| [`DrapingData.solution`](compolyx.plot_data.DrapingData.solution.md#compolyx.plot_data.DrapingData.solution) | Solution underlying the plot. | -| [`DrapingData.solution_set`](compolyx.plot_data.DrapingData.solution_set.md#compolyx.plot_data.DrapingData.solution_set) | Solution Set selection. | -| [`DrapingData.spot`](compolyx.plot_data.DrapingData.spot.md#compolyx.plot_data.DrapingData.spot) | Whether to plot data at bot, mid or top of the layer or laminate. | +| [`DrapingData.scope_entire_model`](compolyx.plot_data.DrapingData.scope_entire_model.md#compolyx.plot_data.DrapingData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope | +| [`DrapingData.show_draping_mesh`](compolyx.plot_data.DrapingData.show_draping_mesh.md#compolyx.plot_data.DrapingData.show_draping_mesh) | Whether to plot the draping mesh | +| [`DrapingData.show_flatwrap`](compolyx.plot_data.DrapingData.show_flatwrap.md#compolyx.plot_data.DrapingData.show_flatwrap) | Whether to plot the flatwrap | +| [`DrapingData.show_on_solids`](compolyx.plot_data.DrapingData.show_on_solids.md#compolyx.plot_data.DrapingData.show_on_solids) | Whether to plot results on solid or shell elements | +| [`DrapingData.solution`](compolyx.plot_data.DrapingData.solution.md#compolyx.plot_data.DrapingData.solution) | Solution underlying the plot | +| [`DrapingData.solution_set`](compolyx.plot_data.DrapingData.solution_set.md#compolyx.plot_data.DrapingData.solution_set) | Solution Set selection | +| [`DrapingData.spot`](compolyx.plot_data.DrapingData.spot.md#compolyx.plot_data.DrapingData.spot) | Whether to plot data at bot, mid, or top of the layer or laminate | | [`DrapingData.spots`](compolyx.plot_data.DrapingData.spots.md#compolyx.plot_data.DrapingData.spots) | Return the possible spot set on this plot type | | [`DrapingData.status`](compolyx.plot_data.DrapingData.status.md#compolyx.plot_data.DrapingData.status) | Status of the object | -| [`DrapingData.status_changed`](compolyx.plot_data.DrapingData.status_changed.md#compolyx.plot_data.DrapingData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`DrapingData.status_changed`](compolyx.plot_data.DrapingData.status_changed.md#compolyx.plot_data.DrapingData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`DrapingData.uid`](compolyx.plot_data.DrapingData.uid.md#compolyx.plot_data.DrapingData.uid) | UID of object | -| [`DrapingData.updated`](compolyx.plot_data.DrapingData.updated.md#compolyx.plot_data.DrapingData.updated) | Status boolean. | -| [`DrapingData.uptodate`](compolyx.plot_data.DrapingData.uptodate.md#compolyx.plot_data.DrapingData.uptodate) | Whether the plot is uptodate. | -| [`DrapingData.vertex`](compolyx.plot_data.DrapingData.vertex.md#compolyx.plot_data.DrapingData.vertex) | This will throw an error if the object has been removed from the graph. | +| [`DrapingData.updated`](compolyx.plot_data.DrapingData.updated.md#compolyx.plot_data.DrapingData.updated) | Status boolean | +| [`DrapingData.uptodate`](compolyx.plot_data.DrapingData.uptodate.md#compolyx.plot_data.DrapingData.uptodate) | Whether the plot is uptodate | +| [`DrapingData.vertex`](compolyx.plot_data.DrapingData.vertex.md#compolyx.plot_data.DrapingData.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`DrapingData.add_data_scope_entity`](compolyx.plot_data.DrapingData.add_data_scope_entity.md#compolyx.plot_data.DrapingData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot. | -| [`DrapingData.clear_data_scope`](compolyx.plot_data.DrapingData.clear_data_scope.md#compolyx.plot_data.DrapingData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. | -| [`DrapingData.display_data_create`](compolyx.plot_data.DrapingData.display_data_create.md#compolyx.plot_data.DrapingData.display_data_create)([parent]) | Function for internal use, not meant for scripting. | -| [`DrapingData.find_parent`](compolyx.plot_data.DrapingData.find_parent.md#compolyx.plot_data.DrapingData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`DrapingData.get_data`](compolyx.plot_data.DrapingData.get_data.md#compolyx.plot_data.DrapingData.get_data)([visible, selected]) | Get data of plot. | -| [`DrapingData.get_deformations`](compolyx.plot_data.DrapingData.get_deformations.md#compolyx.plot_data.DrapingData.get_deformations)([visible, selected]) | Function used internally to query matching nodal deformations for a given plot. | +| [`DrapingData.add_data_scope_entity`](compolyx.plot_data.DrapingData.add_data_scope_entity.md#compolyx.plot_data.DrapingData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot | +| [`DrapingData.clear_data_scope`](compolyx.plot_data.DrapingData.clear_data_scope.md#compolyx.plot_data.DrapingData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once | +| [`DrapingData.display_data_create`](compolyx.plot_data.DrapingData.display_data_create.md#compolyx.plot_data.DrapingData.display_data_create)([parent]) | Function for internal use, not meant for scripting | +| [`DrapingData.find_parent`](compolyx.plot_data.DrapingData.find_parent.md#compolyx.plot_data.DrapingData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`DrapingData.get_data`](compolyx.plot_data.DrapingData.get_data.md#compolyx.plot_data.DrapingData.get_data)([visible, selected]) | Get data of plot | +| [`DrapingData.get_deformations`](compolyx.plot_data.DrapingData.get_deformations.md#compolyx.plot_data.DrapingData.get_deformations)([visible, selected]) | Function used internally to query matching nodal deformations for a given plot | | [`DrapingData.get_element_indices`](compolyx.plot_data.DrapingData.get_element_indices.md#compolyx.plot_data.DrapingData.get_element_indices)([visible, ...]) | Get element indices (ACP internal element numbers starting from 0) of plot | -| [`DrapingData.get_element_labels`](compolyx.plot_data.DrapingData.get_element_labels.md#compolyx.plot_data.DrapingData.get_element_labels)([visible, ...]) | Get element labels (element numbers as read from / written to mesh files) of plot. | -| [`DrapingData.get_full_description`](compolyx.plot_data.DrapingData.get_full_description.md#compolyx.plot_data.DrapingData.get_full_description)() | This function returns information displayed together with the legend. | -| [`DrapingData.obj_exists`](compolyx.plot_data.DrapingData.obj_exists.md#compolyx.plot_data.DrapingData.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. | -| [`DrapingData.remove_data_scope_entity`](compolyx.plot_data.DrapingData.remove_data_scope_entity.md#compolyx.plot_data.DrapingData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot. | +| [`DrapingData.get_element_labels`](compolyx.plot_data.DrapingData.get_element_labels.md#compolyx.plot_data.DrapingData.get_element_labels)([visible, ...]) | Get element labels (element numbers as read from / written to mesh files) of plot | +| [`DrapingData.get_full_description`](compolyx.plot_data.DrapingData.get_full_description.md#compolyx.plot_data.DrapingData.get_full_description)() | This function returns information displayed together with the legend | +| [`DrapingData.obj_exists`](compolyx.plot_data.DrapingData.obj_exists.md#compolyx.plot_data.DrapingData.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 | +| [`DrapingData.remove_data_scope_entity`](compolyx.plot_data.DrapingData.remove_data_scope_entity.md#compolyx.plot_data.DrapingData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot | | [`DrapingData.serialize`](compolyx.plot_data.DrapingData.serialize.md#compolyx.plot_data.DrapingData.serialize)() | Serialize to Python string | | [`DrapingData.serialize_create_function`](compolyx.plot_data.DrapingData.serialize_create_function.md#compolyx.plot_data.DrapingData.serialize_create_function)() | | -| [`DrapingData.serialize_name_and_id`](compolyx.plot_data.DrapingData.serialize_name_and_id.md#compolyx.plot_data.DrapingData.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`DrapingData.serialize_name_and_id`](compolyx.plot_data.DrapingData.serialize_name_and_id.md#compolyx.plot_data.DrapingData.serialize_name_and_id)() | Helper function to serialize name and ID | | [`DrapingData.serialize_properties`](compolyx.plot_data.DrapingData.serialize_properties.md#compolyx.plot_data.DrapingData.serialize_properties)() | Serialize to Python string | | [`DrapingData.serialize_python_only_attributes`](compolyx.plot_data.DrapingData.serialize_python_only_attributes.md#compolyx.plot_data.DrapingData.serialize_python_only_attributes)() | | | [`DrapingData.update`](compolyx.plot_data.DrapingData.update.md#compolyx.plot_data.DrapingData.update)() | | -| [`DrapingData.visit`](compolyx.plot_data.DrapingData.visit.md#compolyx.plot_data.DrapingData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`DrapingData.visit`](compolyx.plot_data.DrapingData.visit.md#compolyx.plot_data.DrapingData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.obj_exists.md index 977806ac64..9db5c8fa76 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.obj_exists.md @@ -4,5 +4,5 @@ #### DrapingData.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.remove_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.remove_data_scope_entity.md index a11b4c6403..621b301b59 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.remove_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.remove_data_scope_entity.md @@ -7,10 +7,10 @@ Remove 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be removed. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be removed. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** -: Remove the Element Set “My_ESet” from my_plot: + Remove the Element Set “My_ESet” from my_plot:
```default >>> my_plot.remove_data_scope_entity(entity = db.active_model.element_sets['My_ESet']) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.spot.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.spot.md index 27a2c5fbd0..06dbfcb8ae 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.spot.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.spot.md @@ -4,4 +4,4 @@ #### *property* DrapingData.spot -Whether to plot data at bot, mid or top of the layer or laminate. +Whether to plot data at bot, mid, or top of the layer or laminate. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.updated.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.updated.md index 69789cf04d..c46fe1e864 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.updated.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.updated.md @@ -4,4 +4,4 @@ #### *property* DrapingData.updated -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.uptodate.md index c588510635..7e093e6ffb 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.uptodate.md @@ -4,4 +4,4 @@ #### *property* DrapingData.uptodate -Whether the plot is uptodate. +Whether the plot is up-to-date. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.visit.md index 0b7f16f52c..e1f3d207ab 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.DrapingData.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.add_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.add_data_scope_entity.md index 990b2a7779..d5f27c92e4 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.add_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.add_data_scope_entity.md @@ -7,10 +7,10 @@ Add 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be added. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be added. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** -: Add the Element Set “My_ESet” to a my_plot: + Add the Element Set “My_ESet” to a my_plot:
```default >>> my_plot.add_data_scope_entity(entity = db.active_model.element_sets['My_ESet']) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.changed.md index 858b30edc1..55cd1e8d4b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.changed.md @@ -4,4 +4,4 @@ #### *property* FieldDefinitionData.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.description_changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.description_changed.md index 451a7de3ca..1bea6792ae 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.description_changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.description_changed.md @@ -4,4 +4,4 @@ #### *property* FieldDefinitionData.description_changed -Status boolean. Set to true if the object’s description has been changed. Write only property +Status boolean. Set to true if the object’s description has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.enabled.md index acead5cada..f084cd1c03 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.enabled.md @@ -4,4 +4,4 @@ #### *property* FieldDefinitionData.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.is_dict_item.md index c0a4a68423..3dc6345c67 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* FieldDefinitionData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.is_list_item.md index 3cca5fcc70..6bedc8ddd9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* FieldDefinitionData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.md index 4efa07c5c5..d8f9036360 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.md @@ -8,24 +8,24 @@ | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| [`FieldDefinitionData.active`](compolyx.plot_data.FieldDefinitionData.active.md#compolyx.plot_data.FieldDefinitionData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data. | +| [`FieldDefinitionData.active`](compolyx.plot_data.FieldDefinitionData.active.md#compolyx.plot_data.FieldDefinitionData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data | | [`FieldDefinitionData.active_display_data`](compolyx.plot_data.FieldDefinitionData.active_display_data.md#compolyx.plot_data.FieldDefinitionData.active_display_data) | Returns a dictionary containing display data for this plot owned by the active scene | | [`FieldDefinitionData.all_display_data`](compolyx.plot_data.FieldDefinitionData.all_display_data.md#compolyx.plot_data.FieldDefinitionData.all_display_data) | Returns a list of all display data classes in existence for this object | -| [`FieldDefinitionData.changed`](compolyx.plot_data.FieldDefinitionData.changed.md#compolyx.plot_data.FieldDefinitionData.changed) | Status boolean. | +| [`FieldDefinitionData.changed`](compolyx.plot_data.FieldDefinitionData.changed.md#compolyx.plot_data.FieldDefinitionData.changed) | Status boolean | | [`FieldDefinitionData.color_table`](compolyx.plot_data.FieldDefinitionData.color_table.md#compolyx.plot_data.FieldDefinitionData.color_table) | | -| [`FieldDefinitionData.component`](compolyx.plot_data.FieldDefinitionData.component.md#compolyx.plot_data.FieldDefinitionData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction. | +| [`FieldDefinitionData.component`](compolyx.plot_data.FieldDefinitionData.component.md#compolyx.plot_data.FieldDefinitionData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction | | [`FieldDefinitionData.components`](compolyx.plot_data.FieldDefinitionData.components.md#compolyx.plot_data.FieldDefinitionData.components) | Return the possible component set on this plot type | -| [`FieldDefinitionData.data_scope`](compolyx.plot_data.FieldDefinitionData.data_scope.md#compolyx.plot_data.FieldDefinitionData.data_scope) | Data scope of the plot where results will be evaluated. | +| [`FieldDefinitionData.data_scope`](compolyx.plot_data.FieldDefinitionData.data_scope.md#compolyx.plot_data.FieldDefinitionData.data_scope) | Data scope of the plot where results will be evaluated | | [`FieldDefinitionData.definition_id`](compolyx.plot_data.FieldDefinitionData.definition_id.md#compolyx.plot_data.FieldDefinitionData.definition_id) | | -| [`FieldDefinitionData.description_changed`](compolyx.plot_data.FieldDefinitionData.description_changed.md#compolyx.plot_data.FieldDefinitionData.description_changed) | Status boolean. | -| [`FieldDefinitionData.enabled`](compolyx.plot_data.FieldDefinitionData.enabled.md#compolyx.plot_data.FieldDefinitionData.enabled) | Whether this object is currently enabled or not. | -| [`FieldDefinitionData.eval_position`](compolyx.plot_data.FieldDefinitionData.eval_position.md#compolyx.plot_data.FieldDefinitionData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal. | -| [`FieldDefinitionData.field_variable_name`](compolyx.plot_data.FieldDefinitionData.field_variable_name.md#compolyx.plot_data.FieldDefinitionData.field_variable_name) | The underlying field variable name. | -| [`FieldDefinitionData.has_element_wise`](compolyx.plot_data.FieldDefinitionData.has_element_wise.md#compolyx.plot_data.FieldDefinitionData.has_element_wise) | Whether the plot offers element-wise data. | -| [`FieldDefinitionData.has_ply_wise`](compolyx.plot_data.FieldDefinitionData.has_ply_wise.md#compolyx.plot_data.FieldDefinitionData.has_ply_wise) | Whether the plot offers ply-wise data. | +| [`FieldDefinitionData.description_changed`](compolyx.plot_data.FieldDefinitionData.description_changed.md#compolyx.plot_data.FieldDefinitionData.description_changed) | Status boolean | +| [`FieldDefinitionData.enabled`](compolyx.plot_data.FieldDefinitionData.enabled.md#compolyx.plot_data.FieldDefinitionData.enabled) | Whether this object is currently enabled or not | +| [`FieldDefinitionData.eval_position`](compolyx.plot_data.FieldDefinitionData.eval_position.md#compolyx.plot_data.FieldDefinitionData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal | +| [`FieldDefinitionData.field_variable_name`](compolyx.plot_data.FieldDefinitionData.field_variable_name.md#compolyx.plot_data.FieldDefinitionData.field_variable_name) | The underlying field variable name | +| [`FieldDefinitionData.has_element_wise`](compolyx.plot_data.FieldDefinitionData.has_element_wise.md#compolyx.plot_data.FieldDefinitionData.has_element_wise) | Whether the plot offers element-wise data | +| [`FieldDefinitionData.has_ply_wise`](compolyx.plot_data.FieldDefinitionData.has_ply_wise.md#compolyx.plot_data.FieldDefinitionData.has_ply_wise) | Whether the plot offers ply-wise data | | [`FieldDefinitionData.id`](compolyx.plot_data.FieldDefinitionData.id.md#compolyx.plot_data.FieldDefinitionData.id) | ID of object | -| [`FieldDefinitionData.is_dict_item`](compolyx.plot_data.FieldDefinitionData.is_dict_item.md#compolyx.plot_data.FieldDefinitionData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`FieldDefinitionData.is_list_item`](compolyx.plot_data.FieldDefinitionData.is_list_item.md#compolyx.plot_data.FieldDefinitionData.is_list_item) | Specifies wether the object is an item of a list | +| [`FieldDefinitionData.is_dict_item`](compolyx.plot_data.FieldDefinitionData.is_dict_item.md#compolyx.plot_data.FieldDefinitionData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`FieldDefinitionData.is_list_item`](compolyx.plot_data.FieldDefinitionData.is_list_item.md#compolyx.plot_data.FieldDefinitionData.is_list_item) | Specifies whether the object is an item of a list | | [`FieldDefinitionData.link_path`](compolyx.plot_data.FieldDefinitionData.link_path.md#compolyx.plot_data.FieldDefinitionData.link_path) | Root path of the current node in the tree for links to this object | | [`FieldDefinitionData.locked`](compolyx.plot_data.FieldDefinitionData.locked.md#compolyx.plot_data.FieldDefinitionData.locked) | Returns the locked status of the plot | | [`FieldDefinitionData.minmax`](compolyx.plot_data.FieldDefinitionData.minmax.md#compolyx.plot_data.FieldDefinitionData.minmax) | Min and max value of current data | @@ -33,43 +33,43 @@ | [`FieldDefinitionData.name`](compolyx.plot_data.FieldDefinitionData.name.md#compolyx.plot_data.FieldDefinitionData.name) | Name of object | | [`FieldDefinitionData.parent`](compolyx.plot_data.FieldDefinitionData.parent.md#compolyx.plot_data.FieldDefinitionData.parent) | Parent object in tree | | [`FieldDefinitionData.ply_offset_scale_factor`](compolyx.plot_data.FieldDefinitionData.ply_offset_scale_factor.md#compolyx.plot_data.FieldDefinitionData.ply_offset_scale_factor) | Offset scale factor | -| [`FieldDefinitionData.ply_wise`](compolyx.plot_data.FieldDefinitionData.ply_wise.md#compolyx.plot_data.FieldDefinitionData.ply_wise) | Whether to plot ply-wise or element-wise. | +| [`FieldDefinitionData.ply_wise`](compolyx.plot_data.FieldDefinitionData.ply_wise.md#compolyx.plot_data.FieldDefinitionData.ply_wise) | Whether to plot ply-wise or element-wise | | [`FieldDefinitionData.requires_solution`](compolyx.plot_data.FieldDefinitionData.requires_solution.md#compolyx.plot_data.FieldDefinitionData.requires_solution) | | | [`FieldDefinitionData.root_path`](compolyx.plot_data.FieldDefinitionData.root_path.md#compolyx.plot_data.FieldDefinitionData.root_path) | Root path of the current node in the tree | -| [`FieldDefinitionData.scope_entire_model`](compolyx.plot_data.FieldDefinitionData.scope_entire_model.md#compolyx.plot_data.FieldDefinitionData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope. | -| [`FieldDefinitionData.show_on_solids`](compolyx.plot_data.FieldDefinitionData.show_on_solids.md#compolyx.plot_data.FieldDefinitionData.show_on_solids) | Whether to plot results on solid or shell elements. | +| [`FieldDefinitionData.scope_entire_model`](compolyx.plot_data.FieldDefinitionData.scope_entire_model.md#compolyx.plot_data.FieldDefinitionData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope | +| [`FieldDefinitionData.show_on_solids`](compolyx.plot_data.FieldDefinitionData.show_on_solids.md#compolyx.plot_data.FieldDefinitionData.show_on_solids) | Whether to plot results on solid or shell elements | | [`FieldDefinitionData.show_ply_offsets`](compolyx.plot_data.FieldDefinitionData.show_ply_offsets.md#compolyx.plot_data.FieldDefinitionData.show_ply_offsets) | | -| [`FieldDefinitionData.solution`](compolyx.plot_data.FieldDefinitionData.solution.md#compolyx.plot_data.FieldDefinitionData.solution) | Solution underlying the plot. | -| [`FieldDefinitionData.solution_set`](compolyx.plot_data.FieldDefinitionData.solution_set.md#compolyx.plot_data.FieldDefinitionData.solution_set) | Solution Set selection. | +| [`FieldDefinitionData.solution`](compolyx.plot_data.FieldDefinitionData.solution.md#compolyx.plot_data.FieldDefinitionData.solution) | Solution underlying the plot | +| [`FieldDefinitionData.solution_set`](compolyx.plot_data.FieldDefinitionData.solution_set.md#compolyx.plot_data.FieldDefinitionData.solution_set) | Solution Set selection | | [`FieldDefinitionData.spot`](compolyx.plot_data.FieldDefinitionData.spot.md#compolyx.plot_data.FieldDefinitionData.spot) | Not applicable to a field definition plot | | [`FieldDefinitionData.spots`](compolyx.plot_data.FieldDefinitionData.spots.md#compolyx.plot_data.FieldDefinitionData.spots) | Return the possible spot set on this plot type | | [`FieldDefinitionData.status`](compolyx.plot_data.FieldDefinitionData.status.md#compolyx.plot_data.FieldDefinitionData.status) | Status of the object | -| [`FieldDefinitionData.status_changed`](compolyx.plot_data.FieldDefinitionData.status_changed.md#compolyx.plot_data.FieldDefinitionData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`FieldDefinitionData.status_changed`](compolyx.plot_data.FieldDefinitionData.status_changed.md#compolyx.plot_data.FieldDefinitionData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`FieldDefinitionData.uid`](compolyx.plot_data.FieldDefinitionData.uid.md#compolyx.plot_data.FieldDefinitionData.uid) | UID of object | -| [`FieldDefinitionData.updated`](compolyx.plot_data.FieldDefinitionData.updated.md#compolyx.plot_data.FieldDefinitionData.updated) | Status boolean. | -| [`FieldDefinitionData.uptodate`](compolyx.plot_data.FieldDefinitionData.uptodate.md#compolyx.plot_data.FieldDefinitionData.uptodate) | Whether the plot is uptodate. | -| [`FieldDefinitionData.vertex`](compolyx.plot_data.FieldDefinitionData.vertex.md#compolyx.plot_data.FieldDefinitionData.vertex) | This will throw an error if the object has been removed from the graph. | +| [`FieldDefinitionData.updated`](compolyx.plot_data.FieldDefinitionData.updated.md#compolyx.plot_data.FieldDefinitionData.updated) | Status boolean | +| [`FieldDefinitionData.uptodate`](compolyx.plot_data.FieldDefinitionData.uptodate.md#compolyx.plot_data.FieldDefinitionData.uptodate) | Whether the plot is uptodate | +| [`FieldDefinitionData.vertex`](compolyx.plot_data.FieldDefinitionData.vertex.md#compolyx.plot_data.FieldDefinitionData.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`FieldDefinitionData.add_data_scope_entity`](compolyx.plot_data.FieldDefinitionData.add_data_scope_entity.md#compolyx.plot_data.FieldDefinitionData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot. | -| [`FieldDefinitionData.clear_data_scope`](compolyx.plot_data.FieldDefinitionData.clear_data_scope.md#compolyx.plot_data.FieldDefinitionData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. | -| [`FieldDefinitionData.display_data_create`](compolyx.plot_data.FieldDefinitionData.display_data_create.md#compolyx.plot_data.FieldDefinitionData.display_data_create)([parent]) | Function for internal use, not meant for scripting. | -| [`FieldDefinitionData.find_parent`](compolyx.plot_data.FieldDefinitionData.find_parent.md#compolyx.plot_data.FieldDefinitionData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`FieldDefinitionData.get_data`](compolyx.plot_data.FieldDefinitionData.get_data.md#compolyx.plot_data.FieldDefinitionData.get_data)([visible, selected]) | Get data of plot. | -| [`FieldDefinitionData.get_deformations`](compolyx.plot_data.FieldDefinitionData.get_deformations.md#compolyx.plot_data.FieldDefinitionData.get_deformations)([...]) | Function used internally to query matching nodal deformations for a given plot. | +| [`FieldDefinitionData.add_data_scope_entity`](compolyx.plot_data.FieldDefinitionData.add_data_scope_entity.md#compolyx.plot_data.FieldDefinitionData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot | +| [`FieldDefinitionData.clear_data_scope`](compolyx.plot_data.FieldDefinitionData.clear_data_scope.md#compolyx.plot_data.FieldDefinitionData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once | +| [`FieldDefinitionData.display_data_create`](compolyx.plot_data.FieldDefinitionData.display_data_create.md#compolyx.plot_data.FieldDefinitionData.display_data_create)([parent]) | Function for internal use, not meant for scripting | +| [`FieldDefinitionData.find_parent`](compolyx.plot_data.FieldDefinitionData.find_parent.md#compolyx.plot_data.FieldDefinitionData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`FieldDefinitionData.get_data`](compolyx.plot_data.FieldDefinitionData.get_data.md#compolyx.plot_data.FieldDefinitionData.get_data)([visible, selected]) | Get data of plot | +| [`FieldDefinitionData.get_deformations`](compolyx.plot_data.FieldDefinitionData.get_deformations.md#compolyx.plot_data.FieldDefinitionData.get_deformations)([...]) | Function used internally to query matching nodal deformations for a given plot | | [`FieldDefinitionData.get_element_indices`](compolyx.plot_data.FieldDefinitionData.get_element_indices.md#compolyx.plot_data.FieldDefinitionData.get_element_indices)([...]) | Get element indices (ACP internal element numbers starting from 0) of plot | -| [`FieldDefinitionData.get_element_labels`](compolyx.plot_data.FieldDefinitionData.get_element_labels.md#compolyx.plot_data.FieldDefinitionData.get_element_labels)([...]) | Get element labels (element numbers as read from / written to mesh files) of plot. | -| [`FieldDefinitionData.get_full_description`](compolyx.plot_data.FieldDefinitionData.get_full_description.md#compolyx.plot_data.FieldDefinitionData.get_full_description)() | This function returns information displayed together with the legend. | -| [`FieldDefinitionData.get_ply_offsets`](compolyx.plot_data.FieldDefinitionData.get_ply_offsets.md#compolyx.plot_data.FieldDefinitionData.get_ply_offsets)([...]) | Get the offset between plies and reference surface. | -| [`FieldDefinitionData.obj_exists`](compolyx.plot_data.FieldDefinitionData.obj_exists.md#compolyx.plot_data.FieldDefinitionData.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. | -| [`FieldDefinitionData.remove_data_scope_entity`](compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity.md#compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot. | +| [`FieldDefinitionData.get_element_labels`](compolyx.plot_data.FieldDefinitionData.get_element_labels.md#compolyx.plot_data.FieldDefinitionData.get_element_labels)([...]) | Get element labels (element numbers as read from / written to mesh files) of plot | +| [`FieldDefinitionData.get_full_description`](compolyx.plot_data.FieldDefinitionData.get_full_description.md#compolyx.plot_data.FieldDefinitionData.get_full_description)() | This function returns information displayed together with the legend | +| [`FieldDefinitionData.get_ply_offsets`](compolyx.plot_data.FieldDefinitionData.get_ply_offsets.md#compolyx.plot_data.FieldDefinitionData.get_ply_offsets)([...]) | Get the offset between plies and reference surface | +| [`FieldDefinitionData.obj_exists`](compolyx.plot_data.FieldDefinitionData.obj_exists.md#compolyx.plot_data.FieldDefinitionData.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 | +| [`FieldDefinitionData.remove_data_scope_entity`](compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity.md#compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot | | [`FieldDefinitionData.serialize`](compolyx.plot_data.FieldDefinitionData.serialize.md#compolyx.plot_data.FieldDefinitionData.serialize)() | Serialize to Python string | | [`FieldDefinitionData.serialize_create_function`](compolyx.plot_data.FieldDefinitionData.serialize_create_function.md#compolyx.plot_data.FieldDefinitionData.serialize_create_function)() | | -| [`FieldDefinitionData.serialize_name_and_id`](compolyx.plot_data.FieldDefinitionData.serialize_name_and_id.md#compolyx.plot_data.FieldDefinitionData.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`FieldDefinitionData.serialize_name_and_id`](compolyx.plot_data.FieldDefinitionData.serialize_name_and_id.md#compolyx.plot_data.FieldDefinitionData.serialize_name_and_id)() | Helper function to serialize name and ID | | [`FieldDefinitionData.serialize_properties`](compolyx.plot_data.FieldDefinitionData.serialize_properties.md#compolyx.plot_data.FieldDefinitionData.serialize_properties)() | Serialize to Python string | | [`FieldDefinitionData.serialize_python_only_attributes`](compolyx.plot_data.FieldDefinitionData.serialize_python_only_attributes.md#compolyx.plot_data.FieldDefinitionData.serialize_python_only_attributes)() | | | [`FieldDefinitionData.update`](compolyx.plot_data.FieldDefinitionData.update.md#compolyx.plot_data.FieldDefinitionData.update)() | | -| [`FieldDefinitionData.visit`](compolyx.plot_data.FieldDefinitionData.visit.md#compolyx.plot_data.FieldDefinitionData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`FieldDefinitionData.visit`](compolyx.plot_data.FieldDefinitionData.visit.md#compolyx.plot_data.FieldDefinitionData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.obj_exists.md index a1b3dd1dd1..5d09b2935d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.obj_exists.md @@ -4,5 +4,5 @@ #### FieldDefinitionData.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity.md index 96dbaef8c1..786a95b191 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity.md @@ -7,7 +7,7 @@ Remove 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be removed. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be removed. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** : Remove the Element Set “My_ESet” from my_plot: diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.updated.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.updated.md index 94cc11caa6..cb396b5f0d 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.updated.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.updated.md @@ -4,4 +4,4 @@ #### *property* FieldDefinitionData.updated -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.uptodate.md index 235ca5c1e3..cdb3f05a4f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.uptodate.md @@ -4,4 +4,4 @@ #### *property* FieldDefinitionData.uptodate -Whether the plot is uptodate. +Whether the plot is up-to-date. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.visit.md index a7fad28962..1d693c39bc 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.FieldDefinitionData.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.add_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.add_data_scope_entity.md index 137a83f955..8e090afacf 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.add_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.add_data_scope_entity.md @@ -7,10 +7,10 @@ Add 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be added. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be added. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** -: Add the Element Set “My_ESet” to a my_plot: + Add the Element Set “My_ESet” to a my_plot:
```default >>> my_plot.add_data_scope_entity(entity = db.active_model.element_sets['My_ESet']) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.changed.md index b56df957a8..c89014ab09 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.changed.md @@ -4,4 +4,4 @@ #### *property* LayupMappingData.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.description_changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.description_changed.md index 528eecdfe5..5f624abf87 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.description_changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.description_changed.md @@ -4,4 +4,4 @@ #### *property* LayupMappingData.description_changed -Status boolean. Set to true if the object’s description has been changed. Write only property +Status boolean. Set to true if the object’s description has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.enabled.md index 8bd59561cb..7c4c3c4949 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.enabled.md @@ -4,4 +4,4 @@ #### *property* LayupMappingData.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.get_data.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.get_data.md index 7f96a22baa..949ff338a7 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.get_data.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.get_data.md @@ -19,7 +19,7 @@ Get data of plot. Data is returned independent of update status of plot, but only if results for the current plot configuration are available, else an empty array is returned. Examples: -: Get data for current ply-wise plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected: + Get data for current ply-wise plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected:
```default >>> data = my_plot.get_data(visible=db.active_model.element_sets['All_Elements'], selected=[ply1, ply2]) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.get_ply_offsets.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.get_ply_offsets.md index 04b2a4f6f9..fb92e6a664 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.get_ply_offsets.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.get_ply_offsets.md @@ -17,9 +17,9 @@ Get the offset between plies and reference surface. ] The scope of the data is evaluated as the intersection of - > - data_scope of plot - > - visible_scope defined by visible - > - selection_scope defined by selected + - data_scope of plot + - visible_scope defined by visible + - selection_scope defined by selected **Example:** : Get the ply-offsets for the current ply-wise plot with visible scope set to element set “All_Elements” and with ply1 and ply2 selected: diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.is_dict_item.md index ea58c7c97d..915bdb8692 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* LayupMappingData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.is_list_item.md index 9bda8b0118..c554a865c3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* LayupMappingData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.md index 9ab2d169f6..c2749cb3ee 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.md @@ -8,23 +8,23 @@ | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| [`LayupMappingData.active`](compolyx.plot_data.LayupMappingData.active.md#compolyx.plot_data.LayupMappingData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data. | +| [`LayupMappingData.active`](compolyx.plot_data.LayupMappingData.active.md#compolyx.plot_data.LayupMappingData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data | | [`LayupMappingData.active_display_data`](compolyx.plot_data.LayupMappingData.active_display_data.md#compolyx.plot_data.LayupMappingData.active_display_data) | Returns a dictionary containing display data for this plot owned by the active scene | | [`LayupMappingData.all_display_data`](compolyx.plot_data.LayupMappingData.all_display_data.md#compolyx.plot_data.LayupMappingData.all_display_data) | Returns a list of all display data classes in existence for this object | -| [`LayupMappingData.changed`](compolyx.plot_data.LayupMappingData.changed.md#compolyx.plot_data.LayupMappingData.changed) | Status boolean. | +| [`LayupMappingData.changed`](compolyx.plot_data.LayupMappingData.changed.md#compolyx.plot_data.LayupMappingData.changed) | Status boolean | | [`LayupMappingData.color_table`](compolyx.plot_data.LayupMappingData.color_table.md#compolyx.plot_data.LayupMappingData.color_table) | | -| [`LayupMappingData.component`](compolyx.plot_data.LayupMappingData.component.md#compolyx.plot_data.LayupMappingData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction. | +| [`LayupMappingData.component`](compolyx.plot_data.LayupMappingData.component.md#compolyx.plot_data.LayupMappingData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction | | [`LayupMappingData.components`](compolyx.plot_data.LayupMappingData.components.md#compolyx.plot_data.LayupMappingData.components) | Return the possible component set on this plot type | -| [`LayupMappingData.data_scope`](compolyx.plot_data.LayupMappingData.data_scope.md#compolyx.plot_data.LayupMappingData.data_scope) | Data scope of the plot where results will be evaluated. | +| [`LayupMappingData.data_scope`](compolyx.plot_data.LayupMappingData.data_scope.md#compolyx.plot_data.LayupMappingData.data_scope) | Data scope of the plot where results will be evaluated | | [`LayupMappingData.definition_id`](compolyx.plot_data.LayupMappingData.definition_id.md#compolyx.plot_data.LayupMappingData.definition_id) | | -| [`LayupMappingData.description_changed`](compolyx.plot_data.LayupMappingData.description_changed.md#compolyx.plot_data.LayupMappingData.description_changed) | Status boolean. | -| [`LayupMappingData.enabled`](compolyx.plot_data.LayupMappingData.enabled.md#compolyx.plot_data.LayupMappingData.enabled) | Whether this object is currently enabled or not. | -| [`LayupMappingData.eval_position`](compolyx.plot_data.LayupMappingData.eval_position.md#compolyx.plot_data.LayupMappingData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal. | -| [`LayupMappingData.has_element_wise`](compolyx.plot_data.LayupMappingData.has_element_wise.md#compolyx.plot_data.LayupMappingData.has_element_wise) | Whether the plot offers element-wise data. | -| [`LayupMappingData.has_ply_wise`](compolyx.plot_data.LayupMappingData.has_ply_wise.md#compolyx.plot_data.LayupMappingData.has_ply_wise) | Whether the plot offers ply-wise data. | +| [`LayupMappingData.description_changed`](compolyx.plot_data.LayupMappingData.description_changed.md#compolyx.plot_data.LayupMappingData.description_changed) | Status boolean | +| [`LayupMappingData.enabled`](compolyx.plot_data.LayupMappingData.enabled.md#compolyx.plot_data.LayupMappingData.enabled) | Whether this object is currently enabled or not | +| [`LayupMappingData.eval_position`](compolyx.plot_data.LayupMappingData.eval_position.md#compolyx.plot_data.LayupMappingData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal | +| [`LayupMappingData.has_element_wise`](compolyx.plot_data.LayupMappingData.has_element_wise.md#compolyx.plot_data.LayupMappingData.has_element_wise) | Whether the plot offers element-wise data | +| [`LayupMappingData.has_ply_wise`](compolyx.plot_data.LayupMappingData.has_ply_wise.md#compolyx.plot_data.LayupMappingData.has_ply_wise) | Whether the plot offers ply-wise data | | [`LayupMappingData.id`](compolyx.plot_data.LayupMappingData.id.md#compolyx.plot_data.LayupMappingData.id) | ID of object | -| [`LayupMappingData.is_dict_item`](compolyx.plot_data.LayupMappingData.is_dict_item.md#compolyx.plot_data.LayupMappingData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`LayupMappingData.is_list_item`](compolyx.plot_data.LayupMappingData.is_list_item.md#compolyx.plot_data.LayupMappingData.is_list_item) | Specifies wether the object is an item of a list | +| [`LayupMappingData.is_dict_item`](compolyx.plot_data.LayupMappingData.is_dict_item.md#compolyx.plot_data.LayupMappingData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`LayupMappingData.is_list_item`](compolyx.plot_data.LayupMappingData.is_list_item.md#compolyx.plot_data.LayupMappingData.is_list_item) | Specifies whether the object is an item of a list | | [`LayupMappingData.link_path`](compolyx.plot_data.LayupMappingData.link_path.md#compolyx.plot_data.LayupMappingData.link_path) | Root path of the current node in the tree for links to this object | | [`LayupMappingData.locked`](compolyx.plot_data.LayupMappingData.locked.md#compolyx.plot_data.LayupMappingData.locked) | Returns the locked status of the plot | | [`LayupMappingData.minmax`](compolyx.plot_data.LayupMappingData.minmax.md#compolyx.plot_data.LayupMappingData.minmax) | Min and max value of current data | @@ -32,43 +32,43 @@ | [`LayupMappingData.name`](compolyx.plot_data.LayupMappingData.name.md#compolyx.plot_data.LayupMappingData.name) | Name of object | | [`LayupMappingData.parent`](compolyx.plot_data.LayupMappingData.parent.md#compolyx.plot_data.LayupMappingData.parent) | Parent object in tree | | [`LayupMappingData.ply_offset_scale_factor`](compolyx.plot_data.LayupMappingData.ply_offset_scale_factor.md#compolyx.plot_data.LayupMappingData.ply_offset_scale_factor) | Offset scale factor | -| [`LayupMappingData.ply_wise`](compolyx.plot_data.LayupMappingData.ply_wise.md#compolyx.plot_data.LayupMappingData.ply_wise) | Whether to plot ply-wise or element-wise. | +| [`LayupMappingData.ply_wise`](compolyx.plot_data.LayupMappingData.ply_wise.md#compolyx.plot_data.LayupMappingData.ply_wise) | Whether to plot ply-wise or element-wise | | [`LayupMappingData.requires_solution`](compolyx.plot_data.LayupMappingData.requires_solution.md#compolyx.plot_data.LayupMappingData.requires_solution) | | | [`LayupMappingData.root_path`](compolyx.plot_data.LayupMappingData.root_path.md#compolyx.plot_data.LayupMappingData.root_path) | Root path of the current node in the tree | -| [`LayupMappingData.scope_entire_model`](compolyx.plot_data.LayupMappingData.scope_entire_model.md#compolyx.plot_data.LayupMappingData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope. | -| [`LayupMappingData.show_on_solids`](compolyx.plot_data.LayupMappingData.show_on_solids.md#compolyx.plot_data.LayupMappingData.show_on_solids) | Whether to plot results on solid or shell elements. | +| [`LayupMappingData.scope_entire_model`](compolyx.plot_data.LayupMappingData.scope_entire_model.md#compolyx.plot_data.LayupMappingData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope | +| [`LayupMappingData.show_on_solids`](compolyx.plot_data.LayupMappingData.show_on_solids.md#compolyx.plot_data.LayupMappingData.show_on_solids) | Whether to plot results on solid or shell elements | | [`LayupMappingData.show_ply_offsets`](compolyx.plot_data.LayupMappingData.show_ply_offsets.md#compolyx.plot_data.LayupMappingData.show_ply_offsets) | | -| [`LayupMappingData.solution`](compolyx.plot_data.LayupMappingData.solution.md#compolyx.plot_data.LayupMappingData.solution) | Solution underlying the plot. | +| [`LayupMappingData.solution`](compolyx.plot_data.LayupMappingData.solution.md#compolyx.plot_data.LayupMappingData.solution) | Solution underlying the plot | | [`LayupMappingData.solution_set`](compolyx.plot_data.LayupMappingData.solution_set.md#compolyx.plot_data.LayupMappingData.solution_set) | Solution Set selection. | | [`LayupMappingData.spot`](compolyx.plot_data.LayupMappingData.spot.md#compolyx.plot_data.LayupMappingData.spot) | Not applicable to a layup mapping plot | | [`LayupMappingData.spots`](compolyx.plot_data.LayupMappingData.spots.md#compolyx.plot_data.LayupMappingData.spots) | Return the possible spot set on this plot type | | [`LayupMappingData.status`](compolyx.plot_data.LayupMappingData.status.md#compolyx.plot_data.LayupMappingData.status) | Status of the object | -| [`LayupMappingData.status_changed`](compolyx.plot_data.LayupMappingData.status_changed.md#compolyx.plot_data.LayupMappingData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`LayupMappingData.status_changed`](compolyx.plot_data.LayupMappingData.status_changed.md#compolyx.plot_data.LayupMappingData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`LayupMappingData.uid`](compolyx.plot_data.LayupMappingData.uid.md#compolyx.plot_data.LayupMappingData.uid) | UID of object | -| [`LayupMappingData.updated`](compolyx.plot_data.LayupMappingData.updated.md#compolyx.plot_data.LayupMappingData.updated) | Status boolean. | -| [`LayupMappingData.uptodate`](compolyx.plot_data.LayupMappingData.uptodate.md#compolyx.plot_data.LayupMappingData.uptodate) | Whether the plot is uptodate. | -| [`LayupMappingData.vertex`](compolyx.plot_data.LayupMappingData.vertex.md#compolyx.plot_data.LayupMappingData.vertex) | This will throw an error if the object has been removed from the graph. | +| [`LayupMappingData.updated`](compolyx.plot_data.LayupMappingData.updated.md#compolyx.plot_data.LayupMappingData.updated) | Status boolean | +| [`LayupMappingData.uptodate`](compolyx.plot_data.LayupMappingData.uptodate.md#compolyx.plot_data.LayupMappingData.uptodate) | Whether the plot is up-to-date | +| [`LayupMappingData.vertex`](compolyx.plot_data.LayupMappingData.vertex.md#compolyx.plot_data.LayupMappingData.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`LayupMappingData.add_data_scope_entity`](compolyx.plot_data.LayupMappingData.add_data_scope_entity.md#compolyx.plot_data.LayupMappingData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot. | -| [`LayupMappingData.clear_data_scope`](compolyx.plot_data.LayupMappingData.clear_data_scope.md#compolyx.plot_data.LayupMappingData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. | -| [`LayupMappingData.display_data_create`](compolyx.plot_data.LayupMappingData.display_data_create.md#compolyx.plot_data.LayupMappingData.display_data_create)([parent]) | Function for internal use, not meant for scripting. | -| [`LayupMappingData.find_parent`](compolyx.plot_data.LayupMappingData.find_parent.md#compolyx.plot_data.LayupMappingData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`LayupMappingData.get_data`](compolyx.plot_data.LayupMappingData.get_data.md#compolyx.plot_data.LayupMappingData.get_data)([visible, selected]) | Get data of plot. | +| [`LayupMappingData.add_data_scope_entity`](compolyx.plot_data.LayupMappingData.add_data_scope_entity.md#compolyx.plot_data.LayupMappingData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot | +| [`LayupMappingData.clear_data_scope`](compolyx.plot_data.LayupMappingData.clear_data_scope.md#compolyx.plot_data.LayupMappingData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once | +| [`LayupMappingData.display_data_create`](compolyx.plot_data.LayupMappingData.display_data_create.md#compolyx.plot_data.LayupMappingData.display_data_create)([parent]) | Function for internal use, not meant for scripting | +| [`LayupMappingData.find_parent`](compolyx.plot_data.LayupMappingData.find_parent.md#compolyx.plot_data.LayupMappingData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`LayupMappingData.get_data`](compolyx.plot_data.LayupMappingData.get_data.md#compolyx.plot_data.LayupMappingData.get_data)([visible, selected]) | Get data of plot | | [`LayupMappingData.get_deformations`](compolyx.plot_data.LayupMappingData.get_deformations.md#compolyx.plot_data.LayupMappingData.get_deformations)([visible, ...]) | Function used internally to query matching nodal deformations for a given plot. | | [`LayupMappingData.get_element_indices`](compolyx.plot_data.LayupMappingData.get_element_indices.md#compolyx.plot_data.LayupMappingData.get_element_indices)([...]) | Get element indices (ACP internal element numbers starting from 0) of plot | -| [`LayupMappingData.get_element_labels`](compolyx.plot_data.LayupMappingData.get_element_labels.md#compolyx.plot_data.LayupMappingData.get_element_labels)([...]) | Get element labels (element numbers as read from / written to mesh files) of plot. | -| [`LayupMappingData.get_full_description`](compolyx.plot_data.LayupMappingData.get_full_description.md#compolyx.plot_data.LayupMappingData.get_full_description)() | This function returns information displayed together with the legend. | -| [`LayupMappingData.get_ply_offsets`](compolyx.plot_data.LayupMappingData.get_ply_offsets.md#compolyx.plot_data.LayupMappingData.get_ply_offsets)([visible, ...]) | Get the offset between plies and reference surface. | -| [`LayupMappingData.obj_exists`](compolyx.plot_data.LayupMappingData.obj_exists.md#compolyx.plot_data.LayupMappingData.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. | -| [`LayupMappingData.remove_data_scope_entity`](compolyx.plot_data.LayupMappingData.remove_data_scope_entity.md#compolyx.plot_data.LayupMappingData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot. | +| [`LayupMappingData.get_element_labels`](compolyx.plot_data.LayupMappingData.get_element_labels.md#compolyx.plot_data.LayupMappingData.get_element_labels)([...]) | Get element labels (element numbers as read from / written to mesh files) of plot | +| [`LayupMappingData.get_full_description`](compolyx.plot_data.LayupMappingData.get_full_description.md#compolyx.plot_data.LayupMappingData.get_full_description)() | This function returns information displayed together with the legend | +| [`LayupMappingData.get_ply_offsets`](compolyx.plot_data.LayupMappingData.get_ply_offsets.md#compolyx.plot_data.LayupMappingData.get_ply_offsets)([visible, ...]) | Get the offset between plies and reference surface | +| [`LayupMappingData.obj_exists`](compolyx.plot_data.LayupMappingData.obj_exists.md#compolyx.plot_data.LayupMappingData.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 | +| [`LayupMappingData.remove_data_scope_entity`](compolyx.plot_data.LayupMappingData.remove_data_scope_entity.md#compolyx.plot_data.LayupMappingData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot | | [`LayupMappingData.serialize`](compolyx.plot_data.LayupMappingData.serialize.md#compolyx.plot_data.LayupMappingData.serialize)() | Serialize to Python string | | [`LayupMappingData.serialize_create_function`](compolyx.plot_data.LayupMappingData.serialize_create_function.md#compolyx.plot_data.LayupMappingData.serialize_create_function)() | | -| [`LayupMappingData.serialize_name_and_id`](compolyx.plot_data.LayupMappingData.serialize_name_and_id.md#compolyx.plot_data.LayupMappingData.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`LayupMappingData.serialize_name_and_id`](compolyx.plot_data.LayupMappingData.serialize_name_and_id.md#compolyx.plot_data.LayupMappingData.serialize_name_and_id)() | Helper function to serialize name and ID | | [`LayupMappingData.serialize_properties`](compolyx.plot_data.LayupMappingData.serialize_properties.md#compolyx.plot_data.LayupMappingData.serialize_properties)() | Serialize to Python string | | [`LayupMappingData.serialize_python_only_attributes`](compolyx.plot_data.LayupMappingData.serialize_python_only_attributes.md#compolyx.plot_data.LayupMappingData.serialize_python_only_attributes)() | | | [`LayupMappingData.update`](compolyx.plot_data.LayupMappingData.update.md#compolyx.plot_data.LayupMappingData.update)() | | -| [`LayupMappingData.visit`](compolyx.plot_data.LayupMappingData.visit.md#compolyx.plot_data.LayupMappingData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`LayupMappingData.visit`](compolyx.plot_data.LayupMappingData.visit.md#compolyx.plot_data.LayupMappingData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.obj_exists.md index c39085d6ce..bd8ec58ab3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.obj_exists.md @@ -4,5 +4,5 @@ #### LayupMappingData.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.remove_data_scope_entity.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.remove_data_scope_entity.md index 70a24f76c5..b6992905ff 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.remove_data_scope_entity.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.remove_data_scope_entity.md @@ -7,10 +7,10 @@ Remove 1 entity to the Data Scope of a plot. * **Parameters:** - - entity: Entity to be removed. Applicable are Element Set, Oriented Selection Set, Modeling Ply, Production Ply, Analysis Ply, and Sampling Point + - entity: Entity to be removed. Applicable are `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Production Ply`, `Analysis Ply`, and `Sampling Point`. **Example:** -: Remove the Element Set “My_ESet” from my_plot: + Remove the Element Set “My_ESet” from my_plot:
```default >>> my_plot.remove_data_scope_entity(entity = db.active_model.element_sets['My_ESet']) diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.updated.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.updated.md index dc1ad0edcd..5eb0ee1e3a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.updated.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.updated.md @@ -4,4 +4,4 @@ #### *property* LayupMappingData.updated -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.uptodate.md index a1aca0c2f0..abe0680f58 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.uptodate.md @@ -4,4 +4,4 @@ #### *property* LayupMappingData.uptodate -Whether the plot is uptodate. +Whether the plot is up-to-date. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.visit.md index e4ef0cdd3e..6242dc551b 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupMappingData.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_angle_plot.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_angle_plot.md index e45d4cfc9f..32073e3509 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_angle_plot.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_angle_plot.md @@ -9,13 +9,13 @@ Create a Angle Plot object. * **Parameters:** - name: Name of the plot. - id: ID for the plot. - - scope_entire_model: If ‘True’, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope. + - scope_entire_model: If `True`, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope. - data_scope: Object(s) defining the scope for which data is computed and returned. - : Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point. - - show_on_solids: ‘True’ or ‘False’ (default). Whether to show the results on the shell or solid model (if present). - - show_on_section_cuts: Whether to show the results on the surface section cuts as well. Default is ‘True’. - - show_ply_offsets: ‘True’ or ‘False’ (default). Whether to display ply-wise visualizations with ply offsets. - - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True. + Applicable are: `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Sampling Point`. + - show_on_solids: `True` or `False` (default). Whether to show the results on the shell or solid model (if present). + - show_on_section_cuts: Whether to show the results on the surface section cuts as well. Default is `True`. + - show_ply_offsets: `True` or `False` (default). Whether to display ply-wise visualizations with ply offsets. + - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=`True`. * **Returns:** The plot object. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_field_definition_plot.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_field_definition_plot.md index 2603890a04..c714597d99 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_field_definition_plot.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_field_definition_plot.md @@ -9,9 +9,9 @@ Create a FieldDefinition Plot object. * **Parameters:** - name: Name of the plot. - id: ID for the plot. - - scope_entire_model: If ‘True’, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope. - - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply. - - show_on_solids: ‘True’ or ‘False’ (default). Whether to show the results on the shell or solid model (if present). + - scope_entire_model: If `True`, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope. + - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: `Element Set`, `Oriented Selection Set`, `Modeling Ply`. + - show_on_solids: `True` or `False` (default). Whether to show the results on the shell or solid model (if present). * **Returns:** The plot object. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_layup_mapping_plot.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_layup_mapping_plot.md index 9b25b33512..0526a65cab 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_layup_mapping_plot.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_layup_mapping_plot.md @@ -10,8 +10,8 @@ Create a Layup Mapping Plot object. - name: Name of the plot. - id: ID for the plot. - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Imported Solid Model. - - ply_wise: ‘True’ or ‘False’ (default). Decides whether to return the thickness of the individual plies or of the whole stack of plies present at an element. - - show_on_solids: ‘True’ or ‘False’ (default). Whether to show the results on the shell or solid model (if present). + - ply_wise: `True` or `False` (default). Decides whether to return the thickness of the individual plies or of the whole stack of plies present at an element. + - show_on_solids: `True` or `False` (default). Whether to show the results on the shell or solid model (if present). - component: Specifies the active component. - show_on_solids: Whether to show the values of the solid element. - active: Whether the plot is active. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_material_plot.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_material_plot.md index 546522f7b7..aead552634 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_material_plot.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.create_material_plot.md @@ -10,13 +10,13 @@ Create a Material Plot object. - name: Name of the plot. - id: ID for the plot. - active: Whether the plot is active. - - scope_entire_model: If ‘True’, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope. - - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: Element Set, Oriented Selection Set, Modeling Ply, Sampling Point. - - show_on_solids: ‘True’ or ‘False’ (default). Whether to show the results on the shell or solid model (if present). - - show_ply_offsets: ‘True’ or ‘False’ (default). Whether to display ply-wise visualizations with ply offsets. - - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=True. + - scope_entire_model: If `True`, then the scope of this plot is the entire model. If not, then set to false and use the data_scope to specify a sub scope. + - data_scope: Object(s) defining the scope for which data is computed and returned. Applicable are: `Element Set`, `Oriented Selection Set`, `Modeling Ply`, `Sampling Point`. + - show_on_solids: `True` or `False` (default). Whether to show the results on the shell or solid model (if present). + - show_ply_offsets: `True` or `False` (default). Whether to display ply-wise visualizations with ply offsets. + - ply_offset_scale_factor: Scale factor for the offsets of the visualized plies if show_ply_offsets=`True`. - component: Specifies the component. - - use_all_available_fields: ‘True’ (default) or ‘False’. Whether to enable all available field variables in the evaluation. + - use_all_available_fields: `True` (default) or `False`. Whether to enable all available field variables in the evaluation. * **Returns:** The plot object. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.enabled.md index be2ae6a0b6..158426c39c 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.enabled.md @@ -4,4 +4,4 @@ #### *property* LayupPlotDict.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.is_dict_item.md index 41ac9412bb..afe7230589 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* LayupPlotDict.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.is_list_item.md index 87f8de9b68..034bfb1dfb 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.is_list_item.md @@ -4,4 +4,4 @@ #### *property* LayupPlotDict.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.md index 309ea58b5b..a1de016d85 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.md @@ -10,9 +10,9 @@ Container for Layup Plots | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------| -| [`LayupPlotDict.enabled`](compolyx.plot_data.LayupPlotDict.enabled.md#compolyx.plot_data.LayupPlotDict.enabled) | Whether this object is currently enabled or not. | -| [`LayupPlotDict.is_dict_item`](compolyx.plot_data.LayupPlotDict.is_dict_item.md#compolyx.plot_data.LayupPlotDict.is_dict_item) | Specifies wether the object is an item of a dict | -| [`LayupPlotDict.is_list_item`](compolyx.plot_data.LayupPlotDict.is_list_item.md#compolyx.plot_data.LayupPlotDict.is_list_item) | Specifies wether the object is an item of a list | +| [`LayupPlotDict.enabled`](compolyx.plot_data.LayupPlotDict.enabled.md#compolyx.plot_data.LayupPlotDict.enabled) | Whether this object is currently enabled or not | +| [`LayupPlotDict.is_dict_item`](compolyx.plot_data.LayupPlotDict.is_dict_item.md#compolyx.plot_data.LayupPlotDict.is_dict_item) | Specifies whether the object is an item of a dict | +| [`LayupPlotDict.is_list_item`](compolyx.plot_data.LayupPlotDict.is_list_item.md#compolyx.plot_data.LayupPlotDict.is_list_item) | Specifies whether the object is an item of a list | | [`LayupPlotDict.item_type`](compolyx.plot_data.LayupPlotDict.item_type.md#compolyx.plot_data.LayupPlotDict.item_type) | Type of items stored in this UIDict | | [`LayupPlotDict.key_attr`](compolyx.plot_data.LayupPlotDict.key_attr.md#compolyx.plot_data.LayupPlotDict.key_attr) | Name of attribute of item objects which is mapped to the key of the UIDict | | [`LayupPlotDict.label`](compolyx.plot_data.LayupPlotDict.label.md#compolyx.plot_data.LayupPlotDict.label) | | @@ -25,21 +25,21 @@ Container for Layup Plots | Name | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| -| [`LayupPlotDict.append`](compolyx.plot_data.LayupPlotDict.append.md#compolyx.plot_data.LayupPlotDict.append)(value) | Append a new item to the UIDict. | +| [`LayupPlotDict.append`](compolyx.plot_data.LayupPlotDict.append.md#compolyx.plot_data.LayupPlotDict.append)(value) | Append a new item to the UIDict | | [`LayupPlotDict.clear`](compolyx.plot_data.LayupPlotDict.clear.md#compolyx.plot_data.LayupPlotDict.clear)() | | -| [`LayupPlotDict.copy_plot`](compolyx.plot_data.LayupPlotDict.copy_plot.md#compolyx.plot_data.LayupPlotDict.copy_plot)(source) | Copy a plot object. | -| [`LayupPlotDict.create_angle_plot`](compolyx.plot_data.LayupPlotDict.create_angle_plot.md#compolyx.plot_data.LayupPlotDict.create_angle_plot)([name, id, ...]) | Create a Angle Plot object. | -| [`LayupPlotDict.create_draping_plot`](compolyx.plot_data.LayupPlotDict.create_draping_plot.md#compolyx.plot_data.LayupPlotDict.create_draping_plot)([name, ...]) | Create a Draping Plot object. | -| [`LayupPlotDict.create_field_definition_plot`](compolyx.plot_data.LayupPlotDict.create_field_definition_plot.md#compolyx.plot_data.LayupPlotDict.create_field_definition_plot)([...]) | Create a FieldDefinition Plot object. | -| [`LayupPlotDict.create_layup_mapping_plot`](compolyx.plot_data.LayupPlotDict.create_layup_mapping_plot.md#compolyx.plot_data.LayupPlotDict.create_layup_mapping_plot)([...]) | Create a Layup Mapping Plot object. | -| [`LayupPlotDict.create_material_plot`](compolyx.plot_data.LayupPlotDict.create_material_plot.md#compolyx.plot_data.LayupPlotDict.create_material_plot)([name, ...]) | Create a Material Plot object. | -| [`LayupPlotDict.create_scalar_field_plot`](compolyx.plot_data.LayupPlotDict.create_scalar_field_plot.md#compolyx.plot_data.LayupPlotDict.create_scalar_field_plot)([...]) | Create a Field Plot object. | -| [`LayupPlotDict.create_thickness_plot`](compolyx.plot_data.LayupPlotDict.create_thickness_plot.md#compolyx.plot_data.LayupPlotDict.create_thickness_plot)([name, ...]) | Create a Thickness Plot object. | -| [`LayupPlotDict.create_user_defined_plot`](compolyx.plot_data.LayupPlotDict.create_user_defined_plot.md#compolyx.plot_data.LayupPlotDict.create_user_defined_plot)([...]) | Create a User-defined Plot object. | -| [`LayupPlotDict.extend`](compolyx.plot_data.LayupPlotDict.extend.md#compolyx.plot_data.LayupPlotDict.extend)(values) | Extend the UIDict with multiple items at once. | -| [`LayupPlotDict.find`](compolyx.plot_data.LayupPlotDict.find.md#compolyx.plot_data.LayupPlotDict.find)(func) | Return the value of the first value in dict where func(value) == True. | -| [`LayupPlotDict.find_key`](compolyx.plot_data.LayupPlotDict.find_key.md#compolyx.plot_data.LayupPlotDict.find_key)(func) | Return the key of the first value in dict where func(value) == True. | -| [`LayupPlotDict.find_parent`](compolyx.plot_data.LayupPlotDict.find_parent.md#compolyx.plot_data.LayupPlotDict.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`LayupPlotDict.copy_plot`](compolyx.plot_data.LayupPlotDict.copy_plot.md#compolyx.plot_data.LayupPlotDict.copy_plot)(source) | Copy a plot object | +| [`LayupPlotDict.create_angle_plot`](compolyx.plot_data.LayupPlotDict.create_angle_plot.md#compolyx.plot_data.LayupPlotDict.create_angle_plot)([name, id, ...]) | Create a Angle Plot object | +| [`LayupPlotDict.create_draping_plot`](compolyx.plot_data.LayupPlotDict.create_draping_plot.md#compolyx.plot_data.LayupPlotDict.create_draping_plot)([name, ...]) | Create a Draping Plot object | +| [`LayupPlotDict.create_field_definition_plot`](compolyx.plot_data.LayupPlotDict.create_field_definition_plot.md#compolyx.plot_data.LayupPlotDict.create_field_definition_plot)([...]) | Create a FieldDefinition Plot object | +| [`LayupPlotDict.create_layup_mapping_plot`](compolyx.plot_data.LayupPlotDict.create_layup_mapping_plot.md#compolyx.plot_data.LayupPlotDict.create_layup_mapping_plot)([...]) | Create a Layup Mapping Plot object | +| [`LayupPlotDict.create_material_plot`](compolyx.plot_data.LayupPlotDict.create_material_plot.md#compolyx.plot_data.LayupPlotDict.create_material_plot)([name, ...]) | Create a Material Plot object | +| [`LayupPlotDict.create_scalar_field_plot`](compolyx.plot_data.LayupPlotDict.create_scalar_field_plot.md#compolyx.plot_data.LayupPlotDict.create_scalar_field_plot)([...]) | Create a Field Plot object | +| [`LayupPlotDict.create_thickness_plot`](compolyx.plot_data.LayupPlotDict.create_thickness_plot.md#compolyx.plot_data.LayupPlotDict.create_thickness_plot)([name, ...]) | Create a Thickness Plot object | +| [`LayupPlotDict.create_user_defined_plot`](compolyx.plot_data.LayupPlotDict.create_user_defined_plot.md#compolyx.plot_data.LayupPlotDict.create_user_defined_plot)([...]) | Create a User-defined Plot object | +| [`LayupPlotDict.extend`](compolyx.plot_data.LayupPlotDict.extend.md#compolyx.plot_data.LayupPlotDict.extend)(values) | Extend the UIDict with multiple items at once | +| [`LayupPlotDict.find`](compolyx.plot_data.LayupPlotDict.find.md#compolyx.plot_data.LayupPlotDict.find)(func) | Return the value of the first value in dict where func(value) == True | +| [`LayupPlotDict.find_key`](compolyx.plot_data.LayupPlotDict.find_key.md#compolyx.plot_data.LayupPlotDict.find_key)(func) | Return the key of the first value in dict where func(value) == True | +| [`LayupPlotDict.find_parent`](compolyx.plot_data.LayupPlotDict.find_parent.md#compolyx.plot_data.LayupPlotDict.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`LayupPlotDict.get`](compolyx.plot_data.LayupPlotDict.get.md#compolyx.plot_data.LayupPlotDict.get)(key[, default]) | | | [`LayupPlotDict.index`](compolyx.plot_data.LayupPlotDict.index.md#compolyx.plot_data.LayupPlotDict.index)(key) | | | [`LayupPlotDict.items`](compolyx.plot_data.LayupPlotDict.items.md#compolyx.plot_data.LayupPlotDict.items)() | Return ordered list with (key,value) pairs | @@ -48,8 +48,8 @@ Container for Layup Plots | [`LayupPlotDict.itervalues`](compolyx.plot_data.LayupPlotDict.itervalues.md#compolyx.plot_data.LayupPlotDict.itervalues)() | | | [`LayupPlotDict.keys`](compolyx.plot_data.LayupPlotDict.keys.md#compolyx.plot_data.LayupPlotDict.keys)() | | | [`LayupPlotDict.new`](compolyx.plot_data.LayupPlotDict.new.md#compolyx.plot_data.LayupPlotDict.new)(name[, type]) | | -| [`LayupPlotDict.rename`](compolyx.plot_data.LayupPlotDict.rename.md#compolyx.plot_data.LayupPlotDict.rename)(old_name, new_name) | Rename function which updates the name of the object by calling obj._update_name(new_name). | +| [`LayupPlotDict.rename`](compolyx.plot_data.LayupPlotDict.rename.md#compolyx.plot_data.LayupPlotDict.rename)(old_name, new_name) | Rename function which updates the name of the object by calling obj._update_name(new_name) | | [`LayupPlotDict.sort`](compolyx.plot_data.LayupPlotDict.sort.md#compolyx.plot_data.LayupPlotDict.sort)([cmp, key, reverse]) | | | [`LayupPlotDict.update_key`](compolyx.plot_data.LayupPlotDict.update_key.md#compolyx.plot_data.LayupPlotDict.update_key)(old) | Update old key of object to the current value of the key_attr attribute of this object | | [`LayupPlotDict.values`](compolyx.plot_data.LayupPlotDict.values.md#compolyx.plot_data.LayupPlotDict.values)() | | -| [`LayupPlotDict.visit`](compolyx.plot_data.LayupPlotDict.visit.md#compolyx.plot_data.LayupPlotDict.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`LayupPlotDict.visit`](compolyx.plot_data.LayupPlotDict.visit.md#compolyx.plot_data.LayupPlotDict.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.visit.md index a44cbb208d..b025abea79 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.LayupPlotDict.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.description_changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.description_changed.md index bb7449f3d1..a6fca03b0a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.description_changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.description_changed.md @@ -4,4 +4,4 @@ #### *property* PlotData.description_changed -Status boolean. Set to true if the object’s description has been changed. Write only property +Status boolean. Set to true if the object’s description has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.enabled.md index 71138d4b57..06ac3a0388 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.enabled.md @@ -4,4 +4,4 @@ #### *property* PlotData.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.is_dict_item.md index 4eb6719871..e611daa51f 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* PlotData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.is_list_item.md index 099fde8694..ec10a97599 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* PlotData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.md index 2d27bad7fa..637e5d7390 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.md @@ -8,61 +8,61 @@ | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| [`PlotData.active`](compolyx.plot_data.PlotData.active.md#compolyx.plot_data.PlotData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data. | +| [`PlotData.active`](compolyx.plot_data.PlotData.active.md#compolyx.plot_data.PlotData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data | | [`PlotData.active_display_data`](compolyx.plot_data.PlotData.active_display_data.md#compolyx.plot_data.PlotData.active_display_data) | Returns a dictionary containing display data for this plot owned by the active scene | | [`PlotData.all_display_data`](compolyx.plot_data.PlotData.all_display_data.md#compolyx.plot_data.PlotData.all_display_data) | Returns a list of all display data classes in existence for this object | -| [`PlotData.changed`](compolyx.plot_data.PlotData.changed.md#compolyx.plot_data.PlotData.changed) | Status boolean. | -| [`PlotData.component`](compolyx.plot_data.PlotData.component.md#compolyx.plot_data.PlotData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction. | +| [`PlotData.changed`](compolyx.plot_data.PlotData.changed.md#compolyx.plot_data.PlotData.changed) | Status boolean | +| [`PlotData.component`](compolyx.plot_data.PlotData.component.md#compolyx.plot_data.PlotData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction | | [`PlotData.components`](compolyx.plot_data.PlotData.components.md#compolyx.plot_data.PlotData.components) | Return the possible component set on this plot type | -| [`PlotData.data_scope`](compolyx.plot_data.PlotData.data_scope.md#compolyx.plot_data.PlotData.data_scope) | Data scope of the plot where results will be evaluated. | +| [`PlotData.data_scope`](compolyx.plot_data.PlotData.data_scope.md#compolyx.plot_data.PlotData.data_scope) | Data scope of the plot where results will be evaluated | | [`PlotData.definition_id`](compolyx.plot_data.PlotData.definition_id.md#compolyx.plot_data.PlotData.definition_id) | | -| [`PlotData.description_changed`](compolyx.plot_data.PlotData.description_changed.md#compolyx.plot_data.PlotData.description_changed) | Status boolean. | -| [`PlotData.enabled`](compolyx.plot_data.PlotData.enabled.md#compolyx.plot_data.PlotData.enabled) | Whether this object is currently enabled or not. | -| [`PlotData.eval_position`](compolyx.plot_data.PlotData.eval_position.md#compolyx.plot_data.PlotData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal. | -| [`PlotData.has_element_wise`](compolyx.plot_data.PlotData.has_element_wise.md#compolyx.plot_data.PlotData.has_element_wise) | Whether the plot offers element-wise data. | -| [`PlotData.has_ply_wise`](compolyx.plot_data.PlotData.has_ply_wise.md#compolyx.plot_data.PlotData.has_ply_wise) | Whether the plot offers ply-wise data. | +| [`PlotData.description_changed`](compolyx.plot_data.PlotData.description_changed.md#compolyx.plot_data.PlotData.description_changed) | Status boolean | +| [`PlotData.enabled`](compolyx.plot_data.PlotData.enabled.md#compolyx.plot_data.PlotData.enabled) | Whether this object is currently enabled or not | +| [`PlotData.eval_position`](compolyx.plot_data.PlotData.eval_position.md#compolyx.plot_data.PlotData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal | +| [`PlotData.has_element_wise`](compolyx.plot_data.PlotData.has_element_wise.md#compolyx.plot_data.PlotData.has_element_wise) | Whether the plot offers element-wise data | +| [`PlotData.has_ply_wise`](compolyx.plot_data.PlotData.has_ply_wise.md#compolyx.plot_data.PlotData.has_ply_wise) | Whether the plot offers ply-wise data | | [`PlotData.id`](compolyx.plot_data.PlotData.id.md#compolyx.plot_data.PlotData.id) | ID of object | -| [`PlotData.is_dict_item`](compolyx.plot_data.PlotData.is_dict_item.md#compolyx.plot_data.PlotData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`PlotData.is_list_item`](compolyx.plot_data.PlotData.is_list_item.md#compolyx.plot_data.PlotData.is_list_item) | Specifies wether the object is an item of a list | +| [`PlotData.is_dict_item`](compolyx.plot_data.PlotData.is_dict_item.md#compolyx.plot_data.PlotData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`PlotData.is_list_item`](compolyx.plot_data.PlotData.is_list_item.md#compolyx.plot_data.PlotData.is_list_item) | Specifies whether the object is an item of a list | | [`PlotData.link_path`](compolyx.plot_data.PlotData.link_path.md#compolyx.plot_data.PlotData.link_path) | Root path of the current node in the tree for links to this object | | [`PlotData.locked`](compolyx.plot_data.PlotData.locked.md#compolyx.plot_data.PlotData.locked) | Returns the locked status of the plot | | [`PlotData.name`](compolyx.plot_data.PlotData.name.md#compolyx.plot_data.PlotData.name) | Name of object | | [`PlotData.parent`](compolyx.plot_data.PlotData.parent.md#compolyx.plot_data.PlotData.parent) | Parent object in tree | -| [`PlotData.ply_wise`](compolyx.plot_data.PlotData.ply_wise.md#compolyx.plot_data.PlotData.ply_wise) | Whether to plot ply-wise or element-wise. | +| [`PlotData.ply_wise`](compolyx.plot_data.PlotData.ply_wise.md#compolyx.plot_data.PlotData.ply_wise) | Whether to plot ply-wise or element-wise | | [`PlotData.requires_solution`](compolyx.plot_data.PlotData.requires_solution.md#compolyx.plot_data.PlotData.requires_solution) | | | [`PlotData.root_path`](compolyx.plot_data.PlotData.root_path.md#compolyx.plot_data.PlotData.root_path) | Root path of the current node in the tree | -| [`PlotData.scope_entire_model`](compolyx.plot_data.PlotData.scope_entire_model.md#compolyx.plot_data.PlotData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope. | -| [`PlotData.show_on_solids`](compolyx.plot_data.PlotData.show_on_solids.md#compolyx.plot_data.PlotData.show_on_solids) | Whether to plot results on solid or shell elements. | -| [`PlotData.solution`](compolyx.plot_data.PlotData.solution.md#compolyx.plot_data.PlotData.solution) | Solution underlying the plot. | -| [`PlotData.solution_set`](compolyx.plot_data.PlotData.solution_set.md#compolyx.plot_data.PlotData.solution_set) | Solution Set selection. | -| [`PlotData.spot`](compolyx.plot_data.PlotData.spot.md#compolyx.plot_data.PlotData.spot) | Whether to plot data at bot, mid or top of the layer or laminate. | +| [`PlotData.scope_entire_model`](compolyx.plot_data.PlotData.scope_entire_model.md#compolyx.plot_data.PlotData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope | +| [`PlotData.show_on_solids`](compolyx.plot_data.PlotData.show_on_solids.md#compolyx.plot_data.PlotData.show_on_solids) | Whether to plot results on solid or shell elements | +| [`PlotData.solution`](compolyx.plot_data.PlotData.solution.md#compolyx.plot_data.PlotData.solution) | Solution underlying the plot | +| [`PlotData.solution_set`](compolyx.plot_data.PlotData.solution_set.md#compolyx.plot_data.PlotData.solution_set) | Solution Set selection | +| [`PlotData.spot`](compolyx.plot_data.PlotData.spot.md#compolyx.plot_data.PlotData.spot) | Whether to plot data at bot, mid, or top of the layer or laminate | | [`PlotData.spots`](compolyx.plot_data.PlotData.spots.md#compolyx.plot_data.PlotData.spots) | Return the possible spot set on this plot type | | [`PlotData.status`](compolyx.plot_data.PlotData.status.md#compolyx.plot_data.PlotData.status) | Status of the object | -| [`PlotData.status_changed`](compolyx.plot_data.PlotData.status_changed.md#compolyx.plot_data.PlotData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`PlotData.status_changed`](compolyx.plot_data.PlotData.status_changed.md#compolyx.plot_data.PlotData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`PlotData.uid`](compolyx.plot_data.PlotData.uid.md#compolyx.plot_data.PlotData.uid) | UID of object | -| [`PlotData.updated`](compolyx.plot_data.PlotData.updated.md#compolyx.plot_data.PlotData.updated) | Status boolean. | -| [`PlotData.uptodate`](compolyx.plot_data.PlotData.uptodate.md#compolyx.plot_data.PlotData.uptodate) | Whether the plot is uptodate. | -| [`PlotData.vertex`](compolyx.plot_data.PlotData.vertex.md#compolyx.plot_data.PlotData.vertex) | This will throw an error if the object has been removed from the graph. | +| [`PlotData.updated`](compolyx.plot_data.PlotData.updated.md#compolyx.plot_data.PlotData.updated) | Status boolean | +| [`PlotData.uptodate`](compolyx.plot_data.PlotData.uptodate.md#compolyx.plot_data.PlotData.uptodate) | Whether the plot is up-to-date | +| [`PlotData.vertex`](compolyx.plot_data.PlotData.vertex.md#compolyx.plot_data.PlotData.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`PlotData.add_data_scope_entity`](compolyx.plot_data.PlotData.add_data_scope_entity.md#compolyx.plot_data.PlotData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot. | -| [`PlotData.clear_data_scope`](compolyx.plot_data.PlotData.clear_data_scope.md#compolyx.plot_data.PlotData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. | -| [`PlotData.display_data_create`](compolyx.plot_data.PlotData.display_data_create.md#compolyx.plot_data.PlotData.display_data_create)([parent]) | Function for internal use, not meant for scripting. | -| [`PlotData.find_parent`](compolyx.plot_data.PlotData.find_parent.md#compolyx.plot_data.PlotData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`PlotData.get_data`](compolyx.plot_data.PlotData.get_data.md#compolyx.plot_data.PlotData.get_data)([visible, selected]) | Get data of plot. | -| [`PlotData.get_deformations`](compolyx.plot_data.PlotData.get_deformations.md#compolyx.plot_data.PlotData.get_deformations)([visible, selected]) | Function used internally to query matching nodal deformations for a given plot. | +| [`PlotData.add_data_scope_entity`](compolyx.plot_data.PlotData.add_data_scope_entity.md#compolyx.plot_data.PlotData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot | +| [`PlotData.clear_data_scope`](compolyx.plot_data.PlotData.clear_data_scope.md#compolyx.plot_data.PlotData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once | +| [`PlotData.display_data_create`](compolyx.plot_data.PlotData.display_data_create.md#compolyx.plot_data.PlotData.display_data_create)([parent]) | Function for internal use, not meant for scripting | +| [`PlotData.find_parent`](compolyx.plot_data.PlotData.find_parent.md#compolyx.plot_data.PlotData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`PlotData.get_data`](compolyx.plot_data.PlotData.get_data.md#compolyx.plot_data.PlotData.get_data)([visible, selected]) | Get data of plot | +| [`PlotData.get_deformations`](compolyx.plot_data.PlotData.get_deformations.md#compolyx.plot_data.PlotData.get_deformations)([visible, selected]) | Function used internally to query matching nodal deformations for a given plot | | [`PlotData.get_element_indices`](compolyx.plot_data.PlotData.get_element_indices.md#compolyx.plot_data.PlotData.get_element_indices)([visible, selected]) | Get element indices (ACP internal element numbers starting from 0) of plot | -| [`PlotData.get_element_labels`](compolyx.plot_data.PlotData.get_element_labels.md#compolyx.plot_data.PlotData.get_element_labels)([visible, selected]) | Get element labels (element numbers as read from / written to mesh files) of plot. | -| [`PlotData.get_full_description`](compolyx.plot_data.PlotData.get_full_description.md#compolyx.plot_data.PlotData.get_full_description)() | This function returns information displayed together with the legend. | -| [`PlotData.obj_exists`](compolyx.plot_data.PlotData.obj_exists.md#compolyx.plot_data.PlotData.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. | -| [`PlotData.remove_data_scope_entity`](compolyx.plot_data.PlotData.remove_data_scope_entity.md#compolyx.plot_data.PlotData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot. | +| [`PlotData.get_element_labels`](compolyx.plot_data.PlotData.get_element_labels.md#compolyx.plot_data.PlotData.get_element_labels)([visible, selected]) | Get element labels (element numbers as read from / written to mesh files) of plot | +| [`PlotData.get_full_description`](compolyx.plot_data.PlotData.get_full_description.md#compolyx.plot_data.PlotData.get_full_description)() | This function returns information displayed together with the legend | +| [`PlotData.obj_exists`](compolyx.plot_data.PlotData.obj_exists.md#compolyx.plot_data.PlotData.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 | +| [`PlotData.remove_data_scope_entity`](compolyx.plot_data.PlotData.remove_data_scope_entity.md#compolyx.plot_data.PlotData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot | | [`PlotData.serialize`](compolyx.plot_data.PlotData.serialize.md#compolyx.plot_data.PlotData.serialize)() | Serialize to Python string | | [`PlotData.serialize_create_function`](compolyx.plot_data.PlotData.serialize_create_function.md#compolyx.plot_data.PlotData.serialize_create_function)() | | -| [`PlotData.serialize_name_and_id`](compolyx.plot_data.PlotData.serialize_name_and_id.md#compolyx.plot_data.PlotData.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`PlotData.serialize_name_and_id`](compolyx.plot_data.PlotData.serialize_name_and_id.md#compolyx.plot_data.PlotData.serialize_name_and_id)() | Helper function to serialize name and ID | | [`PlotData.serialize_properties`](compolyx.plot_data.PlotData.serialize_properties.md#compolyx.plot_data.PlotData.serialize_properties)() | Serialize to Python string | | [`PlotData.serialize_python_only_attributes`](compolyx.plot_data.PlotData.serialize_python_only_attributes.md#compolyx.plot_data.PlotData.serialize_python_only_attributes)() | | | [`PlotData.update`](compolyx.plot_data.PlotData.update.md#compolyx.plot_data.PlotData.update)() | | -| [`PlotData.visit`](compolyx.plot_data.PlotData.visit.md#compolyx.plot_data.PlotData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`PlotData.visit`](compolyx.plot_data.PlotData.visit.md#compolyx.plot_data.PlotData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.obj_exists.md index 845ff6c6ae..389348e648 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.obj_exists.md @@ -4,5 +4,5 @@ #### PlotData.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.updated.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.updated.md index 4f80f0c6fd..11b1120205 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.updated.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.updated.md @@ -4,4 +4,4 @@ #### *property* PlotData.updated -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.uptodate.md index 0a096a59e4..a170cc5c61 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.uptodate.md @@ -4,4 +4,4 @@ #### *property* PlotData.uptodate -Whether the plot is uptodate. +Whether the plot is up-to-date. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.visit.md index 788d8f8665..32ff6d43a3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotData.visit.md @@ -9,7 +9,8 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** + - True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.enabled.md index 45403a78d3..4f52deb411 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.enabled.md @@ -4,4 +4,4 @@ #### *property* PlotDataDict.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.is_dict_item.md index c7029ee9f4..dee573a5c9 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* PlotDataDict.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.is_list_item.md index a277e01a18..7940e6f3f2 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.is_list_item.md @@ -4,4 +4,4 @@ #### *property* PlotDataDict.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.md index e1dd278fda..8f7724b1ae 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.PlotDataDict.md @@ -8,9 +8,9 @@ | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------| -| [`PlotDataDict.enabled`](compolyx.plot_data.PlotDataDict.enabled.md#compolyx.plot_data.PlotDataDict.enabled) | Whether this object is currently enabled or not. | -| [`PlotDataDict.is_dict_item`](compolyx.plot_data.PlotDataDict.is_dict_item.md#compolyx.plot_data.PlotDataDict.is_dict_item) | Specifies wether the object is an item of a dict | -| [`PlotDataDict.is_list_item`](compolyx.plot_data.PlotDataDict.is_list_item.md#compolyx.plot_data.PlotDataDict.is_list_item) | Specifies wether the object is an item of a list | +| [`PlotDataDict.enabled`](compolyx.plot_data.PlotDataDict.enabled.md#compolyx.plot_data.PlotDataDict.enabled) | Whether this object is currently enabled or not | +| [`PlotDataDict.is_dict_item`](compolyx.plot_data.PlotDataDict.is_dict_item.md#compolyx.plot_data.PlotDataDict.is_dict_item) | Specifies whether the object is an item of a dict | +| [`PlotDataDict.is_list_item`](compolyx.plot_data.PlotDataDict.is_list_item.md#compolyx.plot_data.PlotDataDict.is_list_item) | Specifies whether the object is an item of a list | | [`PlotDataDict.item_type`](compolyx.plot_data.PlotDataDict.item_type.md#compolyx.plot_data.PlotDataDict.item_type) | Type of items stored in this UIDict | | [`PlotDataDict.key_attr`](compolyx.plot_data.PlotDataDict.key_attr.md#compolyx.plot_data.PlotDataDict.key_attr) | Name of attribute of item objects which is mapped to the key of the UIDict | | [`PlotDataDict.label`](compolyx.plot_data.PlotDataDict.label.md#compolyx.plot_data.PlotDataDict.label) | | @@ -23,13 +23,13 @@ | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| -| [`PlotDataDict.append`](compolyx.plot_data.PlotDataDict.append.md#compolyx.plot_data.PlotDataDict.append)(value) | Append a new item to the UIDict. | +| [`PlotDataDict.append`](compolyx.plot_data.PlotDataDict.append.md#compolyx.plot_data.PlotDataDict.append)(value) | Append a new item to the UIDict | | [`PlotDataDict.clear`](compolyx.plot_data.PlotDataDict.clear.md#compolyx.plot_data.PlotDataDict.clear)() | | -| [`PlotDataDict.copy_plot`](compolyx.plot_data.PlotDataDict.copy_plot.md#compolyx.plot_data.PlotDataDict.copy_plot)(source) | Copy a plot object. | -| [`PlotDataDict.extend`](compolyx.plot_data.PlotDataDict.extend.md#compolyx.plot_data.PlotDataDict.extend)(values) | Extend the UIDict with multiple items at once. | -| [`PlotDataDict.find`](compolyx.plot_data.PlotDataDict.find.md#compolyx.plot_data.PlotDataDict.find)(func) | Return the value of the first value in dict where func(value) == True. | -| [`PlotDataDict.find_key`](compolyx.plot_data.PlotDataDict.find_key.md#compolyx.plot_data.PlotDataDict.find_key)(func) | Return the key of the first value in dict where func(value) == True. | -| [`PlotDataDict.find_parent`](compolyx.plot_data.PlotDataDict.find_parent.md#compolyx.plot_data.PlotDataDict.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | +| [`PlotDataDict.copy_plot`](compolyx.plot_data.PlotDataDict.copy_plot.md#compolyx.plot_data.PlotDataDict.copy_plot)(source) | Copy a plot object | +| [`PlotDataDict.extend`](compolyx.plot_data.PlotDataDict.extend.md#compolyx.plot_data.PlotDataDict.extend)(values) | Extend the UIDict with multiple items at once | +| [`PlotDataDict.find`](compolyx.plot_data.PlotDataDict.find.md#compolyx.plot_data.PlotDataDict.find)(func) | Return the value of the first value in dict where func(value) == True | +| [`PlotDataDict.find_key`](compolyx.plot_data.PlotDataDict.find_key.md#compolyx.plot_data.PlotDataDict.find_key)(func) | Return the key of the first value in dict where func(value) == True | +| [`PlotDataDict.find_parent`](compolyx.plot_data.PlotDataDict.find_parent.md#compolyx.plot_data.PlotDataDict.find_parent)(type) | Function steps up the tree and returns the first parent with given type | | [`PlotDataDict.get`](compolyx.plot_data.PlotDataDict.get.md#compolyx.plot_data.PlotDataDict.get)(key[, default]) | | | [`PlotDataDict.index`](compolyx.plot_data.PlotDataDict.index.md#compolyx.plot_data.PlotDataDict.index)(key) | | | [`PlotDataDict.items`](compolyx.plot_data.PlotDataDict.items.md#compolyx.plot_data.PlotDataDict.items)() | Return ordered list with (key,value) pairs | @@ -38,8 +38,8 @@ | [`PlotDataDict.itervalues`](compolyx.plot_data.PlotDataDict.itervalues.md#compolyx.plot_data.PlotDataDict.itervalues)() | | | [`PlotDataDict.keys`](compolyx.plot_data.PlotDataDict.keys.md#compolyx.plot_data.PlotDataDict.keys)() | | | [`PlotDataDict.new`](compolyx.plot_data.PlotDataDict.new.md#compolyx.plot_data.PlotDataDict.new)(name[, type]) | | -| [`PlotDataDict.rename`](compolyx.plot_data.PlotDataDict.rename.md#compolyx.plot_data.PlotDataDict.rename)(old_name, new_name) | Rename function which updates the name of the object by calling obj._update_name(new_name). | +| [`PlotDataDict.rename`](compolyx.plot_data.PlotDataDict.rename.md#compolyx.plot_data.PlotDataDict.rename)(old_name, new_name) | Rename function which updates the name of the object by calling obj._update_name(new_name) | | [`PlotDataDict.sort`](compolyx.plot_data.PlotDataDict.sort.md#compolyx.plot_data.PlotDataDict.sort)([cmp, key, reverse]) | | | [`PlotDataDict.update_key`](compolyx.plot_data.PlotDataDict.update_key.md#compolyx.plot_data.PlotDataDict.update_key)(old) | Update old key of object to the current value of the key_attr attribute of this object | | [`PlotDataDict.values`](compolyx.plot_data.PlotDataDict.values.md#compolyx.plot_data.PlotDataDict.values)() | | -| [`PlotDataDict.visit`](compolyx.plot_data.PlotDataDict.visit.md#compolyx.plot_data.PlotDataDict.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`PlotDataDict.visit`](compolyx.plot_data.PlotDataDict.visit.md#compolyx.plot_data.PlotDataDict.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.changed.md index 3127e209c2..4adb55240e 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.changed.md @@ -4,4 +4,4 @@ #### *property* ScalarFieldData.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.description_changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.description_changed.md index b828a52cc2..0dae00be21 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.description_changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.description_changed.md @@ -4,4 +4,4 @@ #### *property* ScalarFieldData.description_changed -Status boolean. Set to true if the object’s description has been changed. Write only property +Status boolean. Set to true if the object’s description has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.get_support_point_values.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.get_support_point_values.md index 641272916d..3bec1b2176 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.get_support_point_values.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.get_support_point_values.md @@ -12,7 +12,7 @@ Get the scalar values defined at the supporting points. Values are returned independent of update status of plot. Examples: -: Get scalar values for supporting points defining look-up table plot: + Get scalar values for supporting points defining look-up table plot:
```default >>> coords = my_plot._get_support_point_values() diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.is_dict_item.md index 2aaeb782a7..e196746111 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ScalarFieldData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.is_list_item.md index 5bfe0039dc..8f3d17f2e8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ScalarFieldData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.md index f569a92c55..441a3da105 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.md @@ -8,23 +8,23 @@ | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| [`ScalarFieldData.active`](compolyx.plot_data.ScalarFieldData.active.md#compolyx.plot_data.ScalarFieldData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data. | +| [`ScalarFieldData.active`](compolyx.plot_data.ScalarFieldData.active.md#compolyx.plot_data.ScalarFieldData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data | | [`ScalarFieldData.active_display_data`](compolyx.plot_data.ScalarFieldData.active_display_data.md#compolyx.plot_data.ScalarFieldData.active_display_data) | Returns a dictionary containing display data for this plot owned by the active scene | | [`ScalarFieldData.all_display_data`](compolyx.plot_data.ScalarFieldData.all_display_data.md#compolyx.plot_data.ScalarFieldData.all_display_data) | Returns a list of all display data classes in existence for this object | -| [`ScalarFieldData.changed`](compolyx.plot_data.ScalarFieldData.changed.md#compolyx.plot_data.ScalarFieldData.changed) | Status boolean. | +| [`ScalarFieldData.changed`](compolyx.plot_data.ScalarFieldData.changed.md#compolyx.plot_data.ScalarFieldData.changed) | Status boolean | | [`ScalarFieldData.color_table`](compolyx.plot_data.ScalarFieldData.color_table.md#compolyx.plot_data.ScalarFieldData.color_table) | | -| [`ScalarFieldData.component`](compolyx.plot_data.ScalarFieldData.component.md#compolyx.plot_data.ScalarFieldData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction. | +| [`ScalarFieldData.component`](compolyx.plot_data.ScalarFieldData.component.md#compolyx.plot_data.ScalarFieldData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction | | [`ScalarFieldData.components`](compolyx.plot_data.ScalarFieldData.components.md#compolyx.plot_data.ScalarFieldData.components) | Return the possible component set on this plot type | -| [`ScalarFieldData.data_scope`](compolyx.plot_data.ScalarFieldData.data_scope.md#compolyx.plot_data.ScalarFieldData.data_scope) | Data scope of the plot where results will be evaluated. | +| [`ScalarFieldData.data_scope`](compolyx.plot_data.ScalarFieldData.data_scope.md#compolyx.plot_data.ScalarFieldData.data_scope) | Data scope of the plot where results will be evaluated | | [`ScalarFieldData.definition_id`](compolyx.plot_data.ScalarFieldData.definition_id.md#compolyx.plot_data.ScalarFieldData.definition_id) | | -| [`ScalarFieldData.description_changed`](compolyx.plot_data.ScalarFieldData.description_changed.md#compolyx.plot_data.ScalarFieldData.description_changed) | Status boolean. | -| [`ScalarFieldData.enabled`](compolyx.plot_data.ScalarFieldData.enabled.md#compolyx.plot_data.ScalarFieldData.enabled) | Whether this object is currently enabled or not. | -| [`ScalarFieldData.eval_position`](compolyx.plot_data.ScalarFieldData.eval_position.md#compolyx.plot_data.ScalarFieldData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal. | -| [`ScalarFieldData.has_element_wise`](compolyx.plot_data.ScalarFieldData.has_element_wise.md#compolyx.plot_data.ScalarFieldData.has_element_wise) | Whether the plot offers element-wise data. | -| [`ScalarFieldData.has_ply_wise`](compolyx.plot_data.ScalarFieldData.has_ply_wise.md#compolyx.plot_data.ScalarFieldData.has_ply_wise) | Whether the plot offers ply-wise data. | +| [`ScalarFieldData.description_changed`](compolyx.plot_data.ScalarFieldData.description_changed.md#compolyx.plot_data.ScalarFieldData.description_changed) | Status boolean | +| [`ScalarFieldData.enabled`](compolyx.plot_data.ScalarFieldData.enabled.md#compolyx.plot_data.ScalarFieldData.enabled) | Whether this object is currently enabled or not | +| [`ScalarFieldData.eval_position`](compolyx.plot_data.ScalarFieldData.eval_position.md#compolyx.plot_data.ScalarFieldData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal | +| [`ScalarFieldData.has_element_wise`](compolyx.plot_data.ScalarFieldData.has_element_wise.md#compolyx.plot_data.ScalarFieldData.has_element_wise) | Whether the plot offers element-wise data | +| [`ScalarFieldData.has_ply_wise`](compolyx.plot_data.ScalarFieldData.has_ply_wise.md#compolyx.plot_data.ScalarFieldData.has_ply_wise) | Whether the plot offers ply-wise data | | [`ScalarFieldData.id`](compolyx.plot_data.ScalarFieldData.id.md#compolyx.plot_data.ScalarFieldData.id) | ID of object | -| [`ScalarFieldData.is_dict_item`](compolyx.plot_data.ScalarFieldData.is_dict_item.md#compolyx.plot_data.ScalarFieldData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ScalarFieldData.is_list_item`](compolyx.plot_data.ScalarFieldData.is_list_item.md#compolyx.plot_data.ScalarFieldData.is_list_item) | Specifies wether the object is an item of a list | +| [`ScalarFieldData.is_dict_item`](compolyx.plot_data.ScalarFieldData.is_dict_item.md#compolyx.plot_data.ScalarFieldData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ScalarFieldData.is_list_item`](compolyx.plot_data.ScalarFieldData.is_list_item.md#compolyx.plot_data.ScalarFieldData.is_list_item) | Specifies whether the object is an item of a list | | [`ScalarFieldData.link_path`](compolyx.plot_data.ScalarFieldData.link_path.md#compolyx.plot_data.ScalarFieldData.link_path) | Root path of the current node in the tree for links to this object | | [`ScalarFieldData.locked`](compolyx.plot_data.ScalarFieldData.locked.md#compolyx.plot_data.ScalarFieldData.locked) | Returns the locked status of the plot | | [`ScalarFieldData.minmax`](compolyx.plot_data.ScalarFieldData.minmax.md#compolyx.plot_data.ScalarFieldData.minmax) | Min and max value of current data | @@ -32,50 +32,50 @@ | [`ScalarFieldData.name`](compolyx.plot_data.ScalarFieldData.name.md#compolyx.plot_data.ScalarFieldData.name) | Name of object | | [`ScalarFieldData.parent`](compolyx.plot_data.ScalarFieldData.parent.md#compolyx.plot_data.ScalarFieldData.parent) | Parent object in tree | | [`ScalarFieldData.ply_offset_scale_factor`](compolyx.plot_data.ScalarFieldData.ply_offset_scale_factor.md#compolyx.plot_data.ScalarFieldData.ply_offset_scale_factor) | Offset scale factor | -| [`ScalarFieldData.ply_wise`](compolyx.plot_data.ScalarFieldData.ply_wise.md#compolyx.plot_data.ScalarFieldData.ply_wise) | Whether to plot ply-wise or element-wise. | +| [`ScalarFieldData.ply_wise`](compolyx.plot_data.ScalarFieldData.ply_wise.md#compolyx.plot_data.ScalarFieldData.ply_wise) | Whether to plot ply-wise or element-wise | | [`ScalarFieldData.requires_solution`](compolyx.plot_data.ScalarFieldData.requires_solution.md#compolyx.plot_data.ScalarFieldData.requires_solution) | | | [`ScalarFieldData.root_path`](compolyx.plot_data.ScalarFieldData.root_path.md#compolyx.plot_data.ScalarFieldData.root_path) | Root path of the current node in the tree | -| [`ScalarFieldData.scalar_field`](compolyx.plot_data.ScalarFieldData.scalar_field.md#compolyx.plot_data.ScalarFieldData.scalar_field) | The underlying scalar field. | -| [`ScalarFieldData.scope_entire_model`](compolyx.plot_data.ScalarFieldData.scope_entire_model.md#compolyx.plot_data.ScalarFieldData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope. | -| [`ScalarFieldData.show_on_solids`](compolyx.plot_data.ScalarFieldData.show_on_solids.md#compolyx.plot_data.ScalarFieldData.show_on_solids) | Whether to plot results on solid or shell elements. | +| [`ScalarFieldData.scalar_field`](compolyx.plot_data.ScalarFieldData.scalar_field.md#compolyx.plot_data.ScalarFieldData.scalar_field) | The underlying scalar field | +| [`ScalarFieldData.scope_entire_model`](compolyx.plot_data.ScalarFieldData.scope_entire_model.md#compolyx.plot_data.ScalarFieldData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope | +| [`ScalarFieldData.show_on_solids`](compolyx.plot_data.ScalarFieldData.show_on_solids.md#compolyx.plot_data.ScalarFieldData.show_on_solids) | Whether to plot results on solid or shell elements | | [`ScalarFieldData.show_ply_offsets`](compolyx.plot_data.ScalarFieldData.show_ply_offsets.md#compolyx.plot_data.ScalarFieldData.show_ply_offsets) | | -| [`ScalarFieldData.show_supporting_point_labels`](compolyx.plot_data.ScalarFieldData.show_supporting_point_labels.md#compolyx.plot_data.ScalarFieldData.show_supporting_point_labels) | Whether to plot the labels of the supporting points. | -| [`ScalarFieldData.show_supporting_points`](compolyx.plot_data.ScalarFieldData.show_supporting_points.md#compolyx.plot_data.ScalarFieldData.show_supporting_points) | Whether to the plot supporting points. | -| [`ScalarFieldData.solution`](compolyx.plot_data.ScalarFieldData.solution.md#compolyx.plot_data.ScalarFieldData.solution) | Solution underlying the plot. | -| [`ScalarFieldData.solution_set`](compolyx.plot_data.ScalarFieldData.solution_set.md#compolyx.plot_data.ScalarFieldData.solution_set) | Solution Set selection. | +| [`ScalarFieldData.show_supporting_point_labels`](compolyx.plot_data.ScalarFieldData.show_supporting_point_labels.md#compolyx.plot_data.ScalarFieldData.show_supporting_point_labels) | Whether to plot the labels of the supporting points | +| [`ScalarFieldData.show_supporting_points`](compolyx.plot_data.ScalarFieldData.show_supporting_points.md#compolyx.plot_data.ScalarFieldData.show_supporting_points) | Whether to the plot supporting points | +| [`ScalarFieldData.solution`](compolyx.plot_data.ScalarFieldData.solution.md#compolyx.plot_data.ScalarFieldData.solution) | Solution underlying the plot | +| [`ScalarFieldData.solution_set`](compolyx.plot_data.ScalarFieldData.solution_set.md#compolyx.plot_data.ScalarFieldData.solution_set) | Solution Set selection | | [`ScalarFieldData.spot`](compolyx.plot_data.ScalarFieldData.spot.md#compolyx.plot_data.ScalarFieldData.spot) | Not applicable to a scalar field plot | | [`ScalarFieldData.spots`](compolyx.plot_data.ScalarFieldData.spots.md#compolyx.plot_data.ScalarFieldData.spots) | Return the possible spot set on this plot type | | [`ScalarFieldData.status`](compolyx.plot_data.ScalarFieldData.status.md#compolyx.plot_data.ScalarFieldData.status) | Status of the object | -| [`ScalarFieldData.status_changed`](compolyx.plot_data.ScalarFieldData.status_changed.md#compolyx.plot_data.ScalarFieldData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`ScalarFieldData.supporting_point_scale_factor`](compolyx.plot_data.ScalarFieldData.supporting_point_scale_factor.md#compolyx.plot_data.ScalarFieldData.supporting_point_scale_factor) | Relative scale factor for the supporting points. | +| [`ScalarFieldData.status_changed`](compolyx.plot_data.ScalarFieldData.status_changed.md#compolyx.plot_data.ScalarFieldData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`ScalarFieldData.supporting_point_scale_factor`](compolyx.plot_data.ScalarFieldData.supporting_point_scale_factor.md#compolyx.plot_data.ScalarFieldData.supporting_point_scale_factor) | Relative scale factor for the supporting points | | [`ScalarFieldData.uid`](compolyx.plot_data.ScalarFieldData.uid.md#compolyx.plot_data.ScalarFieldData.uid) | UID of object | -| [`ScalarFieldData.updated`](compolyx.plot_data.ScalarFieldData.updated.md#compolyx.plot_data.ScalarFieldData.updated) | Status boolean. | -| [`ScalarFieldData.uptodate`](compolyx.plot_data.ScalarFieldData.uptodate.md#compolyx.plot_data.ScalarFieldData.uptodate) | Whether the plot is uptodate. | -| [`ScalarFieldData.vertex`](compolyx.plot_data.ScalarFieldData.vertex.md#compolyx.plot_data.ScalarFieldData.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ScalarFieldData.updated`](compolyx.plot_data.ScalarFieldData.updated.md#compolyx.plot_data.ScalarFieldData.updated) | Status boolean | +| [`ScalarFieldData.uptodate`](compolyx.plot_data.ScalarFieldData.uptodate.md#compolyx.plot_data.ScalarFieldData.uptodate) | Whether the plot is up-to-date | +| [`ScalarFieldData.vertex`](compolyx.plot_data.ScalarFieldData.vertex.md#compolyx.plot_data.ScalarFieldData.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ScalarFieldData.add_data_scope_entity`](compolyx.plot_data.ScalarFieldData.add_data_scope_entity.md#compolyx.plot_data.ScalarFieldData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot. | -| [`ScalarFieldData.clear_data_scope`](compolyx.plot_data.ScalarFieldData.clear_data_scope.md#compolyx.plot_data.ScalarFieldData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. | -| [`ScalarFieldData.display_data_create`](compolyx.plot_data.ScalarFieldData.display_data_create.md#compolyx.plot_data.ScalarFieldData.display_data_create)([parent]) | Function for internal use, not meant for scripting. | -| [`ScalarFieldData.find_parent`](compolyx.plot_data.ScalarFieldData.find_parent.md#compolyx.plot_data.ScalarFieldData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`ScalarFieldData.get_data`](compolyx.plot_data.ScalarFieldData.get_data.md#compolyx.plot_data.ScalarFieldData.get_data)([visible, selected]) | Get data of plot. | -| [`ScalarFieldData.get_deformations`](compolyx.plot_data.ScalarFieldData.get_deformations.md#compolyx.plot_data.ScalarFieldData.get_deformations)([visible, ...]) | Function used internally to query matching nodal deformations for a given plot. | +| [`ScalarFieldData.add_data_scope_entity`](compolyx.plot_data.ScalarFieldData.add_data_scope_entity.md#compolyx.plot_data.ScalarFieldData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot | +| [`ScalarFieldData.clear_data_scope`](compolyx.plot_data.ScalarFieldData.clear_data_scope.md#compolyx.plot_data.ScalarFieldData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once | +| [`ScalarFieldData.display_data_create`](compolyx.plot_data.ScalarFieldData.display_data_create.md#compolyx.plot_data.ScalarFieldData.display_data_create)([parent]) | Function for internal use, not meant for scripting | +| [`ScalarFieldData.find_parent`](compolyx.plot_data.ScalarFieldData.find_parent.md#compolyx.plot_data.ScalarFieldData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`ScalarFieldData.get_data`](compolyx.plot_data.ScalarFieldData.get_data.md#compolyx.plot_data.ScalarFieldData.get_data)([visible, selected]) | Get data of plot | +| [`ScalarFieldData.get_deformations`](compolyx.plot_data.ScalarFieldData.get_deformations.md#compolyx.plot_data.ScalarFieldData.get_deformations)([visible, ...]) | Function used internally to query matching nodal deformations for a given plot | | [`ScalarFieldData.get_element_indices`](compolyx.plot_data.ScalarFieldData.get_element_indices.md#compolyx.plot_data.ScalarFieldData.get_element_indices)([...]) | Get element indices (ACP internal element numbers starting from 0) of plot | -| [`ScalarFieldData.get_element_labels`](compolyx.plot_data.ScalarFieldData.get_element_labels.md#compolyx.plot_data.ScalarFieldData.get_element_labels)([...]) | Get element labels (element numbers as read from / written to mesh files) of plot. | -| [`ScalarFieldData.get_full_description`](compolyx.plot_data.ScalarFieldData.get_full_description.md#compolyx.plot_data.ScalarFieldData.get_full_description)() | This function returns information displayed together with the legend. | -| [`ScalarFieldData.get_ply_offsets`](compolyx.plot_data.ScalarFieldData.get_ply_offsets.md#compolyx.plot_data.ScalarFieldData.get_ply_offsets)([visible, ...]) | Get the offset between plies and reference surface. | -| [`ScalarFieldData.get_support_point_coordinates`](compolyx.plot_data.ScalarFieldData.get_support_point_coordinates.md#compolyx.plot_data.ScalarFieldData.get_support_point_coordinates)() | Get the coordinates of the supporting points. | -| [`ScalarFieldData.get_support_point_labels`](compolyx.plot_data.ScalarFieldData.get_support_point_labels.md#compolyx.plot_data.ScalarFieldData.get_support_point_labels)() | Get the identifiers for the supporting points. | -| [`ScalarFieldData.get_support_point_values`](compolyx.plot_data.ScalarFieldData.get_support_point_values.md#compolyx.plot_data.ScalarFieldData.get_support_point_values)() | Get the scalar values defined at the supporting points. | -| [`ScalarFieldData.obj_exists`](compolyx.plot_data.ScalarFieldData.obj_exists.md#compolyx.plot_data.ScalarFieldData.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. | -| [`ScalarFieldData.remove_data_scope_entity`](compolyx.plot_data.ScalarFieldData.remove_data_scope_entity.md#compolyx.plot_data.ScalarFieldData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot. | +| [`ScalarFieldData.get_element_labels`](compolyx.plot_data.ScalarFieldData.get_element_labels.md#compolyx.plot_data.ScalarFieldData.get_element_labels)([...]) | Get element labels (element numbers as read from / written to mesh files) of plot | +| [`ScalarFieldData.get_full_description`](compolyx.plot_data.ScalarFieldData.get_full_description.md#compolyx.plot_data.ScalarFieldData.get_full_description)() | This function returns information displayed together with the legend | +| [`ScalarFieldData.get_ply_offsets`](compolyx.plot_data.ScalarFieldData.get_ply_offsets.md#compolyx.plot_data.ScalarFieldData.get_ply_offsets)([visible, ...]) | Get the offset between plies and reference surface | +| [`ScalarFieldData.get_support_point_coordinates`](compolyx.plot_data.ScalarFieldData.get_support_point_coordinates.md#compolyx.plot_data.ScalarFieldData.get_support_point_coordinates)() | Get the coordinates of the supporting points | +| [`ScalarFieldData.get_support_point_labels`](compolyx.plot_data.ScalarFieldData.get_support_point_labels.md#compolyx.plot_data.ScalarFieldData.get_support_point_labels)() | Get the identifiers for the supporting points | +| [`ScalarFieldData.get_support_point_values`](compolyx.plot_data.ScalarFieldData.get_support_point_values.md#compolyx.plot_data.ScalarFieldData.get_support_point_values)() | Get the scalar values defined at the supporting points | +| [`ScalarFieldData.obj_exists`](compolyx.plot_data.ScalarFieldData.obj_exists.md#compolyx.plot_data.ScalarFieldData.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 | +| [`ScalarFieldData.remove_data_scope_entity`](compolyx.plot_data.ScalarFieldData.remove_data_scope_entity.md#compolyx.plot_data.ScalarFieldData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot | | [`ScalarFieldData.serialize`](compolyx.plot_data.ScalarFieldData.serialize.md#compolyx.plot_data.ScalarFieldData.serialize)() | Serialize to Python string | | [`ScalarFieldData.serialize_create_function`](compolyx.plot_data.ScalarFieldData.serialize_create_function.md#compolyx.plot_data.ScalarFieldData.serialize_create_function)() | | -| [`ScalarFieldData.serialize_name_and_id`](compolyx.plot_data.ScalarFieldData.serialize_name_and_id.md#compolyx.plot_data.ScalarFieldData.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ScalarFieldData.serialize_name_and_id`](compolyx.plot_data.ScalarFieldData.serialize_name_and_id.md#compolyx.plot_data.ScalarFieldData.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ScalarFieldData.serialize_properties`](compolyx.plot_data.ScalarFieldData.serialize_properties.md#compolyx.plot_data.ScalarFieldData.serialize_properties)() | Serialize to Python string | | [`ScalarFieldData.serialize_python_only_attributes`](compolyx.plot_data.ScalarFieldData.serialize_python_only_attributes.md#compolyx.plot_data.ScalarFieldData.serialize_python_only_attributes)() | | | [`ScalarFieldData.update`](compolyx.plot_data.ScalarFieldData.update.md#compolyx.plot_data.ScalarFieldData.update)() | | -| [`ScalarFieldData.visit`](compolyx.plot_data.ScalarFieldData.visit.md#compolyx.plot_data.ScalarFieldData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ScalarFieldData.visit`](compolyx.plot_data.ScalarFieldData.visit.md#compolyx.plot_data.ScalarFieldData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.obj_exists.md index 4aabd8d277..1179a95dda 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.obj_exists.md @@ -4,5 +4,5 @@ #### ScalarFieldData.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.updated.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.updated.md index 335a5ca511..4671c11cdf 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.updated.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.updated.md @@ -4,4 +4,4 @@ #### *property* ScalarFieldData.updated -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.uptodate.md index 2819e6db2c..e2274c5a67 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ScalarFieldData.uptodate.md @@ -4,4 +4,4 @@ #### *property* ScalarFieldData.uptodate -Whether the plot is uptodate. +Whether the plot is up-to-date. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.description_changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.description_changed.md index d2cd2339a7..958b68eff0 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.description_changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.description_changed.md @@ -4,4 +4,4 @@ #### *property* ThicknessData.description_changed -Status boolean. Set to true if the object’s description has been changed. Write only property +Status boolean. Set to true if the object’s description has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.enabled.md index 5f703232ea..d1c70819da 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.enabled.md @@ -4,4 +4,4 @@ #### *property* ThicknessData.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.is_dict_item.md index 92620c1ce7..c37d94f4c8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* ThicknessData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.is_list_item.md index 0fe2837678..fb72448fc3 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* ThicknessData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.md index ae7a999652..01fe1f5c23 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.md @@ -8,23 +8,23 @@ | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| [`ThicknessData.active`](compolyx.plot_data.ThicknessData.active.md#compolyx.plot_data.ThicknessData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data. | +| [`ThicknessData.active`](compolyx.plot_data.ThicknessData.active.md#compolyx.plot_data.ThicknessData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data | | [`ThicknessData.active_display_data`](compolyx.plot_data.ThicknessData.active_display_data.md#compolyx.plot_data.ThicknessData.active_display_data) | Returns a dictionary containing display data for this plot owned by the active scene | | [`ThicknessData.all_display_data`](compolyx.plot_data.ThicknessData.all_display_data.md#compolyx.plot_data.ThicknessData.all_display_data) | Returns a list of all display data classes in existence for this object | -| [`ThicknessData.changed`](compolyx.plot_data.ThicknessData.changed.md#compolyx.plot_data.ThicknessData.changed) | Status boolean. | +| [`ThicknessData.changed`](compolyx.plot_data.ThicknessData.changed.md#compolyx.plot_data.ThicknessData.changed) | Status boolean | | [`ThicknessData.color_table`](compolyx.plot_data.ThicknessData.color_table.md#compolyx.plot_data.ThicknessData.color_table) | | -| [`ThicknessData.component`](compolyx.plot_data.ThicknessData.component.md#compolyx.plot_data.ThicknessData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction. | +| [`ThicknessData.component`](compolyx.plot_data.ThicknessData.component.md#compolyx.plot_data.ThicknessData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction | | [`ThicknessData.components`](compolyx.plot_data.ThicknessData.components.md#compolyx.plot_data.ThicknessData.components) | Return the possible component set on this plot type | -| [`ThicknessData.data_scope`](compolyx.plot_data.ThicknessData.data_scope.md#compolyx.plot_data.ThicknessData.data_scope) | Data scope of the plot where results will be evaluated. | +| [`ThicknessData.data_scope`](compolyx.plot_data.ThicknessData.data_scope.md#compolyx.plot_data.ThicknessData.data_scope) | Data scope of the plot where results will be evaluated | | [`ThicknessData.definition_id`](compolyx.plot_data.ThicknessData.definition_id.md#compolyx.plot_data.ThicknessData.definition_id) | | | [`ThicknessData.description_changed`](compolyx.plot_data.ThicknessData.description_changed.md#compolyx.plot_data.ThicknessData.description_changed) | Status boolean. | -| [`ThicknessData.enabled`](compolyx.plot_data.ThicknessData.enabled.md#compolyx.plot_data.ThicknessData.enabled) | Whether this object is currently enabled or not. | -| [`ThicknessData.eval_position`](compolyx.plot_data.ThicknessData.eval_position.md#compolyx.plot_data.ThicknessData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal. | -| [`ThicknessData.has_element_wise`](compolyx.plot_data.ThicknessData.has_element_wise.md#compolyx.plot_data.ThicknessData.has_element_wise) | Whether the plot offers element-wise data. | +| [`ThicknessData.enabled`](compolyx.plot_data.ThicknessData.enabled.md#compolyx.plot_data.ThicknessData.enabled) | Whether this object is currently enabled or not | +| [`ThicknessData.eval_position`](compolyx.plot_data.ThicknessData.eval_position.md#compolyx.plot_data.ThicknessData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal | +| [`ThicknessData.has_element_wise`](compolyx.plot_data.ThicknessData.has_element_wise.md#compolyx.plot_data.ThicknessData.has_element_wise) | Whether the plot offers element-wise data | | [`ThicknessData.has_ply_wise`](compolyx.plot_data.ThicknessData.has_ply_wise.md#compolyx.plot_data.ThicknessData.has_ply_wise) | Whether the plot offers ply-wise data. | | [`ThicknessData.id`](compolyx.plot_data.ThicknessData.id.md#compolyx.plot_data.ThicknessData.id) | ID of object | -| [`ThicknessData.is_dict_item`](compolyx.plot_data.ThicknessData.is_dict_item.md#compolyx.plot_data.ThicknessData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`ThicknessData.is_list_item`](compolyx.plot_data.ThicknessData.is_list_item.md#compolyx.plot_data.ThicknessData.is_list_item) | Specifies wether the object is an item of a list | +| [`ThicknessData.is_dict_item`](compolyx.plot_data.ThicknessData.is_dict_item.md#compolyx.plot_data.ThicknessData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`ThicknessData.is_list_item`](compolyx.plot_data.ThicknessData.is_list_item.md#compolyx.plot_data.ThicknessData.is_list_item) | Specifies whether the object is an item of a list | | [`ThicknessData.link_path`](compolyx.plot_data.ThicknessData.link_path.md#compolyx.plot_data.ThicknessData.link_path) | Root path of the current node in the tree for links to this object | | [`ThicknessData.locked`](compolyx.plot_data.ThicknessData.locked.md#compolyx.plot_data.ThicknessData.locked) | Returns the locked status of the plot | | [`ThicknessData.minmax`](compolyx.plot_data.ThicknessData.minmax.md#compolyx.plot_data.ThicknessData.minmax) | Min and max value of current data | @@ -32,43 +32,43 @@ | [`ThicknessData.name`](compolyx.plot_data.ThicknessData.name.md#compolyx.plot_data.ThicknessData.name) | Name of object | | [`ThicknessData.parent`](compolyx.plot_data.ThicknessData.parent.md#compolyx.plot_data.ThicknessData.parent) | Parent object in tree | | [`ThicknessData.ply_offset_scale_factor`](compolyx.plot_data.ThicknessData.ply_offset_scale_factor.md#compolyx.plot_data.ThicknessData.ply_offset_scale_factor) | Offset scale factor | -| [`ThicknessData.ply_wise`](compolyx.plot_data.ThicknessData.ply_wise.md#compolyx.plot_data.ThicknessData.ply_wise) | Whether to plot ply-wise or element-wise. | +| [`ThicknessData.ply_wise`](compolyx.plot_data.ThicknessData.ply_wise.md#compolyx.plot_data.ThicknessData.ply_wise) | Whether to plot ply-wise or element-wise | | [`ThicknessData.requires_solution`](compolyx.plot_data.ThicknessData.requires_solution.md#compolyx.plot_data.ThicknessData.requires_solution) | | | [`ThicknessData.root_path`](compolyx.plot_data.ThicknessData.root_path.md#compolyx.plot_data.ThicknessData.root_path) | Root path of the current node in the tree | -| [`ThicknessData.scope_entire_model`](compolyx.plot_data.ThicknessData.scope_entire_model.md#compolyx.plot_data.ThicknessData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope. | -| [`ThicknessData.show_on_solids`](compolyx.plot_data.ThicknessData.show_on_solids.md#compolyx.plot_data.ThicknessData.show_on_solids) | Whether to plot results on solid or shell elements. | +| [`ThicknessData.scope_entire_model`](compolyx.plot_data.ThicknessData.scope_entire_model.md#compolyx.plot_data.ThicknessData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope | +| [`ThicknessData.show_on_solids`](compolyx.plot_data.ThicknessData.show_on_solids.md#compolyx.plot_data.ThicknessData.show_on_solids) | Whether to plot results on solid or shell elements | | [`ThicknessData.show_ply_offsets`](compolyx.plot_data.ThicknessData.show_ply_offsets.md#compolyx.plot_data.ThicknessData.show_ply_offsets) | | -| [`ThicknessData.solution`](compolyx.plot_data.ThicknessData.solution.md#compolyx.plot_data.ThicknessData.solution) | Solution underlying the plot. | -| [`ThicknessData.solution_set`](compolyx.plot_data.ThicknessData.solution_set.md#compolyx.plot_data.ThicknessData.solution_set) | Solution Set selection. | +| [`ThicknessData.solution`](compolyx.plot_data.ThicknessData.solution.md#compolyx.plot_data.ThicknessData.solution) | Solution underlying the plot | +| [`ThicknessData.solution_set`](compolyx.plot_data.ThicknessData.solution_set.md#compolyx.plot_data.ThicknessData.solution_set) | Solution Set selection | | [`ThicknessData.spot`](compolyx.plot_data.ThicknessData.spot.md#compolyx.plot_data.ThicknessData.spot) | Not applicable to a thickness plot | | [`ThicknessData.spots`](compolyx.plot_data.ThicknessData.spots.md#compolyx.plot_data.ThicknessData.spots) | Return the possible spot set on this plot type | | [`ThicknessData.status`](compolyx.plot_data.ThicknessData.status.md#compolyx.plot_data.ThicknessData.status) | Status of the object | -| [`ThicknessData.status_changed`](compolyx.plot_data.ThicknessData.status_changed.md#compolyx.plot_data.ThicknessData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | +| [`ThicknessData.status_changed`](compolyx.plot_data.ThicknessData.status_changed.md#compolyx.plot_data.ThicknessData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | | [`ThicknessData.uid`](compolyx.plot_data.ThicknessData.uid.md#compolyx.plot_data.ThicknessData.uid) | UID of object | -| [`ThicknessData.updated`](compolyx.plot_data.ThicknessData.updated.md#compolyx.plot_data.ThicknessData.updated) | Status boolean. | -| [`ThicknessData.uptodate`](compolyx.plot_data.ThicknessData.uptodate.md#compolyx.plot_data.ThicknessData.uptodate) | Whether the plot is uptodate. | -| [`ThicknessData.vertex`](compolyx.plot_data.ThicknessData.vertex.md#compolyx.plot_data.ThicknessData.vertex) | This will throw an error if the object has been removed from the graph. | +| [`ThicknessData.updated`](compolyx.plot_data.ThicknessData.updated.md#compolyx.plot_data.ThicknessData.updated) | Status boolean | +| [`ThicknessData.uptodate`](compolyx.plot_data.ThicknessData.uptodate.md#compolyx.plot_data.ThicknessData.uptodate) | Whether the plot is up-to-date | +| [`ThicknessData.vertex`](compolyx.plot_data.ThicknessData.vertex.md#compolyx.plot_data.ThicknessData.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`ThicknessData.add_data_scope_entity`](compolyx.plot_data.ThicknessData.add_data_scope_entity.md#compolyx.plot_data.ThicknessData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot. | -| [`ThicknessData.clear_data_scope`](compolyx.plot_data.ThicknessData.clear_data_scope.md#compolyx.plot_data.ThicknessData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. | -| [`ThicknessData.display_data_create`](compolyx.plot_data.ThicknessData.display_data_create.md#compolyx.plot_data.ThicknessData.display_data_create)([parent]) | Function for internal use, not meant for scripting. | -| [`ThicknessData.find_parent`](compolyx.plot_data.ThicknessData.find_parent.md#compolyx.plot_data.ThicknessData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`ThicknessData.get_data`](compolyx.plot_data.ThicknessData.get_data.md#compolyx.plot_data.ThicknessData.get_data)([visible, selected]) | Get data of plot. | -| [`ThicknessData.get_deformations`](compolyx.plot_data.ThicknessData.get_deformations.md#compolyx.plot_data.ThicknessData.get_deformations)([visible, ...]) | Function used internally to query matching nodal deformations for a given plot. | +| [`ThicknessData.add_data_scope_entity`](compolyx.plot_data.ThicknessData.add_data_scope_entity.md#compolyx.plot_data.ThicknessData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot | +| [`ThicknessData.clear_data_scope`](compolyx.plot_data.ThicknessData.clear_data_scope.md#compolyx.plot_data.ThicknessData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once | +| [`ThicknessData.display_data_create`](compolyx.plot_data.ThicknessData.display_data_create.md#compolyx.plot_data.ThicknessData.display_data_create)([parent]) | Function for internal use, not meant for scripting | +| [`ThicknessData.find_parent`](compolyx.plot_data.ThicknessData.find_parent.md#compolyx.plot_data.ThicknessData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`ThicknessData.get_data`](compolyx.plot_data.ThicknessData.get_data.md#compolyx.plot_data.ThicknessData.get_data)([visible, selected]) | Get data of plot | +| [`ThicknessData.get_deformations`](compolyx.plot_data.ThicknessData.get_deformations.md#compolyx.plot_data.ThicknessData.get_deformations)([visible, ...]) | Function used internally to query matching nodal deformations for a given plot | | [`ThicknessData.get_element_indices`](compolyx.plot_data.ThicknessData.get_element_indices.md#compolyx.plot_data.ThicknessData.get_element_indices)([visible, ...]) | Get element indices (ACP internal element numbers starting from 0) of plot | -| [`ThicknessData.get_element_labels`](compolyx.plot_data.ThicknessData.get_element_labels.md#compolyx.plot_data.ThicknessData.get_element_labels)([visible, ...]) | Get element labels (element numbers as read from / written to mesh files) of plot. | -| [`ThicknessData.get_full_description`](compolyx.plot_data.ThicknessData.get_full_description.md#compolyx.plot_data.ThicknessData.get_full_description)() | This function returns information displayed together with the legend. | -| [`ThicknessData.get_ply_offsets`](compolyx.plot_data.ThicknessData.get_ply_offsets.md#compolyx.plot_data.ThicknessData.get_ply_offsets)([visible, ...]) | Get the offset between plies and reference surface. | -| [`ThicknessData.obj_exists`](compolyx.plot_data.ThicknessData.obj_exists.md#compolyx.plot_data.ThicknessData.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. | -| [`ThicknessData.remove_data_scope_entity`](compolyx.plot_data.ThicknessData.remove_data_scope_entity.md#compolyx.plot_data.ThicknessData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot. | +| [`ThicknessData.get_element_labels`](compolyx.plot_data.ThicknessData.get_element_labels.md#compolyx.plot_data.ThicknessData.get_element_labels)([visible, ...]) | Get element labels (element numbers as read from / written to mesh files) of plot | +| [`ThicknessData.get_full_description`](compolyx.plot_data.ThicknessData.get_full_description.md#compolyx.plot_data.ThicknessData.get_full_description)() | This function returns information displayed together with the legend | +| [`ThicknessData.get_ply_offsets`](compolyx.plot_data.ThicknessData.get_ply_offsets.md#compolyx.plot_data.ThicknessData.get_ply_offsets)([visible, ...]) | Get the offset between plies and reference surface | +| [`ThicknessData.obj_exists`](compolyx.plot_data.ThicknessData.obj_exists.md#compolyx.plot_data.ThicknessData.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 | +| [`ThicknessData.remove_data_scope_entity`](compolyx.plot_data.ThicknessData.remove_data_scope_entity.md#compolyx.plot_data.ThicknessData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot | | [`ThicknessData.serialize`](compolyx.plot_data.ThicknessData.serialize.md#compolyx.plot_data.ThicknessData.serialize)() | Serialize to Python string | | [`ThicknessData.serialize_create_function`](compolyx.plot_data.ThicknessData.serialize_create_function.md#compolyx.plot_data.ThicknessData.serialize_create_function)() | | -| [`ThicknessData.serialize_name_and_id`](compolyx.plot_data.ThicknessData.serialize_name_and_id.md#compolyx.plot_data.ThicknessData.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`ThicknessData.serialize_name_and_id`](compolyx.plot_data.ThicknessData.serialize_name_and_id.md#compolyx.plot_data.ThicknessData.serialize_name_and_id)() | Helper function to serialize name and ID | | [`ThicknessData.serialize_properties`](compolyx.plot_data.ThicknessData.serialize_properties.md#compolyx.plot_data.ThicknessData.serialize_properties)() | Serialize to Python string | | [`ThicknessData.serialize_python_only_attributes`](compolyx.plot_data.ThicknessData.serialize_python_only_attributes.md#compolyx.plot_data.ThicknessData.serialize_python_only_attributes)() | | | [`ThicknessData.update`](compolyx.plot_data.ThicknessData.update.md#compolyx.plot_data.ThicknessData.update)() | | -| [`ThicknessData.visit`](compolyx.plot_data.ThicknessData.visit.md#compolyx.plot_data.ThicknessData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`ThicknessData.visit`](compolyx.plot_data.ThicknessData.visit.md#compolyx.plot_data.ThicknessData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.obj_exists.md index 688c3c1094..c7ee83ad79 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.obj_exists.md @@ -4,5 +4,5 @@ #### ThicknessData.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.uptodate.md index 8b44966a58..2da5795dd5 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.uptodate.md @@ -4,4 +4,4 @@ #### *property* ThicknessData.uptodate -Whether the plot is uptodate. +Whether the plot is up-to-date. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.visit.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.visit.md index bf39dc5e3f..9e86980991 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.visit.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.ThicknessData.visit.md @@ -9,7 +9,7 @@ descendant node. * **Parameters:** -- visitor: A callable which accepts a TreeNode instance as parameter + - visitor: A callable which accepts a TreeNode instance as parameter -Returns True if the visitor returned True for at least one descendant/linked node. +* **Returns:** True if the visitor returned True for at least one descendant/linked node. If this is the case, the tree traversal is pruned. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.changed.md index d2e80e0a42..5f9c7f1238 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.changed.md @@ -4,4 +4,4 @@ #### *property* UserDefinedData.changed -Status boolean. Set to true if the underlying data has been changed. Write only property +Status boolean. Set to true if the underlying data has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.clear_data_scope.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.clear_data_scope.md index be91c79680..90c9a2dd64 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.clear_data_scope.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.clear_data_scope.md @@ -4,4 +4,4 @@ #### UserDefinedData.clear_data_scope() -Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. +Clears the complete data scope of a plot, i.e. all scope entities are removed at once. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.description_changed.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.description_changed.md index 6bfb7293ec..a1a35063c8 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.description_changed.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.description_changed.md @@ -4,4 +4,4 @@ #### *property* UserDefinedData.description_changed -Status boolean. Set to true if the object’s description has been changed. Write only property +Status boolean. Set to true if the object’s description has been changed. Write only property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.enabled.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.enabled.md index d5d4433af1..7c86fcbd88 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.enabled.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.enabled.md @@ -4,4 +4,4 @@ #### *property* UserDefinedData.enabled -Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post. +Whether this object is currently enabled or not. Mainly defined through the current application mode. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.is_dict_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.is_dict_item.md index 4c89888222..0724dbc517 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.is_dict_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.is_dict_item.md @@ -4,4 +4,4 @@ #### *property* UserDefinedData.is_dict_item -Specifies wether the object is an item of a dict +Specifies whether the object is an item of a dict diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.is_list_item.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.is_list_item.md index 07da5f3e70..bf260c01a6 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.is_list_item.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.is_list_item.md @@ -4,4 +4,4 @@ #### *property* UserDefinedData.is_list_item -Specifies wether the object is an item of a list +Specifies whether the object is an item of a list diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.md index def8608df0..2d3ad7db4a 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.md @@ -8,23 +8,23 @@ | Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| [`UserDefinedData.active`](compolyx.plot_data.UserDefinedData.active.md#compolyx.plot_data.UserDefinedData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data. | +| [`UserDefinedData.active`](compolyx.plot_data.UserDefinedData.active.md#compolyx.plot_data.UserDefinedData.active) | Whether the plot is active or not; an inactive plot is not updated and it does not contain data | | [`UserDefinedData.active_display_data`](compolyx.plot_data.UserDefinedData.active_display_data.md#compolyx.plot_data.UserDefinedData.active_display_data) | Returns a dictionary containing display data for this plot owned by the active scene | | [`UserDefinedData.all_display_data`](compolyx.plot_data.UserDefinedData.all_display_data.md#compolyx.plot_data.UserDefinedData.all_display_data) | Returns a list of all display data classes in existence for this object | -| [`UserDefinedData.changed`](compolyx.plot_data.UserDefinedData.changed.md#compolyx.plot_data.UserDefinedData.changed) | Status boolean. | +| [`UserDefinedData.changed`](compolyx.plot_data.UserDefinedData.changed.md#compolyx.plot_data.UserDefinedData.changed) | Status boolean | | [`UserDefinedData.color_table`](compolyx.plot_data.UserDefinedData.color_table.md#compolyx.plot_data.UserDefinedData.color_table) | | -| [`UserDefinedData.component`](compolyx.plot_data.UserDefinedData.component.md#compolyx.plot_data.UserDefinedData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction. | +| [`UserDefinedData.component`](compolyx.plot_data.UserDefinedData.component.md#compolyx.plot_data.UserDefinedData.component) | The requested result component for a specific plot, e.g. s1 for the stress in the 1-direction | | [`UserDefinedData.components`](compolyx.plot_data.UserDefinedData.components.md#compolyx.plot_data.UserDefinedData.components) | Return the possible component set on this plot type | -| [`UserDefinedData.data_scope`](compolyx.plot_data.UserDefinedData.data_scope.md#compolyx.plot_data.UserDefinedData.data_scope) | Data scope of the plot where results will be evaluated. | +| [`UserDefinedData.data_scope`](compolyx.plot_data.UserDefinedData.data_scope.md#compolyx.plot_data.UserDefinedData.data_scope) | Data scope of the plot where results will be evaluated | | [`UserDefinedData.definition_id`](compolyx.plot_data.UserDefinedData.definition_id.md#compolyx.plot_data.UserDefinedData.definition_id) | | -| [`UserDefinedData.description_changed`](compolyx.plot_data.UserDefinedData.description_changed.md#compolyx.plot_data.UserDefinedData.description_changed) | Status boolean. | -| [`UserDefinedData.enabled`](compolyx.plot_data.UserDefinedData.enabled.md#compolyx.plot_data.UserDefinedData.enabled) | Whether this object is currently enabled or not. | -| [`UserDefinedData.eval_position`](compolyx.plot_data.UserDefinedData.eval_position.md#compolyx.plot_data.UserDefinedData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal. | -| [`UserDefinedData.has_element_wise`](compolyx.plot_data.UserDefinedData.has_element_wise.md#compolyx.plot_data.UserDefinedData.has_element_wise) | Whether the plot offers element-wise data. | -| [`UserDefinedData.has_ply_wise`](compolyx.plot_data.UserDefinedData.has_ply_wise.md#compolyx.plot_data.UserDefinedData.has_ply_wise) | Whether the plot offers ply-wise data. | +| [`UserDefinedData.description_changed`](compolyx.plot_data.UserDefinedData.description_changed.md#compolyx.plot_data.UserDefinedData.description_changed) | Status boolean | +| [`UserDefinedData.enabled`](compolyx.plot_data.UserDefinedData.enabled.md#compolyx.plot_data.UserDefinedData.enabled) | Whether this object is currently enabled or not | +| [`UserDefinedData.eval_position`](compolyx.plot_data.UserDefinedData.eval_position.md#compolyx.plot_data.UserDefinedData.eval_position) | The finite element position at which the results are given, e.g. centroid or nodal | +| [`UserDefinedData.has_element_wise`](compolyx.plot_data.UserDefinedData.has_element_wise.md#compolyx.plot_data.UserDefinedData.has_element_wise) | Whether the plot offers element-wise data | +| [`UserDefinedData.has_ply_wise`](compolyx.plot_data.UserDefinedData.has_ply_wise.md#compolyx.plot_data.UserDefinedData.has_ply_wise) | Whether the plot offers ply-wise data | | [`UserDefinedData.id`](compolyx.plot_data.UserDefinedData.id.md#compolyx.plot_data.UserDefinedData.id) | ID of object | -| [`UserDefinedData.is_dict_item`](compolyx.plot_data.UserDefinedData.is_dict_item.md#compolyx.plot_data.UserDefinedData.is_dict_item) | Specifies wether the object is an item of a dict | -| [`UserDefinedData.is_list_item`](compolyx.plot_data.UserDefinedData.is_list_item.md#compolyx.plot_data.UserDefinedData.is_list_item) | Specifies wether the object is an item of a list | +| [`UserDefinedData.is_dict_item`](compolyx.plot_data.UserDefinedData.is_dict_item.md#compolyx.plot_data.UserDefinedData.is_dict_item) | Specifies whether the object is an item of a dict | +| [`UserDefinedData.is_list_item`](compolyx.plot_data.UserDefinedData.is_list_item.md#compolyx.plot_data.UserDefinedData.is_list_item) | Specifies whether the object is an item of a list | | [`UserDefinedData.link_path`](compolyx.plot_data.UserDefinedData.link_path.md#compolyx.plot_data.UserDefinedData.link_path) | Root path of the current node in the tree for links to this object | | [`UserDefinedData.locked`](compolyx.plot_data.UserDefinedData.locked.md#compolyx.plot_data.UserDefinedData.locked) | Returns the locked status of the plot | | [`UserDefinedData.minmax`](compolyx.plot_data.UserDefinedData.minmax.md#compolyx.plot_data.UserDefinedData.minmax) | Min and max value of current data | @@ -32,54 +32,54 @@ | [`UserDefinedData.name`](compolyx.plot_data.UserDefinedData.name.md#compolyx.plot_data.UserDefinedData.name) | Name of object | | [`UserDefinedData.parent`](compolyx.plot_data.UserDefinedData.parent.md#compolyx.plot_data.UserDefinedData.parent) | Parent object in tree | | [`UserDefinedData.ply_offset_scale_factor`](compolyx.plot_data.UserDefinedData.ply_offset_scale_factor.md#compolyx.plot_data.UserDefinedData.ply_offset_scale_factor) | Offset scale factor | -| [`UserDefinedData.ply_wise`](compolyx.plot_data.UserDefinedData.ply_wise.md#compolyx.plot_data.UserDefinedData.ply_wise) | Whether to plot ply-wise or element-wise. | +| [`UserDefinedData.ply_wise`](compolyx.plot_data.UserDefinedData.ply_wise.md#compolyx.plot_data.UserDefinedData.ply_wise) | Whether to plot ply-wise or element-wise | | [`UserDefinedData.requires_solution`](compolyx.plot_data.UserDefinedData.requires_solution.md#compolyx.plot_data.UserDefinedData.requires_solution) | | | [`UserDefinedData.root_path`](compolyx.plot_data.UserDefinedData.root_path.md#compolyx.plot_data.UserDefinedData.root_path) | Root path of the current node in the tree | -| [`UserDefinedData.scope_entire_model`](compolyx.plot_data.UserDefinedData.scope_entire_model.md#compolyx.plot_data.UserDefinedData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope. | -| [`UserDefinedData.show_on_solids`](compolyx.plot_data.UserDefinedData.show_on_solids.md#compolyx.plot_data.UserDefinedData.show_on_solids) | Whether to plot results on solid or shell elements. | +| [`UserDefinedData.scope_entire_model`](compolyx.plot_data.UserDefinedData.scope_entire_model.md#compolyx.plot_data.UserDefinedData.scope_entire_model) | Whether the plot scope is the entire model or a subset defined by the data_scope | +| [`UserDefinedData.show_on_solids`](compolyx.plot_data.UserDefinedData.show_on_solids.md#compolyx.plot_data.UserDefinedData.show_on_solids) | Whether to plot results on solid or shell elements | | [`UserDefinedData.show_ply_offsets`](compolyx.plot_data.UserDefinedData.show_ply_offsets.md#compolyx.plot_data.UserDefinedData.show_ply_offsets) | | -| [`UserDefinedData.show_user_text`](compolyx.plot_data.UserDefinedData.show_user_text.md#compolyx.plot_data.UserDefinedData.show_user_text) | Whether to show the user-defined text labels or not. | -| [`UserDefinedData.solution`](compolyx.plot_data.UserDefinedData.solution.md#compolyx.plot_data.UserDefinedData.solution) | Solution underlying the plot. | -| [`UserDefinedData.solution_set`](compolyx.plot_data.UserDefinedData.solution_set.md#compolyx.plot_data.UserDefinedData.solution_set) | Solution Set selection. | +| [`UserDefinedData.show_user_text`](compolyx.plot_data.UserDefinedData.show_user_text.md#compolyx.plot_data.UserDefinedData.show_user_text) | Whether to show the user-defined text labels or not | +| [`UserDefinedData.solution`](compolyx.plot_data.UserDefinedData.solution.md#compolyx.plot_data.UserDefinedData.solution) | Solution underlying the plot | +| [`UserDefinedData.solution_set`](compolyx.plot_data.UserDefinedData.solution_set.md#compolyx.plot_data.UserDefinedData.solution_set) | Solution Set selection | | [`UserDefinedData.spot`](compolyx.plot_data.UserDefinedData.spot.md#compolyx.plot_data.UserDefinedData.spot) | Not applicable to a user-defined plot | | [`UserDefinedData.spots`](compolyx.plot_data.UserDefinedData.spots.md#compolyx.plot_data.UserDefinedData.spots) | Return the possible spot set on this plot type | | [`UserDefinedData.status`](compolyx.plot_data.UserDefinedData.status.md#compolyx.plot_data.UserDefinedData.status) | Status of the object | -| [`UserDefinedData.status_changed`](compolyx.plot_data.UserDefinedData.status_changed.md#compolyx.plot_data.UserDefinedData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes. | -| [`UserDefinedData.text_threshold`](compolyx.plot_data.UserDefinedData.text_threshold.md#compolyx.plot_data.UserDefinedData.text_threshold) | Threshold above/below which user text is hidden. | -| [`UserDefinedData.text_threshold_type`](compolyx.plot_data.UserDefinedData.text_threshold_type.md#compolyx.plot_data.UserDefinedData.text_threshold_type) | "show_all" (default), "show_only_values_above_threshold", "show_only_values_below_threshold. | +| [`UserDefinedData.status_changed`](compolyx.plot_data.UserDefinedData.status_changed.md#compolyx.plot_data.UserDefinedData.status_changed) | Boolean flag which is set to true in C++ when up-to-date status of object changes | +| [`UserDefinedData.text_threshold`](compolyx.plot_data.UserDefinedData.text_threshold.md#compolyx.plot_data.UserDefinedData.text_threshold) | Threshold above/below which user text is hidden | +| [`UserDefinedData.text_threshold_type`](compolyx.plot_data.UserDefinedData.text_threshold_type.md#compolyx.plot_data.UserDefinedData.text_threshold_type) | "show_all" (default), "show_only_values_above_threshold", "show_only_values_below_threshold | | [`UserDefinedData.uid`](compolyx.plot_data.UserDefinedData.uid.md#compolyx.plot_data.UserDefinedData.uid) | UID of object | -| [`UserDefinedData.updated`](compolyx.plot_data.UserDefinedData.updated.md#compolyx.plot_data.UserDefinedData.updated) | Status boolean. | -| [`UserDefinedData.uptodate`](compolyx.plot_data.UserDefinedData.uptodate.md#compolyx.plot_data.UserDefinedData.uptodate) | Whether the plot is uptodate. | -| [`UserDefinedData.user_data`](compolyx.plot_data.UserDefinedData.user_data.md#compolyx.plot_data.UserDefinedData.user_data) | Access to the user-defined data of the plot. | -| [`UserDefinedData.user_element_centroids`](compolyx.plot_data.UserDefinedData.user_element_centroids.md#compolyx.plot_data.UserDefinedData.user_element_centroids) | Retrieve the centroids of the elements consistent with the current user element indices/labels. | -| [`UserDefinedData.user_element_indices`](compolyx.plot_data.UserDefinedData.user_element_indices.md#compolyx.plot_data.UserDefinedData.user_element_indices) | Access the indices for the given data-scope. | -| [`UserDefinedData.user_element_labels`](compolyx.plot_data.UserDefinedData.user_element_labels.md#compolyx.plot_data.UserDefinedData.user_element_labels) | Access the labels for the given data-scope. | +| [`UserDefinedData.updated`](compolyx.plot_data.UserDefinedData.updated.md#compolyx.plot_data.UserDefinedData.updated) | Status boolean | +| [`UserDefinedData.uptodate`](compolyx.plot_data.UserDefinedData.uptodate.md#compolyx.plot_data.UserDefinedData.uptodate) | Whether the plot is uptodate | +| [`UserDefinedData.user_data`](compolyx.plot_data.UserDefinedData.user_data.md#compolyx.plot_data.UserDefinedData.user_data) | Access to the user-defined data of the plot | +| [`UserDefinedData.user_element_centroids`](compolyx.plot_data.UserDefinedData.user_element_centroids.md#compolyx.plot_data.UserDefinedData.user_element_centroids) | Retrieve the centroids of the elements consistent with the current user element indices/labels | +| [`UserDefinedData.user_element_indices`](compolyx.plot_data.UserDefinedData.user_element_indices.md#compolyx.plot_data.UserDefinedData.user_element_indices) | Access the indices for the given data-scope | +| [`UserDefinedData.user_element_labels`](compolyx.plot_data.UserDefinedData.user_element_labels.md#compolyx.plot_data.UserDefinedData.user_element_labels) | Access the labels for the given data-scope | | [`UserDefinedData.user_script`](compolyx.plot_data.UserDefinedData.user_script.md#compolyx.plot_data.UserDefinedData.user_script) | Body of the script to be executed is user_script_enabled is set to True | | [`UserDefinedData.user_script_enabled`](compolyx.plot_data.UserDefinedData.user_script_enabled.md#compolyx.plot_data.UserDefinedData.user_script_enabled) | Whether to run a custom script on update | -| [`UserDefinedData.user_text`](compolyx.plot_data.UserDefinedData.user_text.md#compolyx.plot_data.UserDefinedData.user_text) | Access to the user-defined text of the plot. | -| [`UserDefinedData.vertex`](compolyx.plot_data.UserDefinedData.vertex.md#compolyx.plot_data.UserDefinedData.vertex) | This will throw an error if the object has been removed from the graph. | +| [`UserDefinedData.user_text`](compolyx.plot_data.UserDefinedData.user_text.md#compolyx.plot_data.UserDefinedData.user_text) | Access to the user-defined text of the plot | +| [`UserDefinedData.vertex`](compolyx.plot_data.UserDefinedData.vertex.md#compolyx.plot_data.UserDefinedData.vertex) | This will throw an error if the object has been removed from the graph | ### Methods | Name | Description | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [`UserDefinedData.add_data_scope_entity`](compolyx.plot_data.UserDefinedData.add_data_scope_entity.md#compolyx.plot_data.UserDefinedData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot. | -| [`UserDefinedData.clear_data_scope`](compolyx.plot_data.UserDefinedData.clear_data_scope.md#compolyx.plot_data.UserDefinedData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once. | -| [`UserDefinedData.display_data_create`](compolyx.plot_data.UserDefinedData.display_data_create.md#compolyx.plot_data.UserDefinedData.display_data_create)([parent]) | Function for internal use, not meant for scripting. | -| [`UserDefinedData.find_parent`](compolyx.plot_data.UserDefinedData.find_parent.md#compolyx.plot_data.UserDefinedData.find_parent)(type) | Function steps up the tree and returns the first parent with given type. | -| [`UserDefinedData.get_data`](compolyx.plot_data.UserDefinedData.get_data.md#compolyx.plot_data.UserDefinedData.get_data)([visible, selected]) | Get data of plot. | -| [`UserDefinedData.get_deformations`](compolyx.plot_data.UserDefinedData.get_deformations.md#compolyx.plot_data.UserDefinedData.get_deformations)([visible, ...]) | Function used internally to query matching nodal deformations for a given plot. | +| [`UserDefinedData.add_data_scope_entity`](compolyx.plot_data.UserDefinedData.add_data_scope_entity.md#compolyx.plot_data.UserDefinedData.add_data_scope_entity)(entity) | Add 1 entity to the Data Scope of a plot | +| [`UserDefinedData.clear_data_scope`](compolyx.plot_data.UserDefinedData.clear_data_scope.md#compolyx.plot_data.UserDefinedData.clear_data_scope)() | Cleares the complete data scope of a plot, i.e. all scope entities are removed at once | +| [`UserDefinedData.display_data_create`](compolyx.plot_data.UserDefinedData.display_data_create.md#compolyx.plot_data.UserDefinedData.display_data_create)([parent]) | Function for internal use, not meant for scripting | +| [`UserDefinedData.find_parent`](compolyx.plot_data.UserDefinedData.find_parent.md#compolyx.plot_data.UserDefinedData.find_parent)(type) | Function steps up the tree and returns the first parent with given type | +| [`UserDefinedData.get_data`](compolyx.plot_data.UserDefinedData.get_data.md#compolyx.plot_data.UserDefinedData.get_data)([visible, selected]) | Get data of plot | +| [`UserDefinedData.get_deformations`](compolyx.plot_data.UserDefinedData.get_deformations.md#compolyx.plot_data.UserDefinedData.get_deformations)([visible, ...]) | Function used internally to query matching nodal deformations for a given plot | | [`UserDefinedData.get_element_indices`](compolyx.plot_data.UserDefinedData.get_element_indices.md#compolyx.plot_data.UserDefinedData.get_element_indices)([...]) | Get element indices (ACP internal element numbers starting from 0) of plot | -| [`UserDefinedData.get_element_labels`](compolyx.plot_data.UserDefinedData.get_element_labels.md#compolyx.plot_data.UserDefinedData.get_element_labels)([...]) | Get element labels (element numbers as read from / written to mesh files) of plot. | -| [`UserDefinedData.get_full_description`](compolyx.plot_data.UserDefinedData.get_full_description.md#compolyx.plot_data.UserDefinedData.get_full_description)() | This function returns information displayed together with the legend. | -| [`UserDefinedData.get_ply_offsets`](compolyx.plot_data.UserDefinedData.get_ply_offsets.md#compolyx.plot_data.UserDefinedData.get_ply_offsets)([visible, ...]) | Get the offset between plies and reference surface. | -| [`UserDefinedData.obj_exists`](compolyx.plot_data.UserDefinedData.obj_exists.md#compolyx.plot_data.UserDefinedData.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. | -| [`UserDefinedData.remove_data_scope_entity`](compolyx.plot_data.UserDefinedData.remove_data_scope_entity.md#compolyx.plot_data.UserDefinedData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot. | +| [`UserDefinedData.get_element_labels`](compolyx.plot_data.UserDefinedData.get_element_labels.md#compolyx.plot_data.UserDefinedData.get_element_labels)([...]) | Get element labels (element numbers as read from / written to mesh files) of plot | +| [`UserDefinedData.get_full_description`](compolyx.plot_data.UserDefinedData.get_full_description.md#compolyx.plot_data.UserDefinedData.get_full_description)() | This function returns information displayed together with the legend | +| [`UserDefinedData.get_ply_offsets`](compolyx.plot_data.UserDefinedData.get_ply_offsets.md#compolyx.plot_data.UserDefinedData.get_ply_offsets)([visible, ...]) | Get the offset between plies and reference surface | +| [`UserDefinedData.obj_exists`](compolyx.plot_data.UserDefinedData.obj_exists.md#compolyx.plot_data.UserDefinedData.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 | +| [`UserDefinedData.remove_data_scope_entity`](compolyx.plot_data.UserDefinedData.remove_data_scope_entity.md#compolyx.plot_data.UserDefinedData.remove_data_scope_entity)(entity) | Remove 1 entity to the Data Scope of a plot | | [`UserDefinedData.serialize`](compolyx.plot_data.UserDefinedData.serialize.md#compolyx.plot_data.UserDefinedData.serialize)() | Serialize to Python string | | [`UserDefinedData.serialize_create_function`](compolyx.plot_data.UserDefinedData.serialize_create_function.md#compolyx.plot_data.UserDefinedData.serialize_create_function)() | | -| [`UserDefinedData.serialize_name_and_id`](compolyx.plot_data.UserDefinedData.serialize_name_and_id.md#compolyx.plot_data.UserDefinedData.serialize_name_and_id)() | Helper function to serialize name and ID. | +| [`UserDefinedData.serialize_name_and_id`](compolyx.plot_data.UserDefinedData.serialize_name_and_id.md#compolyx.plot_data.UserDefinedData.serialize_name_and_id)() | Helper function to serialize name and ID | | [`UserDefinedData.serialize_properties`](compolyx.plot_data.UserDefinedData.serialize_properties.md#compolyx.plot_data.UserDefinedData.serialize_properties)() | Serialize to Python string | | [`UserDefinedData.serialize_python_only_attributes`](compolyx.plot_data.UserDefinedData.serialize_python_only_attributes.md#compolyx.plot_data.UserDefinedData.serialize_python_only_attributes)() | | | [`UserDefinedData.update`](compolyx.plot_data.UserDefinedData.update.md#compolyx.plot_data.UserDefinedData.update)() | | | [`UserDefinedData.user_script_default`](compolyx.plot_data.UserDefinedData.user_script_default.md#compolyx.plot_data.UserDefinedData.user_script_default)() | | -| [`UserDefinedData.visit`](compolyx.plot_data.UserDefinedData.visit.md#compolyx.plot_data.UserDefinedData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node. | +| [`UserDefinedData.visit`](compolyx.plot_data.UserDefinedData.visit.md#compolyx.plot_data.UserDefinedData.visit)(visitor) | Walk through the tree and let the visitor perform action on every descendant node | diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.obj_exists.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.obj_exists.md index a42f65f411..fcbb0d8d78 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.obj_exists.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.obj_exists.md @@ -4,5 +4,5 @@ #### UserDefinedData.obj_exists() -Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND +Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.text_threshold_type.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.text_threshold_type.md index d5baf9d29e..4b34651527 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.text_threshold_type.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.text_threshold_type.md @@ -4,4 +4,4 @@ #### *property* UserDefinedData.text_threshold_type -“show_all” (default), “show_only_values_above_threshold”, “show_only_values_below_threshold. Threshold can be set using the text_threshold property +Available options: `show_all` (default), `show_only_values_above_threshold`, `show_only_values_below_threshold`. Threshold can be set using the text_threshold property. diff --git a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.uptodate.md b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.uptodate.md index 50bb8e1621..7d108611fa 100644 --- a/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.uptodate.md +++ b/2025R2/ACP_25R2_md/_autosummary/compolyx.plot_data.UserDefinedData.uptodate.md @@ -4,4 +4,4 @@ #### *property* UserDefinedData.uptodate -Whether the plot is uptodate. +Whether the plot is up-to-date. diff --git a/2025R2/ACP_25R2_md/classes_materialdata.md b/2025R2/ACP_25R2_md/classes_materialdata.md index 7fab9590e1..a40a9df30a 100644 --- a/2025R2/ACP_25R2_md/classes_materialdata.md +++ b/2025R2/ACP_25R2_md/classes_materialdata.md @@ -2,9 +2,9 @@ | Name | Description | |-----------------------------------------------------------------------------------------------------------|---------------------------------------------------| -| [`Fabric`](_autosummary/compolyx.Fabric.md#compolyx.Fabric)(graph, obj[, parent]) | Class to represent fabric. | -| [`Material`](_autosummary/compolyx.Material.md#compolyx.Material)(graph, obj[, parent]) | ComPoLyX material class. | -| [`MaterialData`](_autosummary/compolyx.MaterialData.md#compolyx.MaterialData)(graph[, parent]) | MaterialData manages all composite material data. | -| [`PropertySet`](_autosummary/compolyx.PropertySet.md#compolyx.PropertySet)(gil_wrapper[, parent_, name_]) | Python PropertySet class. | -| [`Stackup`](_autosummary/compolyx.Stackup.md#compolyx.Stackup)(graph, obj[, parent]) | Class to represent stackup. | -| [`SubLaminate`](_autosummary/compolyx.SubLaminate.md#compolyx.SubLaminate)(graph, obj[, parent]) | Class to represent sublaminate. | +| [`Fabric`](_autosummary/compolyx.Fabric.md#compolyx.Fabric)(graph, obj[, parent]) | Class to represent fabric | +| [`Material`](_autosummary/compolyx.Material.md#compolyx.Material)(graph, obj[, parent]) | ComPoLyX material class | +| [`MaterialData`](_autosummary/compolyx.MaterialData.md#compolyx.MaterialData)(graph[, parent]) | MaterialData manages all composite material data | +| [`PropertySet`](_autosummary/compolyx.PropertySet.md#compolyx.PropertySet)(gil_wrapper[, parent_, name_]) | Python PropertySet class | +| [`Stackup`](_autosummary/compolyx.Stackup.md#compolyx.Stackup)(graph, obj[, parent]) | Class to represent stackup | +| [`SubLaminate`](_autosummary/compolyx.SubLaminate.md#compolyx.SubLaminate)(graph, obj[, parent]) | Class to represent sublaminate | diff --git a/2025R2/ACP_25R2_md/classes_model.md b/2025R2/ACP_25R2_md/classes_model.md index 33b8668d83..4245327962 100644 --- a/2025R2/ACP_25R2_md/classes_model.md +++ b/2025R2/ACP_25R2_md/classes_model.md @@ -2,45 +2,45 @@ | Name | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------| -| [`AnalysisPly`](_autosummary/compolyx.AnalysisPly.md#compolyx.AnalysisPly)(graph, obj[, parent]) | ComPoLyX Class to represent analysis ply. | -| [`BooleanSelectionRule`](_autosummary/compolyx.BooleanSelectionRule.md#compolyx.BooleanSelectionRule)(graph, obj[, parent]) | Boolean selection rule. | -| [`ButtJointSequence`](_autosummary/compolyx.ButtJointSequence.md#compolyx.ButtJointSequence)(graph, obj[, parent]) | Class to represent the butt-joint sequence. | -| [`CADCompound`](_autosummary/compolyx.CADCompound.md#compolyx.CADCompound)(graph, obj[, parent]) | ComPoLyX Class to represent CADCompound. | -| [`CADFace`](_autosummary/compolyx.CADFace.md#compolyx.CADFace)(graph, obj[, parent]) | ComPoLyX Class to represent CADFace. | +| [`AnalysisPly`](_autosummary/compolyx.AnalysisPly.md#compolyx.AnalysisPly)(graph, obj[, parent]) | ComPoLyX class to represent analysis ply | +| [`BooleanSelectionRule`](_autosummary/compolyx.BooleanSelectionRule.md#compolyx.BooleanSelectionRule)(graph, obj[, parent]) | Boolean selection rule | +| [`ButtJointSequence`](_autosummary/compolyx.ButtJointSequence.md#compolyx.ButtJointSequence)(graph, obj[, parent]) | Class to represent the butt-joint sequence | +| [`CADCompound`](_autosummary/compolyx.CADCompound.md#compolyx.CADCompound)(graph, obj[, parent]) | ComPoLyX class to represent CADCompound | +| [`CADFace`](_autosummary/compolyx.CADFace.md#compolyx.CADFace)(graph, obj[, parent]) | ComPoLyX class to represent CADFace | | [`CADGeometry`](_autosummary/compolyx.CADGeometry.md#compolyx.CADGeometry)(graph, obj[, ...]) | | -| [`CADReference`](_autosummary/compolyx.CADReference.md#compolyx.CADReference)(graph, obj[, parent]) | ComPoLyX Class to represent CAD Reference. | -| [`CADShell`](_autosummary/compolyx.CADShell.md#compolyx.CADShell)(graph, obj[, parent]) | ComPoLyX Class to represent CADShell. | -| [`CADSolid`](_autosummary/compolyx.CADSolid.md#compolyx.CADSolid)(graph, obj[, parent]) | ComPoLyX Class to represent CADSolid. | -| [`Chapter`](_autosummary/compolyx.Chapter.md#compolyx.Chapter)(name, parent[, view, ply_entities, ...]) | Class to represent plybook chapter. | +| [`CADReference`](_autosummary/compolyx.CADReference.md#compolyx.CADReference)(graph, obj[, parent]) | ComPoLyX class to represent CAD Reference | +| [`CADShell`](_autosummary/compolyx.CADShell.md#compolyx.CADShell)(graph, obj[, parent]) | ComPoLyX class to represent CADShell | +| [`CADSolid`](_autosummary/compolyx.CADSolid.md#compolyx.CADSolid)(graph, obj[, parent]) | ComPoLyX class to represent CADSolid | +| [`Chapter`](_autosummary/compolyx.Chapter.md#compolyx.Chapter)(name, parent[, view, ply_entities, ...]) | Class to represent plybook chapter | | [`CutoffSelectionRule`](_autosummary/compolyx.CutoffSelectionRule.md#compolyx.CutoffSelectionRule)(graph, obj[, parent]) | | -| [`CylindricalSelectionRule`](_autosummary/compolyx.CylindricalSelectionRule.md#compolyx.CylindricalSelectionRule)(graph, obj[, parent]) | Cylindrical selection rule. | -| [`EdgeSet`](_autosummary/compolyx.EdgeSet.md#compolyx.EdgeSet)(graph[, obj, parent]) | Edge Set class. | -| [`ElementSelectionRule`](_autosummary/compolyx.ElementSelectionRule.md#compolyx.ElementSelectionRule)(graph, obj[, parent]) | Base class for rules. | -| [`ElementSet`](_autosummary/compolyx.ElementSet.md#compolyx.ElementSet)(graph[, obj, parent]) | Element set class. | -| [`EntitySet`](_autosummary/compolyx.EntitySet.md#compolyx.EntitySet)(graph, obj[, parent]) | Base class for entity sets. | +| [`CylindricalSelectionRule`](_autosummary/compolyx.CylindricalSelectionRule.md#compolyx.CylindricalSelectionRule)(graph, obj[, parent]) | Cylindrical selection rule | +| [`EdgeSet`](_autosummary/compolyx.EdgeSet.md#compolyx.EdgeSet)(graph[, obj, parent]) | Edge Set class | +| [`ElementSelectionRule`](_autosummary/compolyx.ElementSelectionRule.md#compolyx.ElementSelectionRule)(graph, obj[, parent]) | Base class for rules | +| [`ElementSet`](_autosummary/compolyx.ElementSet.md#compolyx.ElementSet)(graph[, obj, parent]) | Element Set class | +| [`EntitySet`](_autosummary/compolyx.EntitySet.md#compolyx.EntitySet)(graph, obj[, parent]) | Base class for entity sets | | [`FieldDefinition`](_autosummary/compolyx.FieldDefinition.md#compolyx.FieldDefinition)(graph, obj[, parent]) | Class to represent field definition. | -| [`GeometricalSelectionRule`](_autosummary/compolyx.GeometricalSelectionRule.md#compolyx.GeometricalSelectionRule)(graph, obj[, parent]) | Geometrical selection rule. | -| [`ImportedAnalysisPly`](_autosummary/compolyx.ImportedAnalysisPly.md#compolyx.ImportedAnalysisPly)(graph, obj[, parent]) | Class to represent an imported modeling ply. | +| [`GeometricalSelectionRule`](_autosummary/compolyx.GeometricalSelectionRule.md#compolyx.GeometricalSelectionRule)(graph, obj[, parent]) | Geometrical selection rule | +| [`ImportedAnalysisPly`](_autosummary/compolyx.ImportedAnalysisPly.md#compolyx.ImportedAnalysisPly)(graph, obj[, parent]) | Class to represent an imported modeling ply | | [`ImportedModelingGroup`](_autosummary/compolyx.ImportedModelingGroup.md#compolyx.ImportedModelingGroup)(graph, obj[, parent]) | | | [`ImportedModelingPly`](_autosummary/compolyx.ImportedModelingPly.md#compolyx.ImportedModelingPly)(graph, obj[, parent]) | | | [`ImportedProductionPly`](_autosummary/compolyx.ImportedProductionPly.md#compolyx.ImportedProductionPly)(graph, obj[, parent]) | | -| [`InterfaceLayer`](_autosummary/compolyx.InterfaceLayer.md#compolyx.InterfaceLayer)(graph, obj[, parent]) | Class to represent interface layer. | -| [`LookUpTable1D`](_autosummary/compolyx.LookUpTable1D.md#compolyx.LookUpTable1D)(obj[, parent]) | A LookUpTable to associate arbitrary data to a one-dimensional field of Locations. | -| [`LookUpTableBase`](_autosummary/compolyx.LookUpTableBase.md#compolyx.LookUpTableBase)(obj[, parent]) | Look-Up table class. | -| [`LookUpTableColumn`](_autosummary/compolyx.LookUpTableColumn.md#compolyx.LookUpTableColumn)(name, parent) | An object to hold a column in a table. | -| [`Model`](_autosummary/compolyx.Model.md#compolyx.Model)([name, path, format, ...]) | Class to represent a finite element model. | -| [`ModelingGroup`](_autosummary/compolyx.ModelingGroup.md#compolyx.ModelingGroup)(graph, obj[, parent]) | Class to manage modeling groups. | -| [`ModelingPly`](_autosummary/compolyx.ModelingPly.md#compolyx.ModelingPly)(graph, obj[, parent, element_vd]) | Class to represent modeling ply. | -| [`OrientedSelectionSet`](_autosummary/compolyx.OrientedSelectionSet.md#compolyx.OrientedSelectionSet)(graph, obj[, parent]) | Class to represent oriented selection set. | -| [`ParallelSelectionRule`](_autosummary/compolyx.ParallelSelectionRule.md#compolyx.ParallelSelectionRule)(graph, obj[, parent]) | Parallel selection rule. | -| [`PlyBook`](_autosummary/compolyx.PlyBook.md#compolyx.PlyBook)([name, parent, reST_ply, ...]) | Class to represent a ply book. | -| [`PublishedParameter`](_autosummary/compolyx.PublishedParameter.md#compolyx.PublishedParameter)(name, parent[, ...]) | Class to represent parameters which are linked to the Ansys Workbench application. | -| [`Rosette`](_autosummary/compolyx.Rosette.md#compolyx.Rosette)(graph, obj[, parent]) | Rosette class. | -| [`SamplingPoint`](_autosummary/compolyx.SamplingPoint.md#compolyx.SamplingPoint)(graph, obj[, parent]) | The sampling point enables picking through the laminate at a certain point to run detailed analyses. | -| [`Script`](_autosummary/compolyx.Script.md#compolyx.Script)(name, \*[, parent, source, active, ...]) | Class to represent user-defined scripts operating on the input parameters. | -| [`SectionCut`](_autosummary/compolyx.SectionCut.md#compolyx.SectionCut)(graph, obj[, parent, color_table]) | Section cut class showing the layup in the cutting plane. | -| [`Sensor`](_autosummary/compolyx.Sensor.md#compolyx.Sensor)(graph, obj[, parent]) | Sensor object for meassuring areas, prices, weights, and centers of gravity. | -| [`SphericalSelectionRule`](_autosummary/compolyx.SphericalSelectionRule.md#compolyx.SphericalSelectionRule)(graph, obj[, parent]) | Spherical selection rule. | -| [`TubeSelectionRule`](_autosummary/compolyx.TubeSelectionRule.md#compolyx.TubeSelectionRule)(graph, obj[, parent]) | Tube selection rule. | +| [`InterfaceLayer`](_autosummary/compolyx.InterfaceLayer.md#compolyx.InterfaceLayer)(graph, obj[, parent]) | Class to represent interface layer | +| [`LookUpTable1D`](_autosummary/compolyx.LookUpTable1D.md#compolyx.LookUpTable1D)(obj[, parent]) | A LookUpTable to associate arbitrary data to a one-dimensional field of Locations | +| [`LookUpTableBase`](_autosummary/compolyx.LookUpTableBase.md#compolyx.LookUpTableBase)(obj[, parent]) | Lookup table class | +| [`LookUpTableColumn`](_autosummary/compolyx.LookUpTableColumn.md#compolyx.LookUpTableColumn)(name, parent) | An object to hold a column in a table | +| [`Model`](_autosummary/compolyx.Model.md#compolyx.Model)([name, path, format, ...]) | Class to represent a finite element model | +| [`ModelingGroup`](_autosummary/compolyx.ModelingGroup.md#compolyx.ModelingGroup)(graph, obj[, parent]) | Class to manage modeling groups | +| [`ModelingPly`](_autosummary/compolyx.ModelingPly.md#compolyx.ModelingPly)(graph, obj[, parent, element_vd]) | Class to represent modeling ply | +| [`OrientedSelectionSet`](_autosummary/compolyx.OrientedSelectionSet.md#compolyx.OrientedSelectionSet)(graph, obj[, parent]) | Class to represent oriented selection set | +| [`ParallelSelectionRule`](_autosummary/compolyx.ParallelSelectionRule.md#compolyx.ParallelSelectionRule)(graph, obj[, parent]) | Parallel selection rule | +| [`PlyBook`](_autosummary/compolyx.PlyBook.md#compolyx.PlyBook)([name, parent, reST_ply, ...]) | Class to represent a ply book | +| [`PublishedParameter`](_autosummary/compolyx.PublishedParameter.md#compolyx.PublishedParameter)(name, parent[, ...]) | Class to represent parameters which are linked to the Ansys Workbench application | +| [`Rosette`](_autosummary/compolyx.Rosette.md#compolyx.Rosette)(graph, obj[, parent]) | Rosette class | +| [`SamplingPoint`](_autosummary/compolyx.SamplingPoint.md#compolyx.SamplingPoint)(graph, obj[, parent]) | The sampling point enables picking through the laminate at a certain point to run detailed analyses | +| [`Script`](_autosummary/compolyx.Script.md#compolyx.Script)(name, \*[, parent, source, active, ...]) | Class to represent user-defined scripts operating on the input parameters | +| [`SectionCut`](_autosummary/compolyx.SectionCut.md#compolyx.SectionCut)(graph, obj[, parent, color_table]) | Section cut class showing the layup in the cutting plane | +| [`Sensor`](_autosummary/compolyx.Sensor.md#compolyx.Sensor)(graph, obj[, parent]) | Sensor object for meassuring areas, prices, weights, and centers of gravity | +| [`SphericalSelectionRule`](_autosummary/compolyx.SphericalSelectionRule.md#compolyx.SphericalSelectionRule)(graph, obj[, parent]) | Spherical selection rule | +| [`TubeSelectionRule`](_autosummary/compolyx.TubeSelectionRule.md#compolyx.TubeSelectionRule)(graph, obj[, parent]) | Tube selection rule | | [`VariableOffsetSelectionRule`](_autosummary/compolyx.VariableOffsetSelectionRule.md#compolyx.VariableOffsetSelectionRule)(graph, obj[, parent]) | | -| [`VirtualGeometry`](_autosummary/compolyx.VirtualGeometry.md#compolyx.VirtualGeometry)(graph, obj[, parent]) | ComPoLyX class to represent VirtualGeometry. | +| [`VirtualGeometry`](_autosummary/compolyx.VirtualGeometry.md#compolyx.VirtualGeometry)(graph, obj[, parent]) | ComPoLyX class to represent VirtualGeometry | diff --git a/2025R2/ACP_25R2_md/classes_scene.md b/2025R2/ACP_25R2_md/classes_scene.md index 1c7be3b092..d5d25ccb68 100644 --- a/2025R2/ACP_25R2_md/classes_scene.md +++ b/2025R2/ACP_25R2_md/classes_scene.md @@ -2,5 +2,5 @@ | Name | Description | |--------------------------------------------------------------------------------------------------------|--------------------------------------------| -| [`Scene`](_autosummary/compolyx.Scene.md#compolyx.Scene)(graph[, model, name, id, title, view, ...]) | Class to represent scene. | -| [`View`](_autosummary/compolyx.View.md#compolyx.View)(name[, position, orientation, ...]) | ComPoLyX class to capture view properties. | +| [`Scene`](_autosummary/compolyx.Scene.md#compolyx.Scene)(graph[, model, name, id, title, view, ...]) | Class to represent scene | +| [`View`](_autosummary/compolyx.View.md#compolyx.View)(name[, position, orientation, ...]) | ComPoLyX class to capture view properties | diff --git a/2025R2/ACP_25R2_md/db_database.md b/2025R2/ACP_25R2_md/db_database.md index 24a05e2d97..2bee602c94 100644 --- a/2025R2/ACP_25R2_md/db_database.md +++ b/2025R2/ACP_25R2_md/db_database.md @@ -2,4 +2,4 @@ | Name | Description | |-----------------------------------------------------------------------|---------------------------------------------| -| [`DB`](_autosummary/compolyx.DB.md#compolyx.DB)(\*args, \*\*kwargs) | Class to represent the ComPoLyX database. | +| [`DB`](_autosummary/compolyx.DB.md#compolyx.DB)(\*args, \*\*kwargs) | Class to represent the ComPoLyX database | diff --git a/2025R2/ACP_25R2_md/getting_started_acp.md b/2025R2/ACP_25R2_md/getting_started_acp.md index 43765c78c2..c4cc8bf12d 100644 --- a/2025R2/ACP_25R2_md/getting_started_acp.md +++ b/2025R2/ACP_25R2_md/getting_started_acp.md @@ -4,7 +4,7 @@ ## Basic scripting -Python, an object oriented programming language, is the scripting language of ACP. It is recommended that you have some +The scripting language of ACP is Python, an object oriented programming language. It is recommended that you have some basic experience in object oriented programming for optimal use of the APIs, but a basic script can easily be written by modifying an existing one or using copy and paste from the History or Shell view. @@ -32,7 +32,7 @@ stress limits, Puck, and Tsai-Wu constants for the UD and core materials. A list These examples are provided as a guide to more involved commands in the shell view. They all refer to the example model Kiteboard. -**Maximum Layup Thickness** +**Maximum layup thickness** ```python # get active model @@ -48,7 +48,7 @@ index_of_max = thicknesses.index(max_thickness) element_label_with_max_thickness = labels[index_of_max] ``` -**Maximum Ply Thickness** +**Maximum ply thickness** ```python # get active model @@ -67,7 +67,7 @@ index_of_max = thicknesses.index(max_thickness) element_label_with_max_thickness = labels[index_of_max] ``` -**Maximum Inverse Reserve Factor and Failure Mode** +**Maximum inverse reserve factor and failure mode** ```python # get active model diff --git a/2025R2/ACP_25R2_md/python_object_tree.md b/2025R2/ACP_25R2_md/python_object_tree.md index 034d663b43..d68ee669cf 100644 --- a/2025R2/ACP_25R2_md/python_object_tree.md +++ b/2025R2/ACP_25R2_md/python_object_tree.md @@ -5,3 +5,5 @@ This tree contains all loaded models, solutions, definitions, views and scenes. Access to the actually loaded object tree is always provided through the root object [`compolyx.DB`](_autosummary/compolyx.DB.md#compolyx.DB) in the embedded Python shell. For better legibility of the image below, right-click and open it in a new tab. + +![Python object tree](./acp-tree.png) \ No newline at end of file