ConstructionLine

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.ConstructionLines.ConstructionLine

Bases: object

Overview

Methods

CreatePoints	CreatePoints method.
CreatePlanarPoints	CreatePlanarPoints method.
CreatePlane	Create a plane.
CreateStraightLines	CreateStraightLines method.
CreateStraightLines	CreateStraightLines method.
FlipEdges	FlipEdges method.
DeleteEdges	DeleteEdges method.
DeletePlane	Delete a plane associated with this construction line.
AddToGeometry	Add a part to Geometry with line bodies as contained in this ConstructionLine instance.
UpdateGeometry	Update the corresponding part with any changes made in this ConstructionLine instance.
RemoveFromGeometry	Remove the corresponding part from the geometry.
GetPartFromGeometry	Get the corresponding part for a ConstructionLine instance.
Undo	Undo the last operation in this Construction Line instance.
Redo	Redo and undone operation in this Construction Line instance.
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

Edges	Creates for the user an IEdge representation of each edge in this Construction Line.
Points	Returns all points in this Construction Line, both those that have been created
Planes	Creates for the user an Plane representation of each plane in this Construction Line.
InternalObject	Gets the internal object. For advanced usage only.
DataModelObjectCategory	Gets the current DataModelObject’s category.
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 ConstructionLine.Edges: System.Collections.Generic.IList[System.Object] | None

Creates for the user an IEdge representation of each edge in this Construction Line.

property ConstructionLine.Points: System.Collections.Generic.IList[System.Object] | None

Returns all points in this Construction Line, both those that have been created as well as virtual representations.

property ConstructionLine.Planes: System.Collections.Generic.IList[System.Object] | None

Creates for the user an Plane representation of each plane in this Construction Line.

property ConstructionLine.InternalObject: Ansys.Common.Interop.DSLines.IDSLinesPythonInteraction | None

Gets the internal object. For advanced usage only.

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

Gets the current DataModelObject’s category.

property ConstructionLine.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property ConstructionLine.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property ConstructionLine.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property ConstructionLine.ReadOnly: System.Boolean | None

Gets or sets the ReadOnly.

property ConstructionLine.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property ConstructionLine.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property ConstructionLine.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

ConstructionLine.CreatePoints(pointDefinitionCollection: System.Collections.Generic.IEnumerable[System.Object]) → System.Collections.Generic.IList[System.Object]

CreatePoints method.

ConstructionLine.CreatePlanarPoints(plane: Ansys.Mechanical.DataModel.ConstructionLines.Plane, pointDefinitionCollection: System.Collections.Generic.IEnumerable[System.Object]) → System.Collections.Generic.IList[System.Object]

CreatePlanarPoints method.

ConstructionLine.CreatePlane(sketchPlaneDefinition: System.Object) → Ansys.Mechanical.DataModel.ConstructionLines.Plane

Create a plane.

ConstructionLine.CreateStraightLines(pointCollection: System.Collections.Generic.IEnumerable[Ansys.Mechanical.DataModel.ConstructionLines.Point]) → System.Collections.Generic.IList[System.Object]

CreateStraightLines method.

ConstructionLine.CreateStraightLines(pointCollection: System.Collections.Generic.IEnumerable[Ansys.Mechanical.DataModel.ConstructionLines.Point], connectionCollection: System.Collections.Generic.IEnumerable[System.Collections.Generic.IEnumerable[System.Object]]) → System.Collections.Generic.IList[System.Object]

CreateStraightLines method.

ConstructionLine.FlipEdges(edgesToFlip: System.Collections.Generic.IEnumerable[Ansys.Mechanical.DataModel.ConstructionLines.Edges.IEdge]) → System.Void

FlipEdges method.

ConstructionLine.DeleteEdges(edgeCollection: System.Collections.Generic.IEnumerable[Ansys.Mechanical.DataModel.ConstructionLines.Edges.IEdge]) → System.Void

DeleteEdges method.

ConstructionLine.DeletePlane(plane: Ansys.Mechanical.DataModel.ConstructionLines.Plane, forceDelete: System.Boolean) → System.Void

Delete a plane associated with this construction line.

ConstructionLine.AddToGeometry() → Ansys.ACT.Interfaces.Geometry.IGeoPart

Add a part to Geometry with line bodies as contained in this ConstructionLine instance.

ConstructionLine.UpdateGeometry() → System.Void

Update the corresponding part with any changes made in this ConstructionLine instance.

ConstructionLine.RemoveFromGeometry() → System.Void

Remove the corresponding part from the geometry.

ConstructionLine.GetPartFromGeometry() → Ansys.ACT.Interfaces.Geometry.IGeoPart

Get the corresponding part for a ConstructionLine instance.

ConstructionLine.Undo() → System.Void

Undo the last operation in this Construction Line instance.

ConstructionLine.Redo() → System.Void

Redo and undone operation in this Construction Line instance.

ConstructionLine.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

ConstructionLine.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

ConstructionLine.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.

ConstructionLine.Activate() → System.Void

Activate the current object.

ConstructionLine.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void

Copies all visible properties from this object to another.

ConstructionLine.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

ConstructionLine.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

ConstructionLine.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

ConstructionLine.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

ConstructionLine.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.

ConstructionLine.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

ConstructionLine.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

ConstructionLine.RemoveParameter(propName: System.String) → System.Void

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