Surface Class |
The Surface type exposes the following members.
Name | Description | |
---|---|---|
![]() | Analysis | Gets a SurfaceAnalysis object that exposes the surface analysis properties for the Surface. |
![]() | Application |
Gets the Application. Not currently implemented.
(Inherited from Entity) |
![]() | AutoRebuild | Gets or sets whether to rebuild the surface when surface definition is changed. |
![]() | BoundariesDefinition | Gets the collection of boundaries associated with the Surface. |
![]() | BuildOptions | Gets an object that encapsulates options applied to building or re-building a Surface. |
![]() | Description |
Gets or sets the Entity object's description.
(Inherited from Entity) |
![]() | DisplayName |
Gets the Entity object's display name.
(Inherited from Entity) |
![]() | Document |
Gets the Document. Not currently implemented.
(Inherited from Entity) |
![]() | FingerPrint |
Gets or sets FingerPrint of the Entity.
(Inherited from Entity) |
![]() | FolderId |
Gets the folder ObjectId of the Entity
Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity) |
![]() ![]() | HasSnapshot | Gets a boolean value that specifies whether the surface has a snapshot. |
![]() | IsCWSReferenceObject |
Gets whether the Entity is a Civil Worksharing reference object. A Civil Worksharing reference object is
a Civil object shared to Shared Space. It is not editable. But it can be updated to the new version in the Shared Space.
(Inherited from Entity) |
![]() | IsCWSSourceObject |
Gets whether the Entity is a Civil Worksharing source object. A Civil Worksharing source object is
a Civil object shared to Shared Space. It is editable and can be updated to Shared Space.
(Inherited from Entity) |
![]() | IsLevelOfDetailEnabled | Gets or sets whether to reduced level of Detail. |
![]() | IsOutOfDate | Gets whether this surface is out-of-date. |
![]() | IsPartialReferenceObject |
Gets whether the surface is partial reference surface.
(Inherited from Entity) |
![]() | IsReadOnlyReferenceObject |
Gets whether the Entity is a readonly reference object. A readonly reference object is
either a data shortcut referece object or a Civil Worksharing reference object.
(Inherited from Entity) |
![]() ![]() | IsReferencedSourceExisting |
For reference object (IsReferenceObject == true), it will try to get its source entity while opening a drawing.
This indicates whether the reference object has source entity.
(Inherited from Entity) |
![]() | IsReferenceObject |
Gets whether the Entity is a reference object. A reference object is
located in another drawing, and linked using a data shortcut or Vault.
If the entity is native to the current drawing this property returns false;
if it is being referenced via data shortcuts or AutoCAD Vault it returns true.
(Inherited from Entity) |
![]() | IsReferenceStale |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale.
(Inherited from Entity) |
![]() | IsReferenceSubObject |
For reference objects (IsReferenceObject == true), gets whether the Entity is a reference subobject.
For example, when iterating through the structure of a pipe network referenced from another drawing,
this property is true for each entity.
(Inherited from Entity) |
![]() | IsReferenceValid |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid.
(Inherited from Entity) |
![]() | IsSnapshotOutOfDate | Gets whether the snapshot in the surface is out-of-date. |
![]() | IsUsed |
Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity) |
![]() | IsVolumeSurface | Gets whether the surface is a volume surface. |
![]() | Lock | Gets or sets whether the Civil 3D GUI shows this surface as locked. |
![]() | Masks | Gets all the masks in the Surface. |
![]() | Name |
Gets or sets the Entity object's name.
(Inherited from Entity) |
![]() | Operations | Gets the operation list for the Surface. |
![]() | OriginationType | Gets origination type which indicates the surface is created from a Corridor or Grading. |
![]() | PartialReferenceBoundaryManager | Provides access to the manager for partial reference boundaries. |
![]() | ShowToolTip |
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity) |
![]() ![]() | StyleId |
Sets the Surface's style Id.
(Overrides EntityStyleId) |
![]() | StyleName |
Gets or sets the Entity object's style name.
(Inherited from Entity) |
Name | Description | |
---|---|---|
![]() | ComputeFingerPrint |
Compute FingerPrint of the Entity.
(Inherited from Entity) |
![]() ![]() | CreateSnapshot | Creates a snapshot that contains the current state of points and triangles resulting from previous Surface operations. A snapshot can improve the performance of Surface builds from subsequent operations. |
![]() | ExportToDEM(String, String, Double, ExportDetermineElevationType) | Exports the Surface to a DEM file. |
![]() | ExportToDEM(String, String, Double, ExportDetermineElevationType, Boolean, Single) | Exports the surface to a DEM file, with an optional custom value for null elevation. |
![]() | FindDirectionAtXY | Gets the direction of the Surface at the specified location (x, y). |
![]() | FindElevationAtXY | Gets the elevation of the Surface at the specified location (x, y). |
![]() | FindPointsAlongLine | Gets the points on the surface along the specified line segment. |
![]() | FindSlopeAtXY | Gets the slope of the Surface at the specified location (x, y). |
![]() ![]() | GetBoundedVolumes(Point3dCollection) | Calculates the volume of an area defined by several points. |
![]() ![]() | GetBoundedVolumes(Point3dCollection, Double) | Calculate the volume of an area defined by several points. |
![]() ![]() | GetGeneralProperties | Gets the general properties of the surface. |
![]() | GetIntersectionPoint | Gets the intersection point with surface by the specified point and vector. |
![]() ![]() | GetReferenceInfo |
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity) |
![]() ![]() | Rebuild | Rebuilds the surface by processing all the operations one by one in the list. |
![]() ![]() | RebuildSnapshot | Rebuilds the snapshot for the surface. |
![]() ![]() | RemoveSnapshot | Removes the existing snapshot for the surface. |