Skip to content
RevitAPI doc lite

RouteAnalysisSettings

Public Class

RouteAnalysisSettings is an element which contains project-wide settings for route calculations. The PathOfTravel element uses these settings to calculate a route between two points in a plan view.

By default, the route will go around the geometry of all visible model elements which have model geometry in the Route Analysis Zone.

The Route Analysis Zone, determined per view, is the space between these two horizontal planes: a top plane vertically offset by AnalysisZoneTopOffset above the view’s level and a bottom plane vertically offset by AnalysisZoneBottomOffset ft above the view’s level.

By default, the route will ignore the following elements:

  • elements outside of the crop region of the view;
  • elements without any model geometry (annotations or view-specific elements);
  • model lines (category OST_Lines);
  • demolished elements;
  • elements displayed in the underlay of the view.

There are a few ways to customize Route Analysis on a project-wide basis.

You can adjust the Route Analysis Zone using AnalysisZoneTopOffset and AnalysisZoneBottomOffset.

You can specify a set of model categories you would like ignored during route calculation. To enable ignoring the set of specified categories, set

EnableIgnoredCategoryIds

to true. To change the set of ignored categories, use SetIgnoredCategoryIds method and

IgnoreImports

and IgnorePointClouds properties. To query the set of ignored categories, use

GetIgnoredCategoryIds

.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Analysis.RouteAnalysisSettings

Namespace: Autodesk.Revit.DB.Analysis

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class RouteAnalysisSettings : Element

The RouteAnalysisSettings type exposes the following members.

Properties

Name

Description

Public Property
AnalysisZoneBottomOffset

The bottom plane offset, in ft, of the zone used in route calculation. Default value is 8”.

Public Property
AnalysisZoneTopOffset

The top plane offset, in ft, for the zone used in route calculation. Default value is 6’8”.

Public Property

AssemblyInstanceId

The id of the assembly instance to which the element belongs.
(Inherited from Element)

Public Property
Code Example
BoundingBox

Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element)

Public Property
Category

Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element)

Public Property
Code Example
CreatedPhaseId

Id of a Phase at which the Element was created.
(Inherited from Element)

Public Property
Code Example
DemolishedPhaseId

Id of a Phase at which the Element was demolished.
(Inherited from Element)

Public Property
Code Example
DesignOption

Returns the design option to which the element belongs.
(Inherited from Element)

Public Property
Document

Returns the Document in which the Element resides.
(Inherited from Element)

Public Property

EnableIgnoredCategoryIds

When this setting is true, elements with category ids returned by

GetIgnoredCategoryIds

will be ignored in route calculation. default is true as all elements with the Door Category Id are ignored by default.

Public Property
Code Example
Geometry

Retrieves the geometric representation of the element.
(Inherited from Element)

Public Property

GroupId

The id of the group to which an element belongs.
(Inherited from Element)

Public Property
Code Example
Id

A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element)

Public Property

IgnoreImports

If true, import instances are ignored by route calculation. For imports to be ignored, also

EnableIgnoredCategoryIds

must be set to true.

Public Property
IsModifiable

Identifies if the element is modifiable.
(Inherited from Element)

Public Property
IsTransient

Indicates whether an element is transient or permanent.
(Inherited from Element)

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element)

Public Property

LevelId

The id of the level associated with the element.
(Inherited from Element)

Public Property
Code Example
Location

This property is used to find the physical location of an element within a project.
(Inherited from Element)

Public Property

MinimumLength

The constant storing minimum allowed length of path of travel

Public Property
Name

A human readable name for the Element.
(Inherited from Element)

Public Property

OwnerViewId

The id of the view that owns the element.
(Inherited from Element)

Public Property
Code Example
Parameter.BuiltInParameter.

Retrieves a parameter from the element given a parameter id.
(Inherited from Element)

Public Property
Parameter.Definition.

Retrieves a parameter from the element based on its definition.
(Inherited from Element)

Public Property
Parameter.Guid.

Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element)

Public Property
Code Example
Parameters

Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from Element)

Public Property
ParametersMap

Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from Element)

Public Property
Pinned

Identifies if the element has been pinned to prevent changes.
(Inherited from Element)

Public Property
Code Example
UniqueId

A stable unique identifier for an element within the document.
(Inherited from Element)

Public Property
VersionGuid

Get the element version Guid.
(Inherited from Element)

Public Property

ViewSpecific

Identifies if the element is owned by a view.
(Inherited from Element)

Public Property
WorksetId

Get Id of the Workset which owns the element.
(Inherited from Element)

Methods

Name

Description

Public Method
ArePhasesModifiable

Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element)

Public Method
CanBeHidden

Indicates if the element can be hidden in the view.
(Inherited from Element)

Public Method

CanBeLocked

Identifies if the element can be locked.
(Inherited from Element)

Public Method

