The PathOfTravel type exposes the following members.
Methods
Name | Description | |
---|---|---|
ArePhasesModifiable |
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from
Element
.)
|
|
CanBeHidden |
Indicates if the element can be hidden in the view.
(Inherited from
Element
.)
|
|
CanBeLocked |
Identifies if the element can be locked.
(Inherited from
Element
.)
|
|
CanDeleteSubelement |
Checks if given subelement can be removed from the element.
(Inherited from
Element
.)
|
|
CanHaveTypeAssigned |
Identifies if the element can have a type assigned.
(Inherited from
Element
.)
|
|
ChangeTypeId(ElementId) |
Changes the type of the element.
(Inherited from
Element
.)
|
|
Create(View, XYZ, XYZ) |
Creates a new path of travel between two points.
|
|
Create(View, XYZ, XYZ, PathOfTravelCalculationStatus ) |
Creates a new path of travel between two points and provides creation result status.
|
|
CreateMapped(View, IList XYZ , IList XYZ ) |
Creates multiple new paths of travel by mapping each of a set of start points to each of a set of end points.
|
|
CreateMapped(View, IList XYZ , IList XYZ , IList PathOfTravelCalculationStatus ) |
Creates multiple new paths of travel by mapping each of a set of start points to each of a set of end points and provides creation result statuses.
|
|
CreateMultiple(View, IList XYZ , IList XYZ ) |
Creates multiple new paths of travel between same size sets of start and end points.
|
|
CreateMultiple(View, IList XYZ , IList XYZ , IList PathOfTravelCalculationStatus ) |
Creates multiple new paths of travel between same size sets of start and end points and provides creation result statuses.
|
|
DeleteEntity |
Deletes the existing entity created by %schema% in the element
(Inherited from
Element
.)
|
|
DeleteSubelement |
Removes a subelement from the element.
(Inherited from
Element
.)
|
|
DeleteSubelements |
Removes the subelements from the element.
(Inherited from
Element
.)
|
|
Dispose | (Inherited from Element .) | |
Equals |
Determines whether the specified
Object
is equal to the current
Object
.
(Inherited from
Object
.)
|
|
EvaluateAllParameterValues |
Evaluates all the parameters' values of the element.
(Inherited from
Element
.)
|
|
EvaluateParameterValues |
Evaluate the parameters' values of the element on the given parameter ID set.
(Inherited from
Element
.)
|
|
FindEndsOfShortestPaths |
For a floor plan view, calculates the paths from each start point to its closest destination and return the path end points.
|
|
FindShortestPaths |
For a floor plan view, calculates paths from each start point to its closest destinations.
Returns the path, represented by an array of XYZ points.
|
|
FindStartsOfLongestPathsFromRooms |
For a floor plan view, calculates paths from points inside rooms to the closests of the destinations.
Returns the start points of the longest path(s). If multiple paths have the same longest length, returns multiple start points.
|
|
GetCurves |
Gets the array of curves representing the path of travel.
|
|
GetDependentElements |
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from
Element
.)
|
|
GetEntity |
Returns the existing entity corresponding to the Schema if it has been saved in the
Element, or an invalid entity otherwise.
(Inherited from
Element
.)
|
|
GetEntitySchemaGuids |
Returns the Schema guids of any Entities stored in this element.
(Inherited from
Element
.)
|
|
GetExternalFileReference |
Gets information pertaining to the external file referenced
by the element.
(Inherited from
Element
.)
|
|
GetExternalResourceReference |
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from
Element
.)
|
|
GetExternalResourceReferenceExpanded |
Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from
Element
.)
|
|
GetExternalResourceReferences |
Gets the map of the external resource references referenced
by the element.
(Inherited from
Element
.)
|
|
GetExternalResourceReferencesExpanded |
Gets the expanded map of the external resource references referenced
by the element.
(Inherited from
Element
.)
|
|
GetGeneratingElementIds |
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from
Element
.)
|
|
GetGeometryObjectFromReference |
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from
Element
.)
|
|
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from
Object
.)
|
|
GetMaterialArea |
Gets the area of the material with the given id.
(Inherited from
Element
.)
|
|
GetMaterialIds |
Gets the element ids of all materials present in the element.
(Inherited from
Element
.)
|
|
GetMaterialVolume |
Gets the volume of the material with the given id.
(Inherited from
Element
.)
|
|
GetMonitoredLinkElementIds |
Provides the link instance IDs when the element is monitoring.
(Inherited from
Element
.)
|
|
GetMonitoredLocalElementIds |
Provides the local element IDs when the element is monitoring.
(Inherited from
Element
.)
|
|
GetOrderedParameters |
Gets the parameters associated to the element in order.
(Inherited from
Element
.)
|
|
GetParameter |
Retrieves a parameter from the element given identifier.
(Inherited from
Element
.)
|
|
GetParameterFormatOptions |
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from
Element
.)
|
|
GetParameters |
Retrieves the parameters from the element via the given name.
(Inherited from
Element
.)
|
|
GetPhaseStatus |
Gets the status of a given element in the input phase
(Inherited from
Element
.)
|
|
GetSubelements |
Returns the collection of element subelements.
(Inherited from
Element
.)
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
GetTypeId |
Returns the identifier of this element's type.
(Inherited from
Element
.)
|
|
GetValidTypes |
Obtains a set of types that are valid for this element.
(Inherited from
Element
.)
|
|
GetWaypoints |
return the waypoints set for the Path of Travel
|
|
HasPhases |
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from
Element
.)
|
|
InsertWaypoint |
Insert a waypoint at the specified index
|
|
IsCreatedPhaseOrderValid |
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from
Element
.)
|
|
IsDemolishedPhaseOrderValid |
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from
Element
.)
|
|
IsExternalFileReference |
Determines whether this Element represents an external
file.
(Inherited from
Element
.)
|
|
IsHidden |
Identifies if the element has been permanently hidden in the view.
(Inherited from
Element
.)
|
|
IsInRevealObstaclesMode |
Returns current state of Reveal Obstacles mode for the given view.
|
|
IsMonitoringLinkElement |
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from
Element
.)
|
|
IsMonitoringLocalElement |
Indicate whether an element is monitoring other local elements.
(Inherited from
Element
.)
|
|
IsPhaseCreatedValid |
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from
Element
.)
|
|
IsPhaseDemolishedValid |
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from
Element
.)
|
|
IsValidType(ElementId) |
Checks if given type is valid for this element.
(Inherited from
Element
.)
|
|
LookupParameter |
Attempts to find a parameter on the element which has the given name.
(Inherited from
Element
.)
|
|
RefersToExternalResourceReference |
Determines whether this Element uses external resources associated with
a specified external resource type.
(Inherited from
Element
.)
|
|
RefersToExternalResourceReferences |
Determines whether this Element uses external resources.
(Inherited from
Element
.)
|
|
RemoveWaypoint |
Remove a waypoint.
|
|
SetEntity |
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten.
(Inherited from
Element
.)
|
|
SetRevealObstaclesMode |
Sets Reveal Obstacles mode for the given view.
|
|
SetWaypoint |
Updates the specified waypoint.
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
|
Update |
Updates the path of travel by recalculating the path between the original start and end points.
|
|
UpdateMultiple(Document, IList ElementId ) |
Updates the specified paths of travel by recalculating each path using their original start and end points.
|
|
UpdateMultiple(Document, IList ElementId , IList PathOfTravelCalculationStatus ) |
Updates the specified paths of travel by recalculating each path using their original start and end points and provides creation result statuses.
|
Properties
Name | Description | |
---|---|---|
AssemblyInstanceId |
The id of the assembly instance to which the element belongs.
(Inherited from
Element
.)
|
|
BoundingBox |
Retrieves a box that circumscribes all geometry of the element.
(Inherited from
Element
.)
|
|
Category |
Retrieves a Category object that represents the category or sub category in which the
element resides.
(Inherited from
Element
.)
|
|
CreatedPhaseId |
Id of a Phase at which the Element was created.
(Inherited from
Element
.)
|
|
DemolishedPhaseId |
Id of a Phase at which the Element was demolished.
(Inherited from
Element
.)
|
|
DesignOption |
Returns the design option to which the element belongs.
(Inherited from
Element
.)
|
|
Document |
Returns the Document in which the Element resides.
(Inherited from
Element
.)
|
|
Geometry |
Retrieves the geometric representation of the element.
(Inherited from
Element
.)
|
|
GroupId |
The id of the group to which an element belongs.
(Inherited from
Element
.)
|
|
Id |
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from
Element
.)
|
|
IsModifiable |
Identifies if the element is modifiable.
(Inherited from
Element
.)
|
|
IsTransient |
Indicates whether an element is transient or permanent.
(Inherited from
Element
.)
|
|
IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from
Element
.)
|
|
LevelId |
The id of the level associated with the element.
(Inherited from
Element
.)
|
|
LineStyle |
The line style of the path.
|
|
Location |
This property is used to find the physical location of an element within a project.
(Inherited from
Element
.)
|
|
Name |
A human readable name for the Element.
(Inherited from
Element
.)
|
|
OwnerViewId |
The id of the view that owns the element.
(Inherited from
Element
.)
|
|
Parameter Guid |
Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from
Element
.)
|
|
Parameter BuiltInParameter |
Retrieves a parameter from the element given a parameter id.
(Inherited from
Element
.)
|
|
Parameter Definition |
Retrieves a parameter from the element based on its definition.
(Inherited from
Element
.)
|
|
Parameters |
Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from
Element
.)
|
|
ParametersMap |
Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from
Element
.)
|
|
PathEnd |
The end point of the path. The Z coordinate will equal the view's level elevation.
To update path calculations, call update.
|
|
PathMidpoint |
The midpoint of the path. The Z coordinate will equal the view's level elevation.
|
|
PathStart |
The start point of the path. The Z coordinate will equal the view's level elevation.
To update path calculations, call update.
|
|
Pinned |
Identifies if the element has been pinned to prevent changes.
(Inherited from
Element
.)
|
|
UniqueId |
A stable unique identifier for an element within the document.
(Inherited from
Element
.)
|
|
VersionGuid |
Get the element version Guid.
(Inherited from
Element
.)
|
|
ViewSpecific |
Identifies if the element is owned by a view.
(Inherited from
Element
.)
|
|
WorksetId |
Get Id of the Workset which owns the element.
(Inherited from
Element
.)
|