Skip to content
RevitAPI doc lite

DirectShape

Public Class

This class is used to store externally created geometric shapes. Primary intended use is for importing shapes from other data formats such as IFC or STEP. A DirectShape object may be assigned a category. That will affect how that object is displayed in Revit.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.DirectShape

Namespace: Autodesk.Revit.DB

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

Syntax

public class DirectShape : Element

The DirectShape type exposes the following members.

Properties

Name

Description

Public Property
ApplicationDataId

A text string that identifies the data to the creating application.

Public Property
ApplicationId

A text string that identifies the creating application.

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
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
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
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

TypeId

Element id of a DirectShapeType object that holds properties to be shared by this element. Optional.

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

AddExternallyTaggedGeometry

Adds the externally tagged geometry object to the DirectShape.

Public Method
AddReferenceCurve(Curve)

Adds a reference curve to the DirectShape.

Public Method
AddReferenceCurve(Curve, DirectShapeReferenceOptions)

Adds a reference curve to the DirectShape.

Public Method

AddReferencePlane(Plane)

Adds a reference plane to the DirectShape. The reference plane can either be bounded or unbounded.

Public Method

AddReferencePlane(Plane, BoundingBoxUV)

Adds a reference plane to the DirectShape. The reference plane can either be bounded or unbounded.

Public Method

AddReferencePlane(Plane, DirectShapeReferenceOptions)

Adds a reference plane to the DirectShape. The reference plane can either be bounded or unbounded.

Public Method

AddReferencePlane(Plane, BoundingBoxUV, DirectShapeReferenceOptions)

Adds a reference plane to the DirectShape. The reference plane can either be bounded or unbounded.

Public Method

AddReferencePoint(XYZ)

Adds a reference point to the DirectShape.

Public Method

AddReferencePoint(XYZ, DirectShapeReferenceOptions)

Adds a reference point to the DirectShape.

Public Method
AppendShape(IList.GeometryObject.)

Appends the collection of GeometryObjects into the model shape representation stored in this DirectShape.

Public Method
AppendShape(ShapeBuilder)

Appends shape built by the supplied ShapeBuilderObject to shape representation stored in this DirectShape. The data stored in the supplied ShapeBuilder object will be cleared.

Public Method
AppendShape(IList.GeometryObject., DirectShapeTargetViewType)

Appends the collection of GeometryObjects into the model or view specific shape representation stored in this DirectShape. Passing DirectShapeTargetViewType.Default as view type will cause the model shape to be updated.

Public Method

AreOptionsValid

Validates that the given DirectShapeOptions are allowed for this particular DirectShape.

Public Method

AreOptionsValidForTransientDirectShape

Validates that the given DirectShapeOptions are allowed if this DirectShape is transient.

Public Method
ArePhasesModifiable

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

Public Method

AreValidDirectShapeReferenceOptions

Validates that the input DirectShapeReferenceOptions are suitable for creating a direct shape reference object. If the options specify an ExternalGeometryId, it must not correspond to any existing reference object belonging to the DirectShape.

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
CanCreateParts

Indicates if it is possible to create parts from this DirectShape 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
Static Member

CreateElement

Creates a DirectShape object and adds it to document.

Public Method
Static Member
CreateElementInstance

Creates a DirectShape object and adds it to document.

Public Method
Static Member
CreateGeometryInstance

Creates a copy of a definition shape that was created earlier.

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

GetExternalFileReference

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

Public Method

GetExternallyTaggedGeometry

Gets the externally tagged geometry by its external ID that is stored in this DirectShape.

Public Method

GetExternallyTaggedReference

Retrieve a Reference to reference geometry of the DirectShape that is associated with a particular ExternalGeometryId.

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

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

GetOptions

Gets a copy of the current options for this DirectShape.

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
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

HasExternalGeometry

Checks whether the externally tagged geometry is already present in this DirectShape.

Public Method

HasExternallyTaggedReference

Checks if the externally tagged reference is already present in this DirectShape.

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

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
Static Member
IsSupportedDocument

Tests whether a DirectShape or a DirectShapeType may be created in this document.

Public Method
Static Member

IsValidCategoryId

Test the category id to make sure the category is allowed for a DirectShape or DirectShapeType.

Public Method

IsValidGeometry

Validates geometry to be stored in a DirectShape. Suitable geometry validation is performed. Additionally, the geometry must make sense as a shape representation for the category assigned to this DirectShape object.

Public Method
Static Member

IsValidReferenceCurve

Validates that the input curve is suitable for creating a direct shape reference curve. Bounded and unbounded lines are accepted. Other bounded and unbounded curve types with natural bounds are accepted if they are not closed. Unbounded periodic curves are not allowed.

Public Method
Static Member

IsValidReferencePlaneBoundingBoxUV

