`CoordinateSystem`#

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

Bases: object

Defines a CoordinateSystem.

Overview#

Methods

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

Properties

`TransformationCount`	Gets the number of transformations.
`IsGlobal`	Gets the IsGlobal.
`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.
`OriginDefineBy`	Gets or sets the origin define by.
`PrimaryAxisDirection`	Gets or sets the Principal Axis Direction.
`SecondaryAxisDirection`	Gets the Secondary Axis Direction.
`PrimaryAxisLocation`	Gets or sets the principal axis geometry selection.
`SecondaryAxisLocation`	Gets or sets the orientation about principal axis geometry selection.
`CoordinateSystemType`	Gets or sets the CoordinateSystemType.
`APDLName`	Gets or sets the APDLName.
`InternalObject`	Gets the internal object. For advanced usage only.
`CoordinateSystemID`	Gets or sets the CoordinateSystemID.
`TransformedConfiguration`	Gets the TransformedConfiguration.
`XAxisData`	Gets the XAxisData.
`YAxisData`	Gets the YAxisData.
`ZAxisData`	Gets the ZAxisData.
`CoordinateSystemIDGeneration`	Gets or sets the CoordinateSystemIDGeneration.
`PrimaryAxis`	Gets or sets the PrimaryAxis.
`PrimaryAxisDefineBy`	Gets or sets the PrimaryAxisDefineBy.
`SecondaryAxis`	Gets or sets the SecondaryAxis.
`SecondaryAxisDefineBy`	Gets or sets the SecondaryAxisDefineBy.
`GloballyAvailable`	Gets or sets the GloballyAvailable.
`Suppressed`	Gets or sets the Suppressed.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property CoordinateSystem.TransformationCount: System.UInt32 | None: Gets the number of transformations.

property CoordinateSystem.IsGlobal: System.Boolean | None: Gets the IsGlobal.

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.OriginDefineBy: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAlignmentType | None: Gets or sets the origin define by.

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

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

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

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

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

property CoordinateSystem.APDLName: System.String | None: Gets or sets the APDLName.

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

property CoordinateSystem.CoordinateSystemID: System.Int32 | None: Gets or sets the CoordinateSystemID.

property CoordinateSystem.TransformedConfiguration: System.String | None: Gets the TransformedConfiguration.

property CoordinateSystem.XAxisData: System.String | None: Gets the XAxisData.

property CoordinateSystem.YAxisData: System.String | None: Gets the YAxisData.

property CoordinateSystem.ZAxisData: System.String | None: Gets the ZAxisData.

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

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.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.GloballyAvailable: System.Boolean | None: Gets or sets the GloballyAvailable.

property CoordinateSystem.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

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

property CoordinateSystem.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property CoordinateSystem.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property CoordinateSystem.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property CoordinateSystem.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property CoordinateSystem.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property CoordinateSystem.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property CoordinateSystem.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

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

Method detail#

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

CoordinateSystem.RemoveTransformation(index: System.UInt32) → System.Void: Removes a tranformation.

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

CoordinateSystem.SetTransformationValue(index: System.UInt32, value: System.Object) → System.Void: Sets the value of a transformation.

CoordinateSystem.GetTransformationValue(index: System.UInt32) → System.Object: Gets the value of a transformation.

CoordinateSystem.MoveTransformationUp(index: System.UInt32) → System.Void: Moves a transformation up.

CoordinateSystem.MoveTransformationDown(index: System.UInt32) → System.Void: Moves a transformation down.

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

CoordinateSystem.FlipX() → System.Void: Flips the X Axis of the coordinate system

CoordinateSystem.FlipY() → System.Void: Flips the Y Axis of the coordinate system

CoordinateSystem.FlipZ() → System.Void: Flips the Z Axis of the coordinate system

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

CoordinateSystem.OffsetX(value: System.Object) → System.Void: Creates an offset in the X Axis direction of the coordinate system

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

CoordinateSystem.OffsetY(value: System.Object) → System.Void: Creates an offset in the Y Axis direction of the coordinate system

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

CoordinateSystem.OffsetZ(value: System.Object) → System.Void: Creates an offset in the Z Axis direction of the coordinate system

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

CoordinateSystem.RotateX(value: System.Object) → System.Void: Creates a rotation about the X Axis of the coordinate system

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

CoordinateSystem.RotateY(value: System.Object) → System.Void: Creates a rotation about the Y Axis of the coordinate system

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

CoordinateSystem.RotateZ(value: System.Object) → System.Void: Creates a rotation about the Z Axis of the coordinate system

CoordinateSystem.SetCoordinateSystemOriginAtCenterOfMass(geoBodies: System.Collections.Generic.IList[Ansys.ACT.Interfaces.Geometry.IBaseGeoBody], pointMasses: System.Collections.Generic.IList[Ansys.ACT.Automation.Mechanical.PointMass], distributedMasses: System.Collections.Generic.IList[Ansys.ACT.Automation.Mechanical.DistributedMass]) → System.Void: SetCoordinateSystemOriginAtCenterOfMass method.

CoordinateSystem.CreateConstructionSurface() → System.Void: Run the CreateConstructionSurface action.

CoordinateSystem.CreateSectionPlane() → System.Void: Run the CreateSectionPlane action.

CoordinateSystem.Delete() → System.Void: Run the Delete action.

CoordinateSystem.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

CoordinateSystem.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

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: System.String) → 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.Activate() → System.Void: Activate the current object.

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

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

CoordinateSystem.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

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

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

CoordinateSystem.PropertyByAPIName(name: System.String) → 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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

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

CoordinateSystem.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.