Class: ConstructionLine

Enables the construction and generation of straight line edges directly within Mechanical.

Remarks

Any returned collections are internally IronPython runtime types for console compatibility. To convert to strongly-typed C# collections, consider the following snippets: IList<object><instance>.Cast<item_type>()IDictionary<object, object><instance>.ToDictionary(kvp => (<key_type>) kvp.Key, kvp => (<value_type> kvp.Value)

Methods

Name Description
Activate() Activate the current object.
AddComment() Creates a new child Comment.
AddFigure() Creates a new child Figure.
AddImage(String) 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.
AddToGeometry() Add a part to Geometry with line bodies as contained in this ConstructionLine instance.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
CreatePlanarPoints(Plane, IEnumerable<Object>)
CreatePlane(Object) Create a plane.
CreatePoints(IEnumerable<Object>) Create virtual points according to the provided data.
CreateStraightLines(IEnumerable<Point>) Create straight line edges by sequential connection of the provided points.
CreateStraightLines(IEnumerable<Point>, IEnumerable<IEnumerable<Object>>) Create straight line edges by connecting the provided points via specified connections.
DeleteEdges(IEnumerable<IEdge>) Delete edges associated with this construction line.
DeletePlane(Plane, Boolean) Delete a plane associated with this construction line.
Duplicate() Creates a copy of the current DataModelObject.
FlipEdges(IEnumerable<IEdge>) Flip the direction of the given edge/s.
GetParameter(String) Gets the parameter corresponding to the given property.
GetPartFromGeometry() Get the corresponding part for a ConstructionLine instance.
GetPath() Gets the path of the object.
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
PropertyByAPIName(String) 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.
PropertyByName(String) Get a property by its unique name.
Redo() Redo and undone operation in this Construction Line instance.
RemoveFromGeometry() Remove the corresponding part from the geometry.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
Undo() Undo the last operation in this Construction Line instance.
UpdateGeometry() Update the corresponding part with any changes made in this ConstructionLine instance.

Properties

Name Description
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
Edges Creates for the user an IEdge representation of each edge in this Construction Line.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Name Gets the name of the object.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
Parent Gets the parent object.
Planes Creates for the user an Plane representation of each plane in this Construction Line.
Points Returns all points in this Construction Line, both those that have been created as well as virtual representations.
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.