SpatialFieldManager

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

public class SpatialFieldManager : Element

Public Class SpatialFieldManager _
	Inherits Element

public ref class SpatialFieldManager : public Element

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

Dim doc As Document = commandData.Application.ActiveUIDocument.Document
Dim uiDoc As UIDocument = commandData.Application.ActiveUIDocument

Dim sfm As SpatialFieldManager = SpatialFieldManager.GetSpatialFieldManager(doc.ActiveView)
If sfm Is Nothing Then
   sfm = SpatialFieldManager.CreateSpatialFieldManager(doc.ActiveView, 1)
End If
Dim reference As Reference = uiDoc.Selection.PickObject(ObjectType.Face, "Select a face")
Dim idx As Integer = sfm.AddSpatialFieldPrimitive(reference)

Dim face As Face = TryCast(doc.GetElement(reference).GetGeometryObjectFromReference(reference), Face)

Dim uvPts As IList(Of UV) = New List(Of UV)()
Dim bb As BoundingBoxUV = face.GetBoundingBox()
Dim min As UV = bb.Min
Dim max As UV = bb.Max
uvPts.Add(New UV(min.U, min.V))
uvPts.Add(New UV(max.U, max.V))

Dim pnts As New FieldDomainPointsByUV(uvPts)

Dim doubleList As New List(Of Double)()
Dim valList As IList(Of ValueAtPoint) = New List(Of ValueAtPoint)()
doubleList.Add(0)
valList.Add(New ValueAtPoint(doubleList))
doubleList.Clear()
doubleList.Add(10)
valList.Add(New ValueAtPoint(doubleList))

Dim vals As New FieldValues(valList)
Dim resultSchema As New AnalysisResultSchema("Schema Name", "Description")
Dim schemaIndex As Integer = sfm.RegisterResult(resultSchema)
sfm.UpdateSpatialFieldPrimitive(idx, pnts, vals, schemaIndex)

