RVTDocs.com

TopographySurface

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