TopographySurface
Description:
Represents a TopographySurface element.
Represents a TopographySurface element.
Remarks:
TopographySurface and related classes have been replaced as of Revit 2024 with Toposolid and related classes. It is recommended that all newly created elements and modifications operate from the new Toposolid class. The TopographySurface element remains in the API for backwards compatibility and upgrade. A TopographySurface element in the Revit API represents:
TopographySurface and related classes have been replaced as of Revit 2024 with Toposolid and related classes. It is recommended that all newly created elements and modifications operate from the new Toposolid class. The TopographySurface element remains in the API for backwards compatibility and upgrade. A TopographySurface element in the Revit API represents:
- An actual topography surface which can have an arbitrary boundary and collection of points.
- A SiteSubRegion element bounded by a sketch.
- A topography surface created automatically by the introduction of a BuildingPad element.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Architecture.TopographySurface
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Architecture.TopographySurface
public class TopographySurface : Element
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AddPoints(IList<XYZ>) | None | Obsolete. Adds points to a topography surface. | |
| ArePhasesModifiable() | Boolean | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) | Element |
| ArePointsDistinct(IList<XYZ>) | Boolean | Identify whether the input points are distinct in XY location. | |
| AsSiteSubRegion() | SiteSubRegion | Obtains the subregion object represented by this element. | |
| CanBeHidden(View) | Boolean | Indicates if the element can be hidden in the view. (Inherited from Element ) | Element |
| CanBeLocked() | Boolean | Identifies if the element can be locked. (Inherited from Element ) | Element |
| CanDeleteSubelement(Subelement) | Boolean | Checks if given subelement can be removed from the element. (Inherited from Element ) | Element |
| CanHaveTypeAssigned() | Boolean | Identifies if the element can have a type assigned. (Inherited from Element ) | Element |
| ChangePointElevation(XYZ, Double) | None | Obsolete. Changes the elevation value for a point. | |
| ChangePointsElevation(IList<XYZ>, Double) | None | Obsolete. Changes the elevation value for points | |
| ChangeTypeId(ElementId) | ElementId | Changes the type of the element. (Inherited from Element ) | Element |
| ContainsPoint(XYZ) | Boolean | Identifies whether the given point exists in the topography surface. | |
| Create(Document, IList<XYZ>) | TopographySurface | Obsolete. Creates a new topography surface element and adds it to the document. | |
| Create(Document, IList<XYZ>, IList<PolymeshFacet>) | TopographySurface | Obsolete. Creates a new topography surface element from facets and adds it to the document. | |
| DeleteEntity(Schema) | Boolean | Deletes the existing entity created by %schema% in the element (Inherited from Element ) | Element |
| DeletePoints(IList<XYZ>) | None | Obsolete. Deletes points from a Topography surface. | |
| DeleteSubelement(Subelement) | Boolean | Removes a subelement from the element. (Inherited from Element ) | Element |
| DeleteSubelements(IList<Subelement>) | Boolean | Removes the subelements from the element. (Inherited from Element ) | Element |
| Dispose() | None | (Inherited from Element ) | Element |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| EvaluateAllParameterValues() | IList<EvaluatedParameter> | Evaluates all the parameters' values of the element. (Inherited from Element ) | Element |
| EvaluateParameterValues(ISet<ElementId>) | IList<EvaluatedParameter> | Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) | Element |
| FindPoints(Outline) | IList<XYZ> | Filters and returns only the points of the topography surface which lie within the input bounding box. | |
| GetBoundaryPoints() | IList<XYZ> | Gets the points which are on the boundary of the topography surface. | |
| GetDependentElements(ElementFilter) | IList<ElementId> | Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) | Element |
| GetEntity(Schema) | Entity | Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise. (Inherited from Element ) | Element |
| GetEntitySchemaGuids() | IList<Guid> | Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) | Element |
| GetExternalFileReference() | ExternalFileReference | Gets information pertaining to the external file referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReference(ExternalResourceType) | ExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferenceExpanded(ExternalResourceType) | IList<ExternalResourceReference> | Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferences() | IDictionary<ExternalResourceType,ExternalResourceReference> | Gets the map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReferencesExpanded() | IDictionary | Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetGeneratingElementIds(GeometryObject) | ICollection<ElementId> | Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) | Element |
| GetGeometryObjectFromReference(Reference) | GeometryObject | Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) | Element |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetHostedSubRegionIds() | IList<ElementId> | Gets the ids of all subregion elements hosted on this topography surface. | |
| GetInteriorPoints() | IList<XYZ> | Gets all of the points that are not boundary points for the topography surface. | |
| GetMaterialArea(ElementId, Boolean) | Double | Gets the area of the material with the given id. (Inherited from Element ) | Element |
| GetMaterialIds(Boolean) | ICollection<ElementId> | Gets the element ids of all materials present in the element. (Inherited from Element ) | Element |
| GetMaterialVolume(ElementId) | Double | Gets the volume of the material with the given id. (Inherited from Element ) | Element |
| GetMonitoredLinkElementIds() | IList<ElementId> | Provides the link instance IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetMonitoredLocalElementIds() | IList<ElementId> | Provides the local element IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetOrderedParameters() | IList<Parameter> | Gets the parameters associated to the element in order. (Inherited from Element ) | Element |
| GetParameter(ForgeTypeId) | Parameter | Retrieves a parameter from the element given identifier. (Inherited from Element ) | Element |
| GetParameterFormatOptions(ElementId) | FormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) | Element |
| GetParameters(String) | IList<Parameter> | Retrieves the parameters from the element via the given name. (Inherited from Element ) | Element |
| GetPhaseStatus(ElementId) | ElementOnPhaseStatus | Gets the status of a given element in the input phase (Inherited from Element ) | Element |
| GetPoints() | IList<XYZ> | Gets the points that define this topography surface. | |
| GetSubelements() | IList<Subelement> | Returns the collection of element subelements. (Inherited from Element ) | Element |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| GetTypeId() | ElementId | Returns the identifier of this element's type. (Inherited from Element ) | Element |
| GetValidTypes() | ICollection<ElementId> | Obtains a set of types that are valid for this element. (Inherited from Element ) | Element |
| HasPhases() | Boolean | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) | Element |
| IsBoundaryPoint(XYZ) | Boolean | Identifies whether the given point is an existing boundary point of the current topography surface. | |
| IsCreatedPhaseOrderValid(ElementId) | Boolean | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsDemolishedPhaseOrderValid(ElementId) | Boolean | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsExternalFileReference() | Boolean | Determines whether this Element represents an external file. (Inherited from Element ) | Element |
| IsHidden(View) | Boolean | Identifies if the element has been permanently hidden in the view. (Inherited from Element ) | Element |
| IsMonitoringLinkElement() | Boolean | Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) | Element |
| IsMonitoringLocalElement() | Boolean | Indicate whether an element is monitoring other local elements. (Inherited from Element ) | Element |
| IsPhaseCreatedValid(ElementId) | Boolean | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) | Element |
| IsPhaseDemolishedValid(ElementId) | Boolean | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) | Element |
| IsValidFaceSet(IList<PolymeshFacet>, IList<XYZ>) | Boolean | Identifies whether the facets can construct a valid topography surface. | |
| IsValidRegion(IList<XYZ>) | Boolean | Identify whether the points can construct a valid region for a topography surface. | |
| IsValidType(ElementId) | Boolean | Checks if given type is valid for this element. (Inherited from Element ) | Element |
| LookupParameter(String) | Parameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element ) | Element |
| MovePoint(XYZ, XYZ) | None | Obsolete. Moves a point in a TopographySurface to a new designated location. | |
| MovePoints(IList<XYZ>, XYZ) | None | Obsolete. Moves a collection of points in a topography surface by a designated vector. | |
| RefersToExternalResourceReference(ExternalResourceType) | Boolean | Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) | Element |
| RefersToExternalResourceReferences() | Boolean | Determines whether this Element uses external resources. (Inherited from Element ) | Element |
| SetEntity(Entity) | None | Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element ) | Element |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| ArePointsEditable | bool | Identifies whether the points of this topography surface can be edited independently. Topography surfaces created from external data will not allow editing of individual points. | |
| AssemblyInstanceId | ElementId | The id of the assembly instance to which the element belongs. (Inherited from Element ) | Element |
| AssociatedBuildingPadId | ElementId | The element id of the building pad which causes this topography surface to be formed. | |
| BoundingBox | BoundingBoxXYZ | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) | Element |
| Category | Category | Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) | Element |
| CreatedPhaseId | ElementId | Id of a Phase at which the Element was created. (Inherited from Element ) | Element |
| DemolishedPhaseId | ElementId | Id of a Phase at which the Element was demolished. (Inherited from Element ) | Element |
| DesignOption | DesignOption | Returns the design option to which the element belongs. (Inherited from Element ) | Element |
| Document | Document | Returns the Document in which the Element resides. (Inherited from Element ) | Element |
| Geometry | GeometryElement | Retrieves the geometric representation of the element. (Inherited from Element ) | Element |
| GroupId | ElementId | The id of the group to which an element belongs. (Inherited from Element ) | Element |
| Id | ElementId | A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) | Element |
| IsAssociatedWithBuildingPad | bool | Identifies if this element represents a topography surface associated with a building pad. | |
| IsModifiable | bool | Identifies if the element is modifiable. (Inherited from Element ) | Element |
| IsSiteSubRegion | bool | Identifies if this element represents a subregion. | |
| IsTransient | bool | Indicates whether an element is transient or permanent. (Inherited from Element ) | Element |
| IsValidObject | Boolean | Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) | Element |
| LevelId | ElementId | The id of the level associated with the element. (Inherited from Element ) | Element |
| Location | Location | This property is used to find the physical location of an element within a project. (Inherited from Element ) | Element |
| MaterialId | ElementId | The id of the material applied to this element. | |
| Name | string | A human readable name for the Element. (Inherited from Element ) | Element |
| OwnerViewId | ElementId | The id of the view that owns the element. (Inherited from Element ) | Element |
| Parameter[BuiltInParameter] | Parameter | Retrieves a parameter from the element given a parameter id. (Inherited from Element ) | Element |
| Parameter[Definition] | Parameter | Retrieves a parameter from the element based on its definition. (Inherited from Element ) | Element |
| Parameter[Guid] | Parameter | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) | Element |
| Parameters | ParameterSet | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| ParametersMap | ParameterMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| Pinned | bool | Identifies if the element has been pinned to prevent changes. (Inherited from Element ) | Element |
| UniqueId | string | A stable unique identifier for an element within the document. (Inherited from Element ) | Element |
| VersionGuid | Guid | Get the element version Guid. (Inherited from Element ) | Element |
| ViewSpecific | bool | Identifies if the element is owned by a view. (Inherited from Element ) | Element |
| WorksetId | WorksetId | Get Id of the Workset which owns the element. (Inherited from Element ) | Element |