Name	Return Type	Description	Inherited From
M AddSpatialFieldPrimitive()	int	Creates empty analysis results primitive not associated with any geometry element
M AddSpatialFieldPrimitive(Curve, Transform)	int	Creates empty analysis results primitive associated with a curve and a transform.
M AddSpatialFieldPrimitive(Face, Transform)	int	Creates empty analysis results primitive associated with a face and a transform.
M AddSpatialFieldPrimitive(Reference)	int	Creates an empty analysis results primitive associated with a reference.
M AddSpatialFieldPrimitive(Reference, SpatialFieldPrimitiveHideMode)	int	Creates an empty analysis results primitive associated with a reference, with the option to control how the reference element is hidden.
M Clear()	None	Clear all analysis results managed by this manager object
M CreateSpatialFieldManager(View, Int32)	SpatialFieldManager	Factory method - creates manager object for the given view
M GetLegend()	AnalysisDisplayLegend	Returns legend element or NULL
M GetMaximum(Int32, Boolean)	Resulting maximum value	Calculates the maximum value for all primitives
M GetMinimum(Int32, Boolean)	Resulting minimum value	Calculates the minimum value for all primitives
M GetRegisteredResults()	IList<int>	Returns an array of indices of all registered results
M GetResultSchema(Int32)	AnalysisResultSchema	Returns result schema by index
M GetSpatialFieldManager(View)	SpatialFieldManager	Retrieves manager object for the given view or returns NULL
M IsResultSchemaNameUnique(String, Int32)	bool	Verify the uniqueness of the name among all registered result schemas.
M IsTextTypeIdValid(ElementId, Document)	bool	Verify if text type id is valid.
M RegisterResult(AnalysisResultSchema)	int	Registers result and assigns it a unique result index
M RemoveSpatialFieldPrimitive(Int32)	None	Removes analysis results primitive identified by the unique index
M SetMeasurementDescriptions(IList<String>)	None	Sets Descriptions for all measurements
M SetMeasurementNames(IList<String>)	None	Sets Names for all measurements
M SetResultSchema(Int32, AnalysisResultSchema)	None	Sets a new value for an existing result schema in the result registry
M UpdateSpatialFieldPrimitive(Int32, FieldDomainPoints, FieldValues, Int32)	None	Populates analysis results data (or replaces the existing data) in the existing primitive identified by the unique index
M ArePhasesModifiable()	bool	Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.	Element
M CanBeHidden(View)	bool	Indicates if the element can be hidden in the view.	Element
M CanBeLocked()	bool	Identifies if the element can be locked.	Element
M CanDeleteSubelement(Subelement)	bool	Checks if given subelement can be removed from the element.	Element
M CanHaveTypeAssigned()	bool	Identifies if the element can have a type assigned.	Element
M CanHaveTypeAssigned(Document, ICollection<ElementId>)	bool	Checks if all elements in the set can have a type assigned.	Element
M ChangeTypeId(Document, ICollection<ElementId>, ElementId)	IDictionary	Changes the type of all elements in the given set.	Element
M ChangeTypeId(ElementId)	ElementId	Changes the type of the element.	Element
M DeleteEntity(Schema)	bool	Deletes the existing entity created by %schema% in the element	Element
M DeleteSubelement(Subelement)	bool	Removes a subelement from the element.	Element
M DeleteSubelements(IList<Subelement>)	bool	Removes the subelements from the element.	Element
M Dispose()	None	Releases all resources used by the	Element
M EvaluateAllParameterValues()	EvaluatedParameter	Evaluates all the parameters' values of the element.	Element
M EvaluateParameterValues(ISet<ElementId>)	EvaluatedParameter	Evaluate the parameters' values of the element on the given parameter ID set.	Element
M GetChangeTypeAny()	ChangeType	Returns ChangeType associated with any change in an element.	Element
M GetChangeTypeElementAddition()	ChangeType	Returns ChangeType associated with element addition	Element
M GetChangeTypeElementDeletion()	ChangeType	Returns ChangeType associated with element deletion.	Element
M GetChangeTypeGeometry()	ChangeType	Returns ChangeType associated with a change in the geometry of an element	Element
M GetChangeTypeParameter(ElementId)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetChangeTypeParameter(Parameter)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetDependentElements(ElementFilter)	IList<ElementId>	Get all elements that, from a logical point of view, are the children of this Element.	Element
M GetEntity(Schema)	The returned Entity.	Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.	Element
M GetEntitySchemaGuids()	IList<Guid>	Returns the Schema guids of any Entities stored in this element.	Element
M GetExternalFileReference()	ExternalFileReference	Gets information pertaining to the external file referenced by the element.	Element
M GetExternalResourceReferenceExpanded(ExternalResourceType)	IList<ExternalResourceReference>	Gets the collection of ExternalResourceReference associated with a specified external resource type.	Element
M GetExternalResourceReference(ExternalResourceType)	ExternalResourceReference	Gets the ExternalResourceReference associated with a specified external resource type.	Element
M GetExternalResourceReferencesExpanded()	IDictionary	Gets the expanded map of the external resource references referenced by the element.	Element
M GetExternalResourceReferences()	IDictionary	Gets the map of the external resource references referenced by the element.	Element
M GetGeneratingElementIds(GeometryObject)	ICollection<ElementId>	Returns the ids of the element(s) that generated the input geometry object.	Element
M GetGeometryObjectFromReference(Reference)	GeometryObject	Retrieve one geometric primitive contained in the element given a reference.	Element
M GetMaterialArea(ElementId, Boolean)	double	Gets the area of the material with the given id.	Element
M GetMaterialIds(Boolean)	ICollection<ElementId>	Gets the element ids of all materials present in the element.	Element
M GetMaterialVolume(ElementId)	double	Gets the volume of the material with the given id.	Element
M GetMonitoredLinkElementIds()	IList<ElementId>	Provides the link instance IDs when the element is monitoring.	Element
M GetMonitoredLocalElementIds()	IList<ElementId>	Provides the local element IDs when the element is monitoring.	Element
M GetOrderedParameters()	IList<Parameter>	Gets the parameters associated to the element in order.	Element
M GetParameterFormatOptions(ElementId)	FormatOptions	Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.	Element
M GetParameter(ForgeTypeId)	Parameter	Retrieves a parameter from the element given identifier.	Element
M GetParameters(String)	IList<Parameter>	Retrieves the parameters from the element via the given name.	Element
M GetPhaseStatus(ElementId)	ElementOnPhaseStatus	Gets the status of a given element in the input phase	Element
M GetSubelements()	IList<Subelement>	Returns the collection of element subelements.	Element
M GetTypeId()	ElementId	Returns the identifier of this element's type.	Element
M GetValidTypes()	ICollection<ElementId>	Obtains a set of types that are valid for this element.	Element
M GetValidTypes(Document, ICollection<ElementId>)	ICollection<ElementId>	Obtains a set of types that are valid for all given elements.	Element
M HasPhases()	bool	Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.	Element
M IsCreatedPhaseOrderValid(ElementId)	bool	Returns true if createdPhaseId and demolishedPhaseId are in order.	Element
M IsDemolishedPhaseOrderValid(ElementId)	bool	Returns true if createdPhaseId and demolishedPhaseId are in order.	Element
M IsExternalFileReference()	bool	Determines whether this Element represents an external file.	Element
M IsHidden(View)	bool	Identifies if the element has been permanently hidden in the view.	Element
M IsMonitoringLinkElement()	bool	Indicate whether an element is monitoring any elements in any linked models.	Element
M IsMonitoringLocalElement()	bool	Indicate whether an element is monitoring other local elements.	Element
M IsPhaseCreatedValid(ElementId)	bool	Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.	Element
M IsPhaseDemolishedValid(ElementId)	bool	Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.	Element
M IsValidType(Document, ICollection<ElementId>, ElementId)	bool	Checks if given type is valid for the set of elements.	Element
M IsValidType(ElementId)	bool	Checks if given type is valid for this element.	Element
M LookupParameter(String)	nullNothingnullptr	Attempts to find a parameter on the element which has the given name.	Element
M RefersToExternalResourceReference(ExternalResourceType)	bool	Determines whether this Element uses external resources associated with a specified external resource type.	Element
M RefersToExternalResourceReferences()	bool	Determines whether this Element uses external resources.	Element
M SetEntity(Entity)	None	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.	Element

