Class: Path

Defines a Path.

Implemented types

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.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
Delete() Run the Delete action.
Duplicate() Creates a copy of the current DataModelObject.
FlipPathOrientatation() Flip Path Orientatation
GetParameter(String) Gets the parameter corresponding to the given property.
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.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
SnapPathToMeshNodes() Snap path to mesh nodes

Properties

Name Description
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DiscretizationPoints Gets or sets the DiscretizationPoints.
EndCoordinateSystem Gets or sets the EndCoordinateSystem.
EndXCoordinate Gets or sets the EndXCoordinate.
EndYCoordinate Gets or sets the EndYCoordinate.
EndZCoordinate Gets or sets the EndZCoordinate.
Figures Gets the list of associated figures.
HasValidGeometrySelection Gets the HasValidGeometrySelection.
Id Gets the selection identifier.
Ids Gets or sets selected IDs.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
Name Gets the name of the object.
NumberOfSamplingPoints Gets or sets the NumberOfSamplingPoints.
NumberOfSubpaths Gets or sets the NumberOfSubpaths.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
OffsetEdgeLocation Gets or sets the OffsetEdgeLocation.
Parent Gets the parent object.
PathCoordinateSystem Gets or sets the PathCoordinateSystem.
PathType Gets or sets the PathType.
Properties Gets the list of properties for this object.
SelectionType Gets or sets the selection type.
ShowMesh Gets or sets the ShowMesh.
SnapToMeshNodes Gets or sets the SnapToMeshNodes.
StartCoordinateSystem Gets or sets the StartCoordinateSystem.
StartXCoordinate Gets or sets the StartXCoordinate.
StartYCoordinate Gets or sets the StartYCoordinate.
StartZCoordinate Gets or sets the StartZCoordinate.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.