Namespace:
Autodesk.Revit.DB.Analysis
SpatialFieldManager
Class
Description:
Exposes all API for an external analysis application. Its primary role is creation, deletion and modification of SpatialFieldElement elements.
Exposes all API for an external analysis application. Its primary role is creation, deletion and modification of SpatialFieldElement elements.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Analysis.SpatialFieldManager
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Analysis.SpatialFieldManager
Examples
Document doc = commandData.Application.ActiveUIDocument.Document;
UIDocument uiDoc = commandData.Application.ActiveUIDocument;
SpatialFieldManager sfm = SpatialFieldManager.GetSpatialFieldManager(doc.ActiveView);
if (null == sfm)
{
sfm = SpatialFieldManager.CreateSpatialFieldManager(doc.ActiveView, 1);
}
Reference reference = uiDoc.Selection.PickObject(ObjectType.Face, "Select a face");
int idx = sfm.AddSpatialFieldPrimitive(reference);
Face face = doc.GetElement(reference).GetGeometryObjectFromReference(reference) as Face;
IList<UV> uvPts = new List<UV>();
BoundingBoxUV bb = face.GetBoundingBox();
UV min = bb.Min;
UV max = bb.Max;
uvPts.Add(new UV(min.U,min.V));
uvPts.Add(new UV(max.U,max.V));
FieldDomainPointsByUV pnts = new FieldDomainPointsByUV(uvPts);
List<double> doubleList = new List<double>();
IList<ValueAtPoint> valList = new List<ValueAtPoint>();
doubleList.Add(0);
valList.Add(new ValueAtPoint(doubleList));
doubleList.Clear();
doubleList.Add(10);
valList.Add(new ValueAtPoint(doubleList));
FieldValues vals = new FieldValues(valList);
AnalysisResultSchema resultSchema = new AnalysisResultSchema("Schema Name", "Description");
int schemaIndex = sfm.RegisterResult(resultSchema);
sfm.UpdateSpatialFieldPrimitive(idx, pnts, vals, schemaIndex);
SpatialFieldManager Class Members:
Name | Description | Inherited From |
---|---|---|
AllowInteractiveSettings | If true interactive settings dialog and pick deletion are allowed. | |
AssemblyInstanceId | The id of the assembly instance to which the element belongs. (Inherited from Element ) | Element |
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 |
CurrentMeasurement | Stores the currently displayed measurement | |
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 |
IsModifiable | Identifies if the element is modifiable. (Inherited from Element ) | Element |
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 |
LegendPosition | Stores current position of analysis results legend element in view | |
LegendShowConfigurationName | If true legend contains analysis configuration name. | |
LegendShowDescription | If true legend contains analysis description. | |
LegendTextTypeId | Stores element id of text associated with common (result-independent) part of legend in view. | |
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 |
Name | A human readable name for the Element. (Inherited from Element ) | Element |
NumberOfMeasurements | Stores the total number of measurements | |
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 |
ResultsVisibleInView | Enables analysis results visibility in the view. | |
UniqueId | A stable unique identifier for an element within the document. (Inherited from Element ) | Element |
UseRangeForAllMeasurements | Governs how minimum and maximum values (the data range) are calculated. | |
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 |
---|---|---|
AddSpatialFieldPrimitive() | Creates empty analysis results primitive not associated with any geometry element | |
AddSpatialFieldPrimitive(Reference) | Creates an empty analysis results primitive associated with a reference. | |
AddSpatialFieldPrimitive(Curve, Transform) | Creates empty analysis results primitive associated with a curve and a transform. | |
AddSpatialFieldPrimitive(Face, Transform) | Creates empty analysis results primitive associated with a face and a transform. | |
AddSpatialFieldPrimitive(Reference, SpatialFieldPrimitiveHideMode) | Creates an empty analysis results primitive associated with a reference, with the option to control how the reference element is hidden. | |
ArePhasesModifiable | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) | 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 |
ChangeTypeId(ElementId) | Changes the type of the element. (Inherited from Element ) | Element |
Clear | Clear all analysis results managed by this manager object | |
CreateSpatialFieldManager | Factory method - creates manager object for the given view | |
DeleteEntity | Deletes the existing entity created by %schema% in the element (Inherited from Element ) | Element |
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 |
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 |
GetLegend | Returns legend element or NULL | |
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 |
GetMaximum | Calculates the maximum value for all primitives | |
GetMinimum | Calculates the minimum value for all primitives | |
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 |
GetRegisteredResults | Returns an array of indices of all registered results | |
GetResultSchema | Returns result schema by index | |
GetSpatialFieldManager | Retrieves manager object for the given view or returns NULL | |
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 |
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 |
IsResultSchemaNameUnique | Verify the uniqueness of the name among all registered result schemas. | |
IsTextTypeIdValid | Verify if text type id is valid. | |
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 |
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 |
RegisterResult | Registers result and assigns it a unique result index | |
RemoveSpatialFieldPrimitive | Removes analysis results primitive identified by the unique index | |
SetEntity | Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element ) | Element |
SetMeasurementDescriptions | Sets Descriptions for all measurements | |
SetMeasurementNames | Sets Names for all measurements | |
SetResultSchema | Sets a new value for an existing result schema in the result registry | |
ToString | Returns a string that represents the current object. (Inherited from Object ) | Object |
UpdateSpatialFieldPrimitive | Populates analysis results data (or replaces the existing data) in the existing primitive identified by the unique index |