The DirectShape type exposes the following members.
Methods
Name | Description | |
---|---|---|
AppendShape(IList GeometryObject ) |
Appends the collection of Geometry objects into the model shape representation stored in this DirectShape.
|
|
AppendShape(ShapeBuilder) |
Append shape built by the supplied ShapeBuilderObject to shape representation stored in this DirectShape.
The data stored in the supplied ShapeBuilder object will be cleared.
|
|
AppendShape(IList GeometryObject , DirectShapeTargetViewType) |
Appends the collection of Geometry objects 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.
|
|
AreOptionsValid |
Validates that the given DirectShapeOptions are allowed for this particular DirectShape.
|
|
ArePhasesModifiable |
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from
Element
.)
|
|
CanBeHidden |
Indicates if the element can be hidden in the view.
(Inherited from
Element
.)
|
|
CanBeLocked |
Identifies if the element can be locked.
(Inherited from
Element
.)
|
|
CanHaveAnalyticalModel |
Indicates whether the Element can have an Analytical Model.
(Inherited from
Element
.)
|
|
CanHaveTypeAssigned |
Identifies if the element can have a type assigned.
(Inherited from
Element
.)
|
|
ChangeTypeId(ElementId) |
Changes the type of the element.
(Inherited from
Element
.)
|
|
CreateElement |
Create a DirectShape object and add it to document.
|
|
CreateElementInstance |
Create a DirectShape object and add it to document.
The shape stored in the element is either a reference or a copy of a definition shape
that was created earlier. How the definitions are stored will determine whether an instance or a copy of the
shape will be created. See DirectShapeLibrary for more details.
This function is included for convenience. It essentially combines CreateGeometryInstance and CreateElement.
|
|
CreateGeometryInstance |
Create a copy of a definition shape that was created earlier.
Use DirectShapeLibrary class to store definitions prior to using them here.
How the definitions are stored will determine whether an instance or a copy of the
shape will be created. See DirectShapeLibrary for more details.
Use the output of this function as input to CreateElement to make the created shape persistent.
|
|
DeleteEntity |
Deletes the existing entity created by %schema% in the element
(Inherited from
Element
.)
|
|
Dispose | (Inherited from Element .) | |
Equals | (Inherited from Object .) | |
GetAnalyticalModel |
Retrieves writeable Analytical Model for Element.
(Inherited from
Element
.)
|
|
GetAnalyticalModelId |
Retrieves the Element Id of the Analytical Model Element for this Element.
(Inherited from
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
.)
|
|
GetEntitySchemaGuids |
Returns the Schema guids of any Entities stored in this element.
(Inherited from
Element
.)
|
|
GetExternalFileReference |
Gets information pertaining to the external file referenced
by the element.
(Inherited from
Element
.)
|
|
GetExternalResourceReference |
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from
Element
.)
|
|
GetExternalResourceReferences |
Gets the full map of the external resource references referenced
by the element.
(Inherited from
Element
.)
|
|
GetGeneratingElementIds |
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from
Element
.)
|
|
GetGeometryObjectFromReference |
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from
Element
.)
|
|
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from
Object
.)
|
|
GetMaterialArea |
Gets the area of the material with the given id.
(Inherited from
Element
.)
|
|
GetMaterialIds |
Gets the element ids of all materials present in the element.
(Inherited from
Element
.)
|
|
GetMaterialVolume |
Gets the volume of the material with the given id.
(Inherited from
Element
.)
|
|
GetMonitoredLinkElementIds |
Provides the link instance IDs when the element is monitoring.
(Inherited from
Element
.)
|
|
GetMonitoredLocalElementIds |
Provides the local element IDs when the element is monitoring.
(Inherited from
Element
.)
|
|
GetOptions |
Gets a copy of the current options for this DirectShape.
|
|
GetOrderedParameters |
Gets the parameters associated to the element in order.
(Inherited from
Element
.)
|
|
GetParameterFormatOptions |
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from
Element
.)
|
|
GetParameters |
Retrieves the parameters from the element via the given name.
(Inherited from
Element
.)
|
|
GetPhaseStatus |
Gets the status of a given element in the input phase
(Inherited from
Element
.)
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
GetTypeId |
Returns the identifier of this element's type.
(Inherited from
Element
.)
|
|
GetValidTypes |
Obtains a set of types that are valid for this element.
(Inherited from
Element
.)
|
|
HasPhases |
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from
Element
.)
|
|
IsExternalFileReference |
Determines whether this Element represents an external
file.
(Inherited from
Element
.)
|
|
IsHidden |
Identifies if the element has been permanently hidden in the view.
(Inherited from
Element
.)
|
|
IsMonitoringLinkElement |
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from
Element
.)
|
|
IsMonitoringLocalElement |
Indicate whether an element is monitoring other local elements.
(Inherited from
Element
.)
|
|
IsPhaseCreatedValid |
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from
Element
.)
|
|
IsPhaseDemolishedValid |
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from
Element
.)
|
|
IsValidCategoryId |
Test the category id to make sure it is indeed a top-level built-in category
|
|
IsValidGeometry |
Validate 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.
|
|
IsValidType(ElementId) |
Checks if given type is valid for this element.
(Inherited from
Element
.)
|
|
IsValidTypeId |
Test 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.
|
|
LookupParameter |
Attempts to find a parameter on the element which has the given name.
(Inherited from
Element
.)
|
|
RefersToExternalResourceReference |
Determines whether this Element uses external resources associated with
a specified external resource type.
(Inherited from
Element
.)
|
|
RefersToExternalResourceReferences |
Determines whether this Element uses external resources.
(Inherited from
Element
.)
|
|
SetEntity |
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten.
(Inherited from
Element
.)
|
|
SetGUIDs |
Sets the GUID of the application that has created this DirectShape element and
the GUID of the native data that was the source of this DirectShape.
|
|
SetName |
Sets the name for the DirectShape element.
|
|
SetOptions |
Sets the options to use for this DirectShape.
|
|
SetShape(IList GeometryObject ) |
Builds the shape of this object from the supplied collection of Geometry objects. The objects are copied.
If the new shape is identical to the old one, the old shape will be kept.
|
|
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.
|
|
SetShape(IList GeometryObject , DirectShapeTargetViewType) |
Builds the shape of this object from the supplied collection of Geometry objects. The objects are copied.
If the new shape is identical to the old one, the old shape will be kept.
|
|
SetTypeId |
Sets the DirectShapeType for the DirectShape element
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
Properties
Name | Description | |
---|---|---|
AssemblyInstanceId |
The id of the assembly instance to which the element belongs.
(Inherited from
Element
.)
|
|
BoundingBox |
Retrieves a box that circumscribes all geometry of the element.
(Inherited from
Element
.)
|
|
Category |
Retrieves a Category object that represents the category or sub category in which the
element resides.
(Inherited from
Element
.)
|
|
CreatedPhaseId |
Id of a Phase at which the Element was created.
(Inherited from
Element
.)
|
|
DemolishedPhaseId |
Id of a Phase at which the Element was demolished.
(Inherited from
Element
.)
|
|
DesignOption |
Returns the design option to which the element belongs.
(Inherited from
Element
.)
|
|
Document |
Returns the Document in which the Element resides.
(Inherited from
Element
.)
|
|
Geometry |
Retrieves the geometric representation of the element.
(Inherited from
Element
.)
|
|
GroupId |
The id of the group to which an element belongs.
(Inherited from
Element
.)
|
|
Id |
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from
Element
.)
|
|
IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from
Element
.)
|
|
LevelId |
The id of the level associated with the element.
(Inherited from
Element
.)
|
|
Location |
This property is used to find the physical location of an element within a project.
(Inherited from
Element
.)
|
|
Name |
A human readable name for the Element.
(Inherited from
Element
.)
|
|
OwnerViewId |
The id of the view that owns the element.
(Inherited from
Element
.)
|
|
Parameter Guid |
Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from
Element
.)
|
|
Parameter BuiltInParameter |
Retrieves a parameter from the element given a parameter id.
(Inherited from
Element
.)
|
|
Parameter Definition |
Retrieves a parameter from the element based on its definition.
(Inherited from
Element
.)
|
|
Parameters |
Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from
Element
.)
|
|
ParametersMap |
Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from
Element
.)
|
|
Pinned |
Identifies if the element has been pinned to prevent changes.
(Inherited from
Element
.)
|
|
TypeId |
Element id of a DirectShapeType object that holds properties to be shared by this element. Optional.
|
|
UniqueId |
A stable unique identifier for an element within the document.
(Inherited from
Element
.)
|
|
ViewSpecific |
Identifies if the element is owned by a view.
(Inherited from
Element
.)
|
|
WorksetId |
Get Id of the Workset which owns the element.
(Inherited from
Element
.)
|