2027 Class
Changes 4
C

DirectShape

Description:
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.
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.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Element
    Autodesk.Revit.DB.DirectShape
public class DirectShape : Element
// 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();
        }
    }
}
Name Return Type Description Inherited From
M AddExternallyTaggedGeometry(ExternallyTaggedGeometryObject) None Adds the externally tagged geometry object to the DirectShape.
M AddReferenceCurve(Curve) None Adds a reference curve to the DirectShape.
M AddReferenceCurve(Curve, DirectShapeReferenceOptions) None Adds a reference curve to the DirectShape.
M AddReferencePlane(Plane) None Adds a reference plane to the DirectShape. The reference plane can either be bounded or unbounded.
M AddReferencePlane(Plane, BoundingBoxUV) None Adds a reference plane to the DirectShape. The reference plane can either be bounded or unbounded.
M AddReferencePlane(Plane, DirectShapeReferenceOptions) None Adds a reference plane to the DirectShape. The reference plane can either be bounded or unbounded.
M AddReferencePlane(Plane, BoundingBoxUV, DirectShapeReferenceOptions) None Adds a reference plane to the DirectShape. The reference plane can either be bounded or unbounded.
M AddReferencePoint(XYZ) None Adds a reference point to the DirectShape.
M AddReferencePoint(XYZ, DirectShapeReferenceOptions) None Adds a reference point to the DirectShape.
M AppendShape(IList<GeometryObject>) None Appends the collection of GeometryObjects into the model shape representation stored in this DirectShape.
M AppendShape(ShapeBuilder) None 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.
M AppendShape(IList<GeometryObject>, DirectShapeTargetViewType) None 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.
M AreOptionsValid(DirectShapeOptions) Boolean Validates that the given DirectShapeOptions are allowed for this particular DirectShape.
M AreOptionsValidForTransientDirectShape(DirectShapeOptions) Boolean Validates that the given DirectShapeOptions are allowed if this DirectShape is transient.
M ArePhasesModifiable() Boolean Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) Element
M AreValidDirectShapeReferenceOptions(DirectShapeReferenceOptions) Boolean 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.
M CanBeHidden(View) Boolean Indicates if the element can be hidden in the view. (Inherited from Element ) Element
M CanBeLocked() Boolean Identifies if the element can be locked. (Inherited from Element ) Element
M CanCreateParts() Boolean Indicates if it is possible to create parts from this DirectShape element.
M CanDeleteSubelement(Subelement) Boolean Checks if given subelement can be removed from the element. (Inherited from Element ) Element
M CanHaveTypeAssigned() Boolean Identifies if the element can have a type assigned. (Inherited from Element ) Element
M ChangeTypeId(ElementId) ElementId Changes the type of the element. (Inherited from Element ) Element
M CreateElement(Document, ElementId) DirectShape Creates a DirectShape object and adds it to document.
M CreateElementInstance(Document, ElementId, ElementId, String, Transform) DirectShape Creates a DirectShape object and adds it to document.
M CreateGeometryInstance(Document, String, Transform) IList<GeometryObject> Creates a copy of a definition shape that was created earlier.
M DeleteEntity(Schema) Boolean Deletes the existing entity created by %schema% in the element (Inherited from Element ) Element
M DeleteSubelement(Subelement) Boolean Removes a subelement from the element. (Inherited from Element ) Element
M DeleteSubelements(IList<Subelement>) Boolean Removes the subelements from the element. (Inherited from Element ) Element
M Dispose() None (Inherited from Element ) Element
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M EvaluateAllParameterValues() IList<EvaluatedParameter> Evaluates all the parameters' values of the element. (Inherited from Element ) Element
M EvaluateParameterValues(ISet<ElementId>) IList<EvaluatedParameter> Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) Element
M GetDependentElements(ElementFilter) IList<ElementId> Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) Element
M 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
M GetEntitySchemaGuids() IList<Guid> Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) Element
M GetExternalFileReference() ExternalFileReference Gets information pertaining to the external file referenced by the element. (Inherited from Element ) Element
M GetExternallyTaggedGeometry(ExternalGeometryId) ExternallyTaggedGeometryObject Gets the externally tagged geometry by its external ID that is stored in this DirectShape.
M GetExternallyTaggedReference(ExternalGeometryId) Reference Retrieve a Reference to reference geometry of the DirectShape that is associated with a particular ExternalGeometryId.
M GetExternalResourceReference(ExternalResourceType) ExternalResourceReference Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) Element
M GetExternalResourceReferenceExpanded(ExternalResourceType) IList<ExternalResourceReference> Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) Element
M GetExternalResourceReferences() IDictionary<ExternalResourceType,ExternalResourceReference> Gets the map of the external resource references referenced by the element. (Inherited from Element ) Element
M GetExternalResourceReferencesExpanded() ExternalResourceType Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) Element
M GetGeneratingElementIds(GeometryObject) ICollection<ElementId> Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) Element
M GetGeometryObjectFromReference(Reference) GeometryObject Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) Element
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetMaterialArea(ElementId, Boolean) Double Gets the area of the material with the given id. (Inherited from Element ) Element
M GetMaterialIds(Boolean) ICollection<ElementId> Gets the element ids of all materials present in the element. (Inherited from Element ) Element
M GetMaterialVolume(ElementId) Double Gets the volume of the material with the given id. (Inherited from Element ) Element
M GetMonitoredLinkElementIds() IList<ElementId> Provides the link instance IDs when the element is monitoring. (Inherited from Element ) Element
M GetMonitoredLocalElementIds() IList<ElementId> Provides the local element IDs when the element is monitoring. (Inherited from Element ) Element
M GetOptions() DirectShapeOptions Gets a copy of the current options for this DirectShape.
M GetOrderedParameters() IList<Parameter> Gets the parameters associated to the element in order. (Inherited from Element ) Element
M GetParameter(ForgeTypeId) Parameter Retrieves a parameter from the element given identifier. (Inherited from Element ) Element
M GetParameterFormatOptions(ElementId) FormatOptions Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) Element
M GetParameters(String) IList<Parameter> Retrieves the parameters from the element via the given name. (Inherited from Element ) Element
M GetPhaseStatus(ElementId) ElementOnPhaseStatus Gets the status of a given element in the input phase (Inherited from Element ) Element
M GetSubelements() IList<Subelement> Returns the collection of element subelements. (Inherited from Element ) Element
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M GetTypeId() ElementId Returns the identifier of this element's type. (Inherited from Element ) Element
M GetValidTypes() ICollection<ElementId> Obtains a set of types that are valid for this element. (Inherited from Element ) Element
M HasExternalGeometry(ExternalGeometryId) Boolean Checks whether the externally tagged geometry is already present in this DirectShape.
M HasExternallyTaggedReference(ExternalGeometryId) Boolean Checks if the externally tagged reference is already present in this DirectShape.
M HasPhases() Boolean Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) Element
M IsCreatedPhaseOrderValid(ElementId) Boolean Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) Element
M IsDemolishedPhaseOrderValid(ElementId) Boolean Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) Element
M IsExternalFileReference() Boolean Determines whether this Element represents an external file. (Inherited from Element ) Element
M IsHidden(View) Boolean Identifies if the element has been permanently hidden in the view. (Inherited from Element ) Element
M IsMonitoringLinkElement() Boolean Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) Element
M IsMonitoringLocalElement() Boolean Indicate whether an element is monitoring other local elements. (Inherited from Element ) Element
M IsPhaseCreatedValid(ElementId) Boolean Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) Element
M IsPhaseDemolishedValid(ElementId) Boolean Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) Element
M IsSupportedDocument(Document) Boolean Tests whether a DirectShape or a DirectShapeType may be created in this document.
M IsValidCategoryId(ElementId, Document) Boolean Test the category id to make sure the category is allowed for a DirectShape or DirectShapeType.
M IsValidGeometry(Solid) Boolean 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.
M IsValidReferenceCurve(Curve) Boolean 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.
M IsValidReferencePlaneBoundingBoxUV(BoundingBoxUV) Boolean Validates that the input BoundingBoxUV is suitable for bounding a reference plane surface. The input BoundingBoxUV must be set and not degenerate.
M IsValidShape(ExternallyTaggedGeometryObject) Boolean Validates shape to be stored in a DirectShape.
M IsValidShape(IList<GeometryObject>) Boolean Validates shape to be stored in a DirectShape. Supercedes and extends IsValidGeometry().
M IsValidShape(IList<GeometryObject>, DirectShapeTargetViewType) Boolean Validates view-specific shape to be stored in a DirectShape. Expects a non-default view type.
M IsValidType(ElementId) Boolean Checks if given type is valid for this element. (Inherited from Element ) Element
M IsValidTypeId(ElementId) Boolean 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.
M IsValidUsage(ExternallyTaggedGeometryObject) Boolean Validates that the ExternallyTaggedGeometryObject's usage is set to an allowed value for a DirectShape.
M LookupParameter(String) Parameter Attempts to find a parameter on the element which has the given name. (Inherited from Element ) Element
M RefersToExternalResourceReference(ExternalResourceType) Boolean Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) Element
M RefersToExternalResourceReferences() Boolean Determines whether this Element uses external resources. (Inherited from Element ) Element
M RemoveAllReferenceObjects() None Removes all reference objects (if any) from the DirectShape.
M RemoveExternallyTaggedGeometry(ExternalGeometryId) None Removes the externally tagged geometry object by its external ID from this DirectShape.
M RemoveReferenceObject(ExternalGeometryId) None 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.
M RemoveReferenceObject(String) None 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.
M ResetExternallyTaggedGeometry() None Removes all of the externally tagged geometry in this DirectShape.
M 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
M SetName(String) None Sets the name for the DirectShape element.
M SetOptions(DirectShapeOptions) None Sets the options to use for this DirectShape.
M SetShape(IList<GeometryObject>) None 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.
M SetShape(ShapeBuilder) None 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.
M SetShape(IList<GeometryObject>, DirectShapeTargetViewType) None 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.
M SetTypeId(ElementId) None Sets the DirectShapeType for the DirectShape element.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
M UpdateExternallyTaggedGeometry(ExternallyTaggedGeometryObject) None Updates the externally tagged geometry object in the DirectShape.
Name Return Type Description Inherited From
P ApplicationDataId string A text string that identifies the data to the creating application.
P ApplicationId string A text string that identifies the creating application.
P AssemblyInstanceId ElementId The id of the assembly instance to which the element belongs. (Inherited from Element ) Element
P BoundingBox BoundingBoxXYZ Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) Element
P Category Category Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) Element
P CreatedPhaseId ElementId Id of a Phase at which the Element was created. (Inherited from Element ) Element
P DemolishedPhaseId ElementId Id of a Phase at which the Element was demolished. (Inherited from Element ) Element
P DesignOption DesignOption Returns the design option to which the element belongs. (Inherited from Element ) Element
P Document Document Returns the Document in which the Element resides. (Inherited from Element ) Element
P Geometry GeometryElement Retrieves the geometric representation of the element. (Inherited from Element ) Element
P GroupId ElementId The id of the group to which an element belongs. (Inherited from Element ) Element
P Id ElementId A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) Element
P IsModifiable bool Identifies if the element is modifiable. (Inherited from Element ) Element
P IsTransient bool Indicates whether an element is transient or permanent. (Inherited from Element ) Element
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) Element
P LevelId ElementId The id of the level associated with the element. (Inherited from Element ) Element
P Location Location This property is used to find the physical location of an element within a project. (Inherited from Element ) Element
P Name string A human readable name for the Element. (Inherited from Element ) Element
P OwnerViewId ElementId The id of the view that owns the element. (Inherited from Element ) Element
P Parameter[BuiltInParameter] Parameter Retrieves a parameter from the element given a parameter id. (Inherited from Element ) Element
P Parameter[Definition] Parameter Retrieves a parameter from the element based on its definition. (Inherited from Element ) Element
P Parameter[Guid] Parameter Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) Element
P Parameters ParameterSet Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) Element
P ParametersMap ParameterMap Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) Element
P Pinned bool Identifies if the element has been pinned to prevent changes. (Inherited from Element ) Element
P TypeId ElementId Element id of a DirectShapeType object that holds properties to be shared by this element. Optional.
P UniqueId string A stable unique identifier for an element within the document. (Inherited from Element ) Element
P VersionGuid Guid Get the element version Guid. (Inherited from Element ) Element
P ViewSpecific bool Identifies if the element is owned by a view. (Inherited from Element ) Element
P WorksetId WorksetId Get Id of the Workset which owns the element. (Inherited from Element ) Element