Skip to main content

Mechanical scripting interface

NodeMove

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.NodeMove

Bases: object

Defines a NodeMove.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
GetChildren Gets the list of children, filtered by type.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
MorphNodes Morph all the nodes.
MoveNode Moves a node to a new specified location. The given locX, locY, and locZ values will be converted to the unit system the mesh is stored in, and the given node will be moved to that absolute location.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
UndoAllNodeMoves Undos all moves done to a node.
UndoLastNodeMove Undos the last move done to a node.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
Information Gets the Information.
InternalObject Gets the internal object. For advanced usage only.
NumberOfMoves Gets the NumberOfMoves.
NumberOfNodes Gets the NumberOfNodes.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property NodeMove.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property NodeMove.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property NodeMove.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property NodeMove.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property NodeMove.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property NodeMove.Information : Ansys.Mechanical.DataModel.Enums.NodeMoveInformationType | None

Gets the Information.

property NodeMove.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSNodeMoveAuto | None

Gets the internal object. For advanced usage only.

property NodeMove.NumberOfMoves : int | None

Gets the NumberOfMoves.

property NodeMove.NumberOfNodes : int | None

Gets the NumberOfNodes.

property NodeMove.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property NodeMove.ReadOnly : bool | None

Gets or sets the ReadOnly.

property NodeMove.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

NodeMove.Activate()

Activate the current object.

NodeMove.AddComment()

Creates a new child Comment.

NodeMove.AddFigure()

Creates a new child Figure.

NodeMove.AddImage(filePath: str)

Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

NodeMove.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

NodeMove.CreateParameter(propName: str)

Creates a new parameter for a Property.

NodeMove.Delete()

Run the Delete action.

NodeMove.Duplicate()

Creates a copy of the current DataModelObject.

NodeMove.GetChildren(recurses: bool, children: List[ChildrenType])

Gets the list of children, filtered by type.

NodeMove.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

NodeMove.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

NodeMove.GroupSimilarObjects()

Run the GroupSimilarObjects action.

NodeMove.MorphNodes()

Morph all the nodes.

NodeMove.MoveNode(nodeId: int, locX: Ansys.Core.Units.Quantity, locY: Ansys.Core.Units.Quantity, locZ: Ansys.Core.Units.Quantity)

Moves a node to a new specified location. The given locX, locY, and locZ values will be converted to the unit system the mesh is stored in, and the given node will be moved to that absolute location.

NodeMove.PropertyByAPIName(name: str)

Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

NodeMove.PropertyByName(name: str)

Get a property by its unique name.

NodeMove.RemoveParameter(propName: str)

Removes the parameter from the parameter set corresponding to the given property.

NodeMove.UndoAllNodeMoves()

Undos all moves done to a node.

NodeMove.UndoLastNodeMove()

Undos the last move done to a node.