CanDeleteSubelement

Checks if given subelement can be removed from the element.
(Inherited from Element)

Public Method
CanHaveTypeAssigned.

Identifies if the element can have a type assigned.
(Inherited from Element)

Public Method
ChangeTypeId(ElementId)

Changes the type of the element.
(Inherited from Element)

Public Method

DeleteEntity

Deletes the existing entity created by %schema% in the element
(Inherited from Element)

Public Method
DeleteSubelement

Removes a subelement from the element.
(Inherited from Element)

Public Method
DeleteSubelements

Removes the subelements from the element.
(Inherited from Element)

Public Method

Dispose

(Inherited from Element)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

EvaluateAllParameterValues

Evaluates all the parameters’ values of the element.
(Inherited from Element)

Public Method

EvaluateParameterValues

Evaluate the parameters’ values of the element on the given parameter ID set.
(Inherited from Element)

Public Method
GetDependentElements

Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element)

Public Method
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)

Public Method

GetEntitySchemaGuids

Returns the Schema guids of any Entities stored in this element.
(Inherited from Element)

Public Method

GetExcludedCategoryIds

Returns ElementIds for Category elements which are excluded (not taken into account) by route calculation. These categories are always excluded, regardless of the

EnableIgnoredCategoryIds

value. If an excluded category has sub-categories, then the sub-categories will be excluded as well.

Public Method

GetExternalFileReference

Gets information pertaining to the external file referenced by the element.
(Inherited from Element)

Public Method
GetExternalResourceReference

Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)

Public Method
GetExternalResourceReferenceExpanded

Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)

Public Method
GetExternalResourceReferences

Gets the map of the external resource references referenced by the element.
(Inherited from Element)

Public Method
GetExternalResourceReferencesExpanded

Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element)

Public Method
Code Example
GetGeneratingElementIds

Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element)

Public Method
GetGeometryObjectFromReference

Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetIgnoredCategoryIds

Returns ElementIds for Category elements which are ignored (not taken into account) route calculation. To enable ignoring of these categories,

EnableIgnoredCategoryIds

must be set to true. If an ignored category has sub-categories, then the sub-categories will be ignored as well.

Public Method

GetMaterialArea

Gets the area of the material with the given id.
(Inherited from Element)

Public Method
GetMaterialIds

Gets the element ids of all materials present in the element.
(Inherited from Element)

Public Method

GetMaterialVolume

Gets the volume of the material with the given id.
(Inherited from Element)

Public Method

GetMonitoredLinkElementIds

Provides the link instance IDs when the element is monitoring.
(Inherited from Element)

Public Method

GetMonitoredLocalElementIds

Provides the local element IDs when the element is monitoring.
(Inherited from Element)

Public Method
GetOrderedParameters

Gets the parameters associated to the element in order.
(Inherited from Element)

Public Method
GetParameter

Retrieves a parameter from the element given identifier.
(Inherited from Element)

Public Method

GetParameterFormatOptions

Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element)

Public Method
GetParameters

Retrieves the parameters from the element via the given name.
(Inherited from Element)

Public Method

GetPhaseStatus

Gets the status of a given element in the input phase
(Inherited from Element)

Public Method
Static Member
GetRouteAnalysisSettings

Returns the RouteAnalysisSettings element for a given document.

Public Method
GetSubelements

Returns the collection of element subelements.
(Inherited from Element)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method
Code Example
GetTypeId

Returns the identifier of this element’s type.
(Inherited from Element)

Public Method

GetValidTypes.

Obtains a set of types that are valid for this element.
(Inherited from Element)

Public Method
HasPhases

Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element)

Public Method

IsCreatedPhaseOrderValid

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)

Public Method

IsDemolishedPhaseOrderValid

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)

Public Method
IsExternalFileReference

Determines whether this Element represents an external file.
(Inherited from Element)

Public Method
IsHidden

Identifies if the element has been permanently hidden in the view.
(Inherited from Element)

Public Method
IsLargeGeometryAllowed

Returns if large geometry is allowed for path of travel creation or not.

Public Method

IsMonitoringLinkElement

Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element)

Public Method

IsMonitoringLocalElement

Indicate whether an element is monitoring other local elements.
(Inherited from Element)

Public Method
IsPhaseCreatedValid

Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element)

Public Method
IsPhaseDemolishedValid

Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element)

Public Method
IsValidType(ElementId)

Checks if given type is valid for this element.
(Inherited from Element)

Public Method
LookupParameter

Attempts to find a parameter on the element which has the given name.
(Inherited from Element)

Public Method

RefersToExternalResourceReference

Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element)

Public Method
RefersToExternalResourceReferences

Determines whether this Element uses external resources.
(Inherited from Element)

Public Method

SetEntity

Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element)

Public Method

SetIgnoredCategoryIds

Sets the ElementIds for Category elements which are ignored by route calculation.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)