Name	Return Type	Description	Inherited From
P AllowInteractiveSettings	bool	If true interactive settings dialog and pick deletion are allowed.
P CurrentMeasurement	int	Stores the currently displayed measurement
P LegendPosition	XYZ	Stores current position of analysis results legend element in view
P LegendShowConfigurationName	bool	If true legend contains analysis configuration name.
P LegendShowDescription	bool	If true legend contains analysis description.
P LegendTextTypeId	ElementId	Stores element id of text associated with common (result-independent) part of legend in view.
P NumberOfMeasurements	int	Stores the total number of measurements
P ResultsVisibleInView	bool	Enables analysis results visibility in the view.
P UseRangeForAllMeasurements	bool	Governs how minimum and maximum values (the data range) are calculated.
P AssemblyInstanceId	ElementId	The id of the assembly instance to which the element belongs.	Element
P BoundingBox	BoundingBoxXYZ	Retrieves a box that circumscribes all geometry of the element.	Element
P Category	Category	Retrieves a Category object that represents the category or sub category in which the element resides.	Element
P CreatedPhaseId	ElementId	Id of a Phase at which the Element was created.	Element
P DemolishedPhaseId	ElementId	Id of a Phase at which the Element was demolished.	Element
P DesignOption	DesignOption	Returns the design option to which the element belongs.	Element
P Document	Document	Returns the Document in which the Element resides.	Element
P Geometry	GeometryElement	Retrieves the geometric representation of the element.	Element
P GroupId	ElementId	The id of the group to which an element belongs.	Element
P Id	ElementId	A unique identifier for an Element in an Autodesk Revit project.	Element
P IsModifiable	bool	Identifies if the element is modifiable.	Element
P IsTransient	bool	Indicates whether an element is transient or permanent.	Element
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.	Element
P LevelId	ElementId	The id of the level associated with the element.	Element
P Location	Location	This property is used to find the physical location of an element within a project.	Element
P Name	string	A human readable name for the Element.	Element
P OwnerViewId	ElementId	The id of the view that owns the element.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a parameter id.	Element
P Parameter	Parameter	Retrieves a parameter from the element based on its definition.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a GUID for a shared parameter.	Element
P ParametersMap	ParameterMap	Retrieves a map containing all of the parameters that are contained within the element.	Element
P Parameters	ParameterSet	Retrieves a set containing all of the parameters that are contained within the element.	Element
P Pinned	bool	Identifies if the element has been pinned to prevent changes.	Element
P UniqueId	string	A stable unique identifier for an element within the document.	Element
P VersionGuid	Guid	Get the element version Guid.	Element
P ViewSpecific	bool	Identifies if the element is owned by a view.	Element
P WorksetId	WorksetId	Get Id of the Workset which owns the element.	Element