Validates that the input BoundingBoxUV is suitable for bounding a reference plane surface. The input BoundingBoxUV must be set and not degenerate.

Public Method
IsValidShape(ExternallyTaggedGeometryObject)

Validates shape to be stored in a DirectShape.

Public Method
IsValidShape(IList.GeometryObject.)

Validates shape to be stored in a DirectShape. Supercedes and extends IsValidGeometry().

Public Method

IsValidShape(IList.GeometryObject., DirectShapeTargetViewType)

Validates view-specific shape to be stored in a DirectShape. Expects a non-default view type.

Public Method
IsValidType(ElementId)

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

Public Method

IsValidTypeId

Tests the type id to make sure it satisfies the following conditions

  • It is a valid element id.
  • It corresponds to a valid DirectShapeType.
  • The DirectShapeType has the same category assigned.

Additionally, this functions tests that the current type id in this DirectShape is invalid. The type id is initialized to invalidElementId by the create functions. Once it is set, it may no longer be changed.

Public Method

IsValidUsage

Validates that the ExternallyTaggedGeometryObject’s usage is set to an allowed value for a DirectShape.

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

RemoveAllReferenceObjects

Removes all reference objects (if any) from the DirectShape.

Public Method

RemoveExternallyTaggedGeometry

Removes the externally tagged geometry object by its external ID from this DirectShape.

Public Method

RemoveReferenceObject(ExternalGeometryId)

Removes any reference object associated with the provided ExternalGeometryId from the DirectShape. Nothing is done if no reference object has the given external ID or if the external ID is an empty string.

Public Method

RemoveReferenceObject(String)

Removes any reference objects with the given name from the DirectShape. Nothing is done if no reference objects have the given name or if the name is the empty string.

Public Method

ResetExternallyTaggedGeometry

Removes all of the externally tagged geometry in this DirectShape.

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

SetName

Sets the name for the DirectShape element.

Public Method
SetOptions

Sets the options to use for this DirectShape.

Public Method

SetShape(IList.GeometryObject.)

Builds the shape of this object from the supplied collection of GeometryObjects. The objects are copied. If the new shape is identical to the old one, the old shape will be kept.

Public Method
SetShape(ShapeBuilder)

Sets the shape of this object to the one accumulated in the supplied Builder object. If the new shape is identical to the old one, the old shape will be kept.

Public Method

SetShape(IList.GeometryObject., DirectShapeTargetViewType)

Builds the shape of this object from the supplied collection of GeometryObjects. The objects are copied. If the new shape is identical to the old one, the old shape will be kept.

Public Method

SetTypeId

Sets the DirectShapeType for the DirectShape element.

Public Method

ToString

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

Public Method

UpdateExternallyTaggedGeometry

Updates the externally tagged geometry object in the DirectShape.

Remarks

DirectShape is not a replacement for “real” Wall, Roof, Window, etc. It would typically be used where there is not enough information to create, e.g., a Wall, or full functionality of a Wall object is not needed. Some category-specific functionality may be available. If you need to modify a shape held by a DirectShape object, use Revit Geometry API, and then store the modified shape back to the DirectShape object.

Example

// Create a DirectShape Sphere
public void CreateSphereDirectShape(Document doc)
{
    List<Curve> profile = new List<Curve>();


    // first create sphere with 2' radius
    XYZ center = XYZ.Zero;
    double radius = 2.0;
    XYZ profile00 = center;
    XYZ profilePlus = center + new XYZ(0, radius, 0);
    XYZ profileMinus = center - new XYZ(0, radius, 0);


    profile.Add(Line.CreateBound(profilePlus, profileMinus));
    profile.Add(Arc.Create(profileMinus, profilePlus, center + new XYZ(radius, 0, 0)));


    CurveLoop curveLoop = CurveLoop.Create(profile);
    SolidOptions options = new SolidOptions(ElementId.InvalidElementId, ElementId.InvalidElementId);


    Frame frame = new Frame(center, XYZ.BasisX, -XYZ.BasisZ, XYZ.BasisY);
    if (Frame.CanDefineRevitGeometry(frame) == true)
    {
        Solid sphere = GeometryCreationUtilities.CreateRevolvedGeometry(frame, new CurveLoop[] { curveLoop }, 0, 2 * Math.PI, options);
        using (Transaction t = new Transaction(doc, "Create sphere direct shape"))
        {
            t.Start();
            // create direct shape and assign the sphere shape
            DirectShape ds = DirectShape.CreateElement(doc, new ElementId(BuiltInCategory.OST_GenericModel));


            ds.ApplicationId = "Application id";
            ds.ApplicationDataId = "Geometry object id";
            ds.SetShape(new GeometryObject[] { sphere });
            t.Commit();
        }
    }
}