Document Methods |
The Document type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CreateVisual(String) | Create a visual given a visual factory name. This can be a type such as "BoxVisual" or a name of a catalog component loaded into the current application. |
| CreateVisual(VisualFactory) | Create a visual given a visual factory. This is mostly used to create specific visuals from catalogs. |
| CreateVisual(XmlDocument) | Create a single visual from an XmlDocument. |
| CreateVisualT | Create a new visual of a given type such as BoxVisual. |
| CreateVisualFromSerialized | Create a single visual from a serialized version of the visual. |
| CreateVisuals | Create all visuals from an XML Document. |
| DestroyVisual | Delete this visual and remove it from the document. |
| Error | Log an error message. |
| ExportFrictionMatrix(String) | |
 | ExportFrictionMatrix(FrictionConfiguration, String) | |
| FindAnyVisual | Find Visual by name, return one of them if there are multiple visuals, but do not warn if there are more than one. |
| FindCreateVisual | Attempt to find a child of the parent visual with the specified name. If it fails to find one, create one instead. |
| FindLayer | Find a layer by name. |
| FindType(Type) | Enumerate all visuals of a specified type. |
| FindType(Type, Boolean) | Enumerate all visuals of a specified type. |
| FindTypeT | Enumerate all visuals of a specified type. |
 | FindUserResource(String) | Gets the UserResource instance with the specified path within this document's user resources. |
| FindUserResource(UserResourceReference) | Gets the UserResource instance with the specified UserResourceReference within this document's user resources. |
| FindVisualByName | Find the first visual in the document scene with a given name. |
| FindVisualsByName | Find all the visuals in the document scene with a given name. |
| GetLayer | Find or create a layer by name. |
| GetPackageManager | |
| ImportFrictionMatrix | |
| ImportTags | Load tag definitions and server configurations from disk. The path used is TagImporterFileName (equivalent to TagImporterProperties.FileName). |
| Info | Log an info message. |
| LogEvent | Output event diagnostics to the current EventLogPath if not null. |
| Look(Vector3, Vector3) | Find the first visual from a location and in a direction. |
| Look(Vector3, Vector3, DocumentLookOptions) | Find the first visual from a location and in a direction with given DocumentLookOptions. |
| LookDown(Vector3) | Find the first visual below the lookFrom world location. |
| LookDown(Visual) | Find the first visual below the lookFrom visual. |
| LookDown(Vector3, DocumentLookOptions) | Find the first visual below the lookFrom world location with the given DocumentLookOptions. |
| LookDown(Visual, DocumentLookOptions) | Find the first visual below the lookFrom visual with the given DocumentLookOptions. |
| PurgeLayers | Remove all unused layers from the document. |
| PurgePortsProperties | Reset legacy "Ports" property for all visuals. |
| PurgeScripts | Remove all unused scripts from the document. |
| Run(Action) | Schedule an action to be called in the current time-step. |
| Run(FuncIEnumerable) | Schedule a coroutine to be called in the current time-step. |
| Run(Delegate, Object) | Schedule a delegate to be called with given arguments in the current time-step. |
| Run(Double, Action) | Schedule an action to be called after a delay in simulation time. |
| Run(Double, FuncIEnumerable) | Schedule a coroutine to be called after a delay in simulation time. |
| Run(Double, Delegate, Object) | Schedule a delegate to be called with given arguments after a delay in simulation time. |
| RunT(FuncT, IEnumerable, T) | Schedule a coroutine to be called in the current time-step. |
| RunT(Double, FuncT, IEnumerable, T) | Schedule a coroutine to be called after a delay in simulation time. |
| RunT1, T2(FuncT1, T2, IEnumerable, T1, T2) | Schedule a coroutine to be called in the current time-step. |
| RunT1, T2(Double, FuncT1, T2, IEnumerable, T1, T2) | Schedule a coroutine to be called after a delay in simulation time. |
| RunT1, T2, T3(FuncT1, T2, T3, IEnumerable, T1, T2, T3) | Schedule a coroutine to be called in the current time-step. |
| RunT1, T2, T3(Double, FuncT1, T2, T3, IEnumerable, T1, T2, T3) | Schedule a coroutine to be called after a delay in simulation time. |
| RunT1, T2, T3, T4(FuncT1, T2, T3, T4, IEnumerable, T1, T2, T3, T4) | Schedule a coroutine to be called in the current time-step. |
| RunT1, T2, T3, T4(Double, FuncT1, T2, T3, T4, IEnumerable, T1, T2, T3, T4) | Schedule a coroutine to be called after a delay in simulation time. |
| Save | Save the current document to disk with a thumbnail based on the Default view. |
| Save(Image) | Save the current document to disk with a custom thumbnail. |
| Start | Schedule a coroutine to be called in the current time-step. |
| UpdateCAD | Check if imported CAD has changed and re-import. |
| Warning | Log a warning message. |
Extension Methods| Name | Description | |
|---|---|---|
 | RunAsync | (Defined by ModelInvokeExtensions) |
| RunAsync | (Defined by ModelInvokeExtensions) |
| RunAsync | (Defined by ModelInvokeExtensions) |
| RunAsync | (Defined by ModelInvokeExtensions) |
| RunAsyncTResult | (Defined by ModelInvokeExtensions) |
| RunAsyncTResult | (Defined by ModelInvokeExtensions) |
| RunAsyncTResult | (Defined by ModelInvokeExtensions) |
| RunAsyncTResult | (Defined by ModelInvokeExtensions) |
See Also