`CoordinateSystem`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.CoordinateSystem#

Bases: object

Defines a CoordinateSystem.

Overview#

Methods

`Activate`	Activate the current object.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`AddTransformation`	Adds a new transformation.
`CopyTo`	Copies all visible properties from this object to another.
`CreateConstructionSurface`	Run the CreateConstructionSurface action.
`CreateParameter`	Creates a new parameter for a Property.
`CreateSectionPlane`	Run the CreateSectionPlane action.
`Delete`	Run the Delete action.
`Duplicate`	Creates a copy of the current DataModelObject.
`FlipX`	Flips the X Axis of the coordinate system
`FlipY`	Flips the Y Axis of the coordinate system
`FlipZ`	Flips the Z Axis of the coordinate system
`GetChildren`	Gets the list of children, filtered by type.
`GetParameter`	Gets the parameter corresponding to the given property.
`GetTransformationValue`	Gets the value of a transformation.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`MoveTransformationDown`	Moves a transformation down.
`MoveTransformationUp`	Moves a transformation up.
`OffsetX`	Creates an offset in the X Axis direction of the coordinate system
`OffsetY`	Creates an offset in the Y Axis direction of the coordinate system
`OffsetZ`	Creates an offset in the Z Axis direction of the coordinate system
`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.
`RemoveTransformation`	Removes a tranformation.
`RotateX`	Creates a rotation about the X Axis of the coordinate system
`RotateY`	Creates a rotation about the Y Axis of the coordinate system
`RotateZ`	Creates a rotation about the Z Axis of the coordinate system
`SetCoordinateSystemOriginAtCenterOfMass`	SetCoordinateSystemOriginAtCenterOfMass method.
`SetOriginLocation`	Changes the origin location.
`SetPrimaryAxisUsingCenterOfMass`	Sets the primary axis using a 1 or 2 point selection and the center of mass
`SetTransformationValue`	Sets the value of a transformation.

Properties

`APDLName`	Gets or sets the APDLName.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`CoordinateSystemID`	Gets or sets the CoordinateSystemID.
`CoordinateSystemIDGeneration`	Gets or sets the CoordinateSystemIDGeneration.
`CoordinateSystemType`	Gets or sets the CoordinateSystemType.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`Figures`	Gets the list of associated figures.
`GloballyAvailable`	Gets or sets the GloballyAvailable.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`IsGlobal`	Gets the IsGlobal.
`OriginDefineBy`	Gets or sets the origin define by.
`OriginLocation`	Gets or sets the origin location.
`OriginX`	Gets or sets the origin X coordinate.
`OriginY`	Gets or sets the origin Y coordinate.
`OriginZ`	Gets or sets the origin Z coordinate.
`PrimaryAxis`	Gets or sets the PrimaryAxis.
`PrimaryAxisDefineBy`	Gets or sets the PrimaryAxisDefineBy.
`PrimaryAxisDirection`	Gets or sets the Principal Axis Direction.
`PrimaryAxisLocation`	Gets or sets the principal axis geometry selection.
`Properties`	Gets the list of properties for this object.
`ReadOnly`	Gets or sets the ReadOnly.
`SecondaryAxis`	Gets or sets the SecondaryAxis.
`SecondaryAxisDefineBy`	Gets or sets the SecondaryAxisDefineBy.
`SecondaryAxisDirection`	Gets the Secondary Axis Direction.
`SecondaryAxisLocation`	Gets or sets the orientation about principal axis geometry selection.
`Suppressed`	Gets or sets the Suppressed.
`TransformationCount`	Gets the number of transformations.
`TransformedConfiguration`	Gets the TransformedConfiguration.
`VisibleProperties`	Gets the list of properties that are visible for this object.
`XAxisData`	Gets the XAxisData.
`YAxisData`	Gets the YAxisData.
`ZAxisData`	Gets the ZAxisData.

Property detail#

property CoordinateSystem.APDLName: str | None#: Gets or sets the APDLName.

property CoordinateSystem.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property CoordinateSystem.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

property CoordinateSystem.CoordinateSystemID: int | None#: Gets or sets the CoordinateSystemID.

property CoordinateSystem.CoordinateSystemIDGeneration: Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None#: Gets or sets the CoordinateSystemIDGeneration.

property CoordinateSystem.CoordinateSystemType: Ansys.ACT.Interfaces.Analysis.CoordinateSystemTypeEnum | None#: Gets or sets the CoordinateSystemType.

property CoordinateSystem.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

property CoordinateSystem.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property CoordinateSystem.GloballyAvailable: bool | None#: Gets or sets the GloballyAvailable.

property CoordinateSystem.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property CoordinateSystem.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCoordinateSystemAuto | None#: Gets the internal object. For advanced usage only.

property CoordinateSystem.IsGlobal: bool | None#: Gets the IsGlobal.

property CoordinateSystem.OriginDefineBy: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAlignmentType | None#: Gets or sets the origin define by.

property CoordinateSystem.OriginLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#: Gets or sets the origin location.

property CoordinateSystem.OriginX: Ansys.Core.Units.Quantity | None#: Gets or sets the origin X coordinate.

property CoordinateSystem.OriginY: Ansys.Core.Units.Quantity | None#: Gets or sets the origin Y coordinate.

property CoordinateSystem.OriginZ: Ansys.Core.Units.Quantity | None#: Gets or sets the origin Z coordinate.

property CoordinateSystem.PrimaryAxis: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType | None#: Gets or sets the PrimaryAxis.

property CoordinateSystem.PrimaryAxisDefineBy: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAlignmentType | None#: Gets or sets the PrimaryAxisDefineBy.

property CoordinateSystem.PrimaryAxisDirection: Ansys.ACT.Math.Vector3D | None#: Gets or sets the Principal Axis Direction.

property CoordinateSystem.PrimaryAxisLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#: Gets or sets the principal axis geometry selection.

property CoordinateSystem.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property CoordinateSystem.ReadOnly: bool | None#: Gets or sets the ReadOnly.

property CoordinateSystem.SecondaryAxis: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType | None#: Gets or sets the SecondaryAxis.

property CoordinateSystem.SecondaryAxisDefineBy: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAlignmentType | None#: Gets or sets the SecondaryAxisDefineBy.

property CoordinateSystem.SecondaryAxisDirection: Ansys.ACT.Math.Vector3D | None#: Gets the Secondary Axis Direction.

property CoordinateSystem.SecondaryAxisLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#: Gets or sets the orientation about principal axis geometry selection.

property CoordinateSystem.Suppressed: bool | None#: Gets or sets the Suppressed.

property CoordinateSystem.TransformationCount: int | None#: Gets the number of transformations.

property CoordinateSystem.TransformedConfiguration: str | None#: Gets the TransformedConfiguration.

property CoordinateSystem.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

property CoordinateSystem.XAxisData: str | None#: Gets the XAxisData.

property CoordinateSystem.YAxisData: str | None#: Gets the YAxisData.

property CoordinateSystem.ZAxisData: str | None#: Gets the ZAxisData.

Method detail#

CoordinateSystem.Activate() → None#: Activate the current object.

CoordinateSystem.AddComment() → Ansys.ACT.Automation.Mechanical.Comment#: Creates a new child Comment.

CoordinateSystem.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure#: Creates a new child Figure.

CoordinateSystem.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image#

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.

CoordinateSystem.AddTransformation(trans: Ansys.Mechanical.DataModel.Enums.TransformationType, axis: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType) → None#: Adds a new transformation.

CoordinateSystem.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

CoordinateSystem.CreateConstructionSurface() → None#: Run the CreateConstructionSurface action.

CoordinateSystem.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Creates a new parameter for a Property.

CoordinateSystem.CreateSectionPlane() → None#: Run the CreateSectionPlane action.

CoordinateSystem.Delete() → None#: Run the Delete action.

CoordinateSystem.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#: Creates a copy of the current DataModelObject.

CoordinateSystem.FlipX() → None#: Flips the X Axis of the coordinate system

CoordinateSystem.FlipY() → None#: Flips the Y Axis of the coordinate system

CoordinateSystem.FlipZ() → None#: Flips the Z Axis of the coordinate system

CoordinateSystem.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

CoordinateSystem.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

CoordinateSystem.GetTransformationValue(index: int) → Any#: Gets the value of a transformation.

CoordinateSystem.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

CoordinateSystem.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#: Run the GroupSimilarObjects action.

CoordinateSystem.MoveTransformationDown(index: int) → None#: Moves a transformation down.

CoordinateSystem.MoveTransformationUp(index: int) → None#: Moves a transformation up.

CoordinateSystem.OffsetX() → None#: Creates an offset in the X Axis direction of the coordinate system

CoordinateSystem.OffsetY() → None#: Creates an offset in the Y Axis direction of the coordinate system

CoordinateSystem.OffsetZ() → None#: Creates an offset in the Z Axis direction of the coordinate system

CoordinateSystem.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property#

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.

CoordinateSystem.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

CoordinateSystem.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.

CoordinateSystem.RemoveTransformation(index: int) → None#: Removes a tranformation.

CoordinateSystem.RotateX() → None#: Creates a rotation about the X Axis of the coordinate system

CoordinateSystem.RotateY() → None#: Creates a rotation about the Y Axis of the coordinate system

CoordinateSystem.RotateZ() → None#: Creates a rotation about the Z Axis of the coordinate system

CoordinateSystem.SetCoordinateSystemOriginAtCenterOfMass(geoBodies: List[Ansys.ACT.Interfaces.Geometry.IBaseGeoBody], pointMasses: List[Ansys.ACT.Automation.Mechanical.PointMass], distributedMasses: List[Ansys.ACT.Automation.Mechanical.DistributedMass]) → None#: SetCoordinateSystemOriginAtCenterOfMass method.

CoordinateSystem.SetOriginLocation(originX: Ansys.Core.Units.Quantity, originY: Ansys.Core.Units.Quantity, originZ: Ansys.Core.Units.Quantity) → None#: Changes the origin location.

CoordinateSystem.SetPrimaryAxisUsingCenterOfMass() → None#: Sets the primary axis using a 1 or 2 point selection and the center of mass

CoordinateSystem.SetTransformationValue(index: int, value: Any) → None#: Sets the value of a